supertux
Public Member Functions | Static Public Member Functions | Friends | List of all members
CustomParticleSystemFile Class Referencefinal
Inheritance diagram for CustomParticleSystemFile:
Inheritance graph
[legend]
Collaboration diagram for CustomParticleSystemFile:
Collaboration graph
[legend]

Public Member Functions

 CustomParticleSystemFile (const ReaderMapping &reader)
 
virtual std::string get_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 ObjectSettings get_settings () override
 
virtual const std::string get_icon_path () const override
 
- Public Member Functions inherited from CustomParticleSystem
 CustomParticleSystem (const ReaderMapping &reader)
 
virtual void draw (DrawingContext &context) override
 The GameObject should draw itself onto the provided DrawingContext if this function is called. More...
 
void reinit_textures ()
 
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 std::string get_exposed_class_name () const override
 
virtual void save (Writer &writer) override
 This function saves the object. More...
 
void ease_value (float *value, float target, float time, easing func)
 
void clear ()
 Instantly removes all particles of that type on the screen.
 
void spawn_particles (int amount, bool instantly)
 Spawns particles, regardless of whether or not particles are enabled. More...
 
int get_max_amount () const
 
void set_max_amount (int amount)
 
std::string get_birth_mode () const
 Returns "None", "Fade", "Shrink".
 
void set_birth_mode (const std::string &mode)
 
std::string get_death_mode () const
 Returns "None", "Fade", "Shrink".
 
void set_death_mode (const std::string &mode)
 
std::string get_rotation_mode () const
 Returns "Fixed", "Facing", "Wiggling".
 
void set_rotation_mode (const std::string &mode)
 
std::string get_collision_mode () const
 Returns "Ignore", "Stick", "StickForever", "BounceHeavy", "BounceLight", "Destroy".
 
void set_collision_mode (const std::string &mode)
 
std::string get_offscreen_mode () const
 Returns "Never", "OnlyOnExit", "Always".
 
void set_offscreen_mode (const std::string &mode)
 
bool get_cover_screen () const
 
void set_cover_screen (bool cover)
 
float get_delay () const
 
void set_delay (float delay)
 
void fade_delay (float delay, float time)
 
void ease_delay (float delay, float time, const std::string &easing)
 
float get_lifetime () const
 
void set_lifetime (float lifetime)
 
void fade_lifetime (float lifetime, float time)
 
void ease_lifetime (float lifetime, float time, const std::string &easing)
 
float get_lifetime_variation () const
 
void set_lifetime_variation (float lifetime_variation)
 
void fade_lifetime_variation (float lifetime_variation, float time)
 
void ease_lifetime_variation (float lifetime_variation, float time, const std::string &easing)
 
float get_birth_time () const
 
void set_birth_time (float birth_time)
 
void fade_birth_time (float birth_time, float time)
 
void ease_birth_time (float birth_time, float time, const std::string &easing)
 
float get_birth_time_variation () const
 
void set_birth_time_variation (float birth_time_variation)
 
void fade_birth_time_variation (float birth_time_variation, float time)
 
void ease_birth_time_variation (float birth_time_variation, float time, const std::string &easing)
 
float get_death_time () const
 
void set_death_time (float death_time)
 
void fade_death_time (float death_time, float time)
 
void ease_death_time (float death_time, float time, const std::string &easing)
 
float get_death_time_variation () const
 
void set_death_time_variation (float death_time_variation)
 
void fade_death_time_variation (float death_time_variation, float time)
 
void ease_death_time_variation (float death_time_variation, float time, const std::string &easing)
 
float get_speed_x () const
 
void set_speed_x (float speed_x)
 
void fade_speed_x (float speed_x, float time)
 
void ease_speed_x (float speed_x, float time, const std::string &easing)
 
float get_speed_y () const
 
void set_speed_y (float speed_y)
 
void fade_speed_y (float speed_y, float time)
 
void ease_speed_y (float speed_y, float time, const std::string &easing)
 
float get_speed_variation_x () const
 
void set_speed_variation_x (float speed_variation_x)
 
void fade_speed_variation_x (float speed_variation_x, float time)
 
void ease_speed_variation_x (float speed_variation_x, float time, const std::string &easing)
 
float get_speed_variation_y () const
 
void set_speed_variation_y (float speed_variation_y)
 
void fade_speed_variation_y (float speed_variation_y, float time)
 
void ease_speed_variation_y (float speed_variation_y, float time, const std::string &easing)
 
float get_acceleration_x () const
 
void set_acceleration_x (float acceleration_x)
 
void fade_acceleration_x (float acceleration_x, float time)
 
void ease_acceleration_x (float acceleration_x, float time, const std::string &easing)
 
float get_acceleration_y () const
 
void set_acceleration_y (float acceleration_y)
 
void fade_acceleration_y (float acceleration_y, float time)
 
void ease_acceleration_y (float acceleration_y, float time, const std::string &easing)
 
float get_friction_x () const
 
void set_friction_x (float friction_x)
 
void fade_friction_x (float friction_x, float time)
 
void ease_friction_x (float friction_x, float time, const std::string &easing)
 
float get_friction_y () const
 
void set_friction_y (float friction_y)
 
void fade_friction_y (float friction_y, float time)
 
void ease_friction_y (float friction_y, float time, const std::string &easing)
 
float get_feather_factor () const
 
void set_feather_factor (float feather_factor)
 
void fade_feather_factor (float feather_factor, float time)
 
void ease_feather_factor (float feather_factor, float time, const std::string &easing)
 
float get_rotation () const
 
void set_rotation (float rotation)
 
void fade_rotation (float rotation, float time)
 
void ease_rotation (float rotation, float time, const std::string &easing)
 
float get_rotation_variation () const
 
void set_rotation_variation (float rotation_variation)
 
void fade_rotation_variation (float rotation_variation, float time)
 
void ease_rotation_variation (float rotation_variation, float time, const std::string &easing)
 
float get_rotation_speed () const
 
void set_rotation_speed (float rotation_speed)
 
void fade_rotation_speed (float rotation_speed, float time)
 
void ease_rotation_speed (float rotation_speed, float time, const std::string &easing)
 
float get_rotation_speed_variation () const
 
void set_rotation_speed_variation (float rotation_speed_variation)
 
void fade_rotation_speed_variation (float rotation_speed_variation, float time)
 
void ease_rotation_speed_variation (float rotation_speed_variation, float time, const std::string &easing)
 
float get_rotation_acceleration () const
 
void set_rotation_acceleration (float rotation_acceleration)
 
void fade_rotation_acceleration (float rotation_acceleration, float time)
 
void ease_rotation_acceleration (float rotation_acceleration, float time, const std::string &easing)
 
float get_rotation_decceleration () const
 
void set_rotation_decceleration (float rotation_decceleration)
 
void fade_rotation_decceleration (float rotation_decceleration, float time)
 
void ease_rotation_decceleration (float rotation_decceleration, float time, const std::string &easing)
 
std::unique_ptr< ParticlePropsget_props () const
 
void set_props (ParticleProps *props)
 
- Public Member Functions inherited from ParticleSystem_Interactive
 ParticleSystem_Interactive (const ReaderMapping &mapping)
 
- Public Member Functions inherited from ParticleSystem
 ParticleSystem (const ReaderMapping &reader, float max_particle_size=60)
 
 ParticleSystem (float max_particle_size=60)
 
void set_enabled (bool enable)
 
bool get_enabled () const
 
int get_layer () 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
 
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 is_saveable () const
 Indicates if the object will be saved. More...
 
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 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...
 
GameObjectManagerget_parent () const
 

Static Public Member Functions

static std::string class_name ()
 
static std::string display_name ()
 
- Static Public Member Functions inherited from CustomParticleSystem
static void register_class (ssq::VM &vm)
 
static std::string class_name ()
 
static std::string display_name ()
 
- Static Public Member Functions inherited from ParticleSystem
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)
 

Friends

class ParticleEditor
 

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 CustomParticleSystem
virtual int collision (Particle *particle, const Vector &movement) override
 
CollisionHit get_collision (Particle *particle, const Vector &movement)
 
- 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 ParticleSystem
float max_particle_size
 
int z_pos
 
std::vector< std::unique_ptr< Particle > > particles
 
float virtual_width
 
float virtual_height
 
bool enabled
 Determines whether the system is enabled.
 
- 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...
 

Member Function Documentation

◆ get_class_types()

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


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