A text object intended for scripts that want to tell a story. More...

#include <text_object.hpp>

Inheritance diagram for TextObject:

Collaboration diagram for TextObject:

Public Member Functions
	TextObject (const std::string &name="")

virtual std::string	get_class_name () const override

virtual std::string	get_exposed_class_name () const override

virtual std::string	get_display_name () const override
	Returns the display name of the object, translated to the user's locale.

virtual GameObjectClasses	get_class_types () const override
	List notable classes in inheritance hierarchy of class. More...

virtual const std::string	get_icon_path () const override

virtual void	draw (DrawingContext &context) override
	The GameObject should draw itself onto the provided DrawingContext if this function is called. More...

virtual void	update (float dt_sec) override
	This function is called once per frame and allows the object to update it's state. More...

virtual bool	is_saveable () const override
	Indicates if the object will be saved. More...

void	set_text (const std::string &text)
	Sets the text string to be displayed. More...

void	set_font (const std::string &fontname)
	Sets the font of the text to be displayed. More...

void	fade_in (float fadetime)
	Fades in the specified text for the next ""fadetime"" seconds. More...

void	fade_out (float fadetime)
	Fades out the specified text for the next ""fadetime"" seconds. More...

void	grow_in (float fadetime)
	Grows in the specified text for the next ""fadetime"" seconds. More...

void	grow_out (float fadetime)
	Grows out the specified text for the next ""fadetime"" seconds. More...

void	set_visible (bool visible)

void	set_centered (bool centered)

void	set_pos (float x, float y)
	Sets the offset of the text, relative to the anchor point. More...

float	get_x () const
	Returns the X offset of the text, relative to the anchor point.

float	get_y () const
	Returns the Y offset of the text, relative to the anchor point.

void	set_anchor_point (int anchor)
	Sets the anchor point of the text. More...

int	get_anchor_point () const
	Returns the current anchor point of the text (one of the ""ANCHOR_*"" constants; see ${SRG_REF_AnchorPoints}).

void	set_anchor_offset (float x, float y)
	Sets the anchor offset of the text. More...

float	get_wrap_width () const

void	set_wrap_width (float width)

void	set_front_fill_color (float red, float green, float blue, float alpha)
	Sets the front fill color of the text. More...

void	set_back_fill_color (float red, float green, float blue, float alpha)
	Sets the back fill color of the text. More...

void	set_text_color (float red, float green, float blue, float alpha)
	Sets the text color. More...

void	set_roundness (float roundness)

void	set_anchor_point (AnchorPoint anchor)

void	set_anchor_offset (const Vector &offset)

void	set_pos (const Vector &pos)

const Vector &	get_pos () const

Public Member Functions inherited from GameObject
	GameObject (const std::string &name)

	GameObject (const ReaderMapping &reader)

virtual void	finish_construction ()
	Called after all objects have been added to the Sector and the Sector is fully constructed. More...

UID	get_uid () const

virtual void	save (Writer &writer)
	This function saves the object. More...

std::string	save ()

virtual std::vector< std::string >	get_patches () const
	Version checking/updating, patch information.

virtual void	update_version ()

int	get_version () const
	Returns the current version of the object.

int	get_latest_version () const
	Returns the latest version of the object.

bool	is_up_to_date () const
	Checks whether the object's current version is equal to its latest one.

virtual bool	is_singleton () const
	If true only a single object of this type is allowed in a given GameObjectManager.

virtual bool	has_variable_size () const
	Does this object have variable size (secret area trigger, wind, etc.)

virtual bool	track_state () const
	Indicates if the object's state should be tracked. More...

virtual bool	has_object_manager_priority () const
	Indicates if the object should be added at the beginning of the object list. More...

virtual bool	has_settings () const
	Indicates if get_settings() is implemented. More...

virtual ObjectSettings	get_settings ()

virtual GameObjectTypes	get_types () const
	Get all types of the object, if available. More...

int	get_type () const
	Returns the type index of the object.

virtual void	after_editor_set ()

virtual void	on_flip (float height)
	When level is flipped vertically.

virtual void	remove_me ()
	schedules this object to be removed at the end of the frame

bool	is_valid () const
	returns true if the object is not scheduled to be removed yet

void	add_remove_listener (ObjectRemoveListener *listener)
	registers a remove listener which will be called if the object gets removed/destroyed

void	del_remove_listener (ObjectRemoveListener *listener)
	unregisters a remove listener, so it will no longer be called if the object gets removed/destroyed

void	set_name (const std::string &name)

const std::string &	get_name () const
	Returns the name of the object.

virtual void	stop_looping_sounds ()
	stops all looping sounds

virtual void	play_looping_sounds ()
	continues all looping sounds

template<typename T >
T *	get_component ()

void	add_component (std::unique_ptr< GameObjectComponent > component)

void	remove_component (GameObjectComponent *component)

virtual void	save_state ()
	Save/check the current state of the object. More...

virtual void	check_state ()

virtual void	editor_delete ()
	The editor requested the deletion of the object.

virtual void	editor_select ()
	The user clicked on the object in the editor and selected it.

virtual void	editor_deselect ()
	The object got deselected.

virtual void	editor_update ()
	Called each frame in the editor, used to keep linked objects together (e.g. More...

GameObjectManager *	get_parent () const

Static Public Member Functions
static void	register_class (ssq::VM &vm)

static std::string	class_name ()

static std::string	display_name ()

Static Public Member Functions inherited from GameObject
static void	register_class (ssq::VM &vm)

Additional Inherited Members
Protected Types inherited from GameObject
enum	TypeChange { INITIAL = -1 }
	When the type has been changed from the editor. More...

Protected Member Functions inherited from GameObject
void	parse_type (const ReaderMapping &reader)
	Parse object type. More...

virtual void	on_type_change (int old_type)

int	type_id_to_value (const std::string &id) const
	Conversion between type ID and value. More...

std::string	type_value_to_id (int value) const

Protected Attributes inherited from GameObject
std::string	m_name
	a name for the gameobject, this is mostly a hint for scripts and for debugging, don't rely on names being set or being unique

int	m_type
	Type of the GameObject. More...

std::vector< std::unique_ptr< FadeHelper > >	m_fade_helpers
	Fade Helpers are for easing/fading script functions.

bool	m_track_undo
	Track the following creation/deletion of this object for undo. More...

Detailed Description

A text object intended for scripts that want to tell a story.

A ""TextObject"" that was given a name can be controlled by scripts. A ""TextObject"" is instantiated by placing a definition inside a level. It can then be accessed by its name from a script or via ""sector.name"" from the console.

Member Function Documentation

◆ draw()

void TextObject::draw ( DrawingContext & context )

overridevirtual

The GameObject should draw itself onto the provided DrawingContext if this function is called.

Implements GameObject.

◆ fade_in()

void TextObject::fade_in ( float fadetime )

Fades in the specified text for the next ""fadetime"" seconds.

Parameters

float $fadetime

◆ fade_out()

void TextObject::fade_out ( float fadetime )

Fades out the specified text for the next ""fadetime"" seconds.

Parameters

float $fadetime

◆ get_class_types()

virtual GameObjectClasses TextObject::get_class_types ( ) const

inlineoverridevirtual

List notable classes in inheritance hierarchy of class.

This makes it possible to efficiently look up all objects deriving from a particular intermediate class

Reimplemented from GameObject.

◆ get_wrap_width()

float TextObject::get_wrap_width ( ) const

Deprecated:: Use the ""wrap_width"" property instead! (Does not apply for usage from a ""TextArray"".) Gets the text wrap width of the text.

◆ grow_in()

void TextObject::grow_in ( float fadetime )

Grows in the specified text for the next ""fadetime"" seconds.

Parameters

float $fadetime

◆ grow_out()

void TextObject::grow_out ( float fadetime )

Grows out the specified text for the next ""fadetime"" seconds.

Parameters

float $fadetime

◆ is_saveable()

virtual bool TextObject::is_saveable ( ) const

inlineoverridevirtual

Indicates if the object will be saved.

If false, the object will be skipped on saving and can't be cloned in the editor.

Reimplemented from GameObject.

◆ set_anchor_offset()

void TextObject::set_anchor_offset	(	float	x,
		float	y
	)

Sets the anchor offset of the text.

Parameters

float	$x
float	$y

◆ set_anchor_point()

void TextObject::set_anchor_point ( int anchor )

Sets the anchor point of the text.

Parameters

int $anchor One of the ""ANCHOR_*"" constants (see ${SRG_REF_AnchorPoints}).

◆ set_back_fill_color()

void TextObject::set_back_fill_color	(	float	red,
		float	green,
		float	blue,
		float	alpha
	)

Sets the back fill color of the text.

Parameters

float	$red
float	$green
float	$blue
float	$alpha

◆ set_centered()

void TextObject::set_centered ( bool centered )

Deprecated:: Use the ""centered"" property instead! (Does not apply for usage from a ""TextArray"".) If ""centered"" is ""true"", the text will be centered on the screen.

Otherwise, it will be left-aligned.

Parameters

bool $centered

◆ set_font()

void TextObject::set_font ( const std::string & fontname )

Sets the font of the text to be displayed.

Parameters

string $fontname Valid values are normal, big and small.

◆ set_front_fill_color()

void TextObject::set_front_fill_color	(	float	red,
		float	green,
		float	blue,
		float	alpha
	)

Sets the front fill color of the text.

Parameters

float	$red
float	$green
float	$blue
float	$alpha

◆ set_pos()

void TextObject::set_pos	(	float	x,
		float	y
	)

Sets the offset of the text, relative to the anchor point.

Parameters

float	$x
float	$y

◆ set_roundness()

void TextObject::set_roundness ( float roundness )

Deprecated:: Use the ""roundness"" property instead! (Does not apply for usage from a ""TextArray"".) Sets the frame's roundness.

Parameters

float $roundness

◆ set_text()

void TextObject::set_text ( const std::string & text )

Sets the text string to be displayed.

Parameters

string $text

◆ set_text_color()

void TextObject::set_text_color	(	float	red,
		float	green,
		float	blue,
		float	alpha
	)

Sets the text color.

Parameters

float	$red
float	$green
float	$blue
float	$alpha

◆ set_visible()

void TextObject::set_visible ( bool visible )

Deprecated:: Use the ""visible"" property instead! (Does not apply for usage from a ""TextArray"".) Shows or hides the text abruptly (drastic counterpart to ""fade_in()"" and ""fade_out()"").

Parameters

bool $visible

◆ set_wrap_width()

void TextObject::set_wrap_width ( float width )

Deprecated:: Use the ""wrap_width"" property instead! (Does not apply for usage from a ""TextArray"".) Sets the text wrap width of the text.

Parameters

float $width

◆ update()

void TextObject::update ( float dt_sec )

overridevirtual

This function is called once per frame and allows the object to update it's state.

The dt_sec is the time that has passed since the last frame in seconds and should be the base for all timed calculations (don't use SDL_GetTicks directly as this will fail in pause mode). This function is not called in the Editor.

Implements GameObject.

The documentation for this class was generated from the following files:

src/object/text_object.hpp
src/object/text_object.cpp
src/supertux/colorscheme.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ draw()

◆ fade_in()

◆ fade_out()

◆ get_class_types()

◆ get_wrap_width()

◆ grow_in()

◆ grow_out()

◆ is_saveable()

◆ set_anchor_offset()

◆ set_anchor_point()

◆ set_back_fill_color()

◆ set_centered()

◆ set_font()

◆ set_front_fill_color()

◆ set_pos()

◆ set_roundness()

◆ set_text()

◆ set_text_color()

◆ set_visible()

◆ set_wrap_width()

◆ update()