A ""Gradient"" that was given a name can be controlled by scripts. More...

#include <gradient.hpp>

Inheritance diagram for Gradient:

Collaboration diagram for Gradient:

Public Member Functions
	Gradient (const ReaderMapping &reader)

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 void	draw (DrawingContext &context) override
	The GameObject should draw itself onto the provided DrawingContext if this function is called. More...

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

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 ObjectSettings	get_settings () override

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

void	set_gradient (const Color &top, const Color &bottom)

void	fade_gradient (const Color &top, const Color &bottom, float time)

Color	get_gradient_top () const

Color	get_gradient_bottom () const

GradientDirection	get_direction () const

std::string	get_direction_string () const

void	set_direction (const GradientDirection &direction)

void	set_layer (int layer)

int	get_layer () const

void	set_direction (const std::string &direction)
	Sets the direction of the gradient. More...

void	set_color1 (float red, float green, float blue)
	Set top gradient color. More...

void	set_color2 (float red, float green, float blue)
	Set bottom gradient color. More...

void	set_colors (float red1, float green1, float blue1, float red2, float green2, float blue2)
	Set both gradient colors. More...

void	fade_color1 (float red, float green, float blue, float time)
	Fade the top gradient color to a specified new color in ""time"" seconds. More...

void	fade_color2 (float red, float green, float blue, float time)
	Fade the bottom gradient color to a specified new color in ""time"" seconds. More...

void	fade_colors (float red1, float green1, float blue1, float red2, float green2, float blue2, float time)
	Fade both gradient colors to specified new colors in ""time"" seconds. More...

void	swap_colors ()
	Swap top and bottom gradient colors.

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 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	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 ""Gradient"" that was given a name can be controlled by scripts.

A ""Gradient"" 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 Gradient::draw ( DrawingContext & context )

overridevirtual

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

Implements GameObject.

◆ fade_color1()

void Gradient::fade_color1	(	float	red,
		float	green,
		float	blue,
		float	time
	)

Fade the top gradient color to a specified new color in ""time"" seconds.

Parameters

float	$red
float	$green
float	$blue
float	$time

◆ fade_color2()

void Gradient::fade_color2	(	float	red,
		float	green,
		float	blue,
		float	time
	)

Fade the bottom gradient color to a specified new color in ""time"" seconds.

Parameters

float	$red
float	$green
float	$blue
float	$time

◆ fade_colors()

void Gradient::fade_colors	(	float	red1,
		float	green1,
		float	blue1,
		float	red2,
		float	green2,
		float	blue2,
		float	time
	)

Fade both gradient colors to specified new colors in ""time"" seconds.

Parameters

float	$red1
float	$green1
float	$blue1
float	$red2
float	$green2
float	$blue2
float	$time

◆ get_class_types()

virtual GameObjectClasses Gradient::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.

◆ is_saveable()

bool Gradient::is_saveable ( ) const

overridevirtual

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_color1()

void Gradient::set_color1	(	float	red,
		float	green,
		float	blue
	)

Set top gradient color.

Parameters

float	$red
float	$green
float	$blue

◆ set_color2()

void Gradient::set_color2	(	float	red,
		float	green,
		float	blue
	)

Set bottom gradient color.

Parameters

float	$red
float	$green
float	$blue

◆ set_colors()

void Gradient::set_colors	(	float	red1,
		float	green1,
		float	blue1,
		float	red2,
		float	green2,
		float	blue2
	)

Set both gradient colors.

Parameters

float	$red1
float	$green1
float	$blue1
float	$red2
float	$green2
float	$blue2

◆ set_direction()

void Gradient::set_direction ( const std::string & direction )

Sets the direction of the gradient.

Parameters

string $direction Can be "horizontal", "vertical", "horizontal_sector" or "vertical_sector".

◆ update()

void Gradient::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/gradient.hpp
src/object/gradient.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ draw()

◆ fade_color1()

◆ fade_color2()

◆ fade_colors()

◆ get_class_types()

◆ is_saveable()

◆ set_color1()

◆ set_color2()

◆ set_colors()

◆ set_direction()

◆ update()