Light source that changes alpha value to give the impression of a pulsating light. More...
#include <pulsing_light.hpp>
Inheritance diagram for PulsingLight:
Public Member Functions | |
| PulsingLight (const Vector ¢er, float cycle_len=5.0, float min_alpha=0.0, float max_alpha=1.0, const Color &color=Color(1.0, 1.0, 1.0, 1.0)) | |
| 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... | |
 Public Member Functions inherited from Light | |
| Light (const Vector ¢er, const Color &color=Color(1.0, 1.0, 1.0, 1.0)) | |
| virtual bool | is_saveable () const override |
| Indicates if the object will be saved. More... | |
| 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_class () const |
| 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 | has_variable_size () const |
| Does this object have variable size (secret area trigger, wind, etc.) | |
| virtual bool | has_settings () const |
| Indicates if get_settings() is implemented. More... | |
| virtual ObjectSettings | get_settings () |
| virtual void | after_editor_set () |
| 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_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... | |
Protected Attributes | |
| float | min_alpha |
| minimum alpha | |
| float | max_alpha |
| maximum alpha | |
| float | cycle_len |
| length in seconds of one cycle | |
| float | t |
| local time in seconds | |
| Protected Attributes inherited from Light | |
| Vector | position |
| Color | color |
| SpritePtr | sprite |
| 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 | |
Detailed Description
Light source that changes alpha value to give the impression of a pulsating light.
Member Function Documentation
§ draw()
|
overridevirtual |
The GameObject should draw itself onto the provided DrawingContext if this function is called.
Reimplemented from Light.
§ update()
|
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.
Reimplemented from Light.
The documentation for this class was generated from the following files:
- src/object/pulsing_light.hpp
- src/object/pulsing_light.cpp
