supertux
Public Member Functions | List of all members
ScriptTrigger Class Referencefinal
Inheritance diagram for ScriptTrigger:
TriggerBase MovingObject ObjectRemoveListener GameObject CollisionListener

Public Member Functions

 ScriptTrigger (const ReaderMapping &reader)
 
 ScriptTrigger (const Vector &pos, const std::string &script)
 
virtual std::string get_class () const override
 
virtual bool has_variable_size () const override
 Does this object have variable size (secret area trigger, wind, etc.)
 
virtual ObjectSettings get_settings () override
 
virtual void after_editor_set () override
 
virtual void event (Player &player, EventType type) override
 Receive trigger events.
 
virtual void draw (DrawingContext &context) override
 The GameObject should draw itself onto the provided DrawingContext if this function is called. More...
 
void write (Writer &writer)
 
- Public Member Functions inherited from TriggerBase
 TriggerBase (const ReaderMapping &mapping)
 
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 HitResponse collision (GameObject &other, const CollisionHit &hit) override
 this function is called when the object collided with any other object
 
virtual void object_removed (GameObject *object) override
 Called by GameObject destructor of an object in losetouch_listeners.
 
- Public Member Functions inherited from MovingObject
 MovingObject (const ReaderMapping &reader)
 
virtual void collision_solid (const CollisionHit &) override
 this function is called when the object collided with something solid
 
virtual bool collides (GameObject &, const CollisionHit &) const override
 when 2 objects collided, we will first call the pre_collision_check functions of both objects that can decide on how to react to the collision. More...
 
virtual void collision_tile (uint32_t) override
 called when tiles with special attributes have been touched
 
virtual void set_pos (const Vector &pos)
 
virtual void move_to (const Vector &pos)
 
virtual bool listener_is_valid () const override
 
Vector get_pos () const
 
const Rectfget_bbox () const
 
const Vectorget_movement () const
 
CollisionGroup get_group () const
 
CollisionObjectget_collision_object ()
 
const CollisionObjectget_collision_object () const
 
virtual void editor_select () override
 The user clicked on the object in the editor and selected it.
 
- 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
 
void save (Writer &writer)
 This function saves the object. More...
 
virtual std::string get_display_name () const
 
virtual bool is_singleton () const
 If true only a single object of this type is allowed in a given GameObjectManager.
 
virtual bool is_saveable () const
 Indicates if the object will be saved. More...
 
virtual bool has_settings () const
 Indicates if get_settings() is implemented. More...
 
bool is_valid () const
 returns true if the object is not scheduled to be removed yet
 
void remove_me ()
 schedules this object to be removed at the end of the frame
 
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
 
virtual const std::string get_icon_path () const
 
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 editor_delete ()
 The editor requested the deletion of the object.
 
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...
 

Additional Inherited Members

- Public Types inherited from TriggerBase
enum  EventType { EVENT_TOUCH, EVENT_LOSETOUCH, EVENT_ACTIVATE }
 
- Protected Member Functions inherited from MovingObject
void set_group (CollisionGroup group)
 
- Protected Attributes inherited from MovingObject
CollisionObject m_col
 
- 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
 

Member Function Documentation

§ draw()

void ScriptTrigger::draw ( DrawingContext context)
overridevirtual

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

Reimplemented from TriggerBase.


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