Inheritance diagram for scripting::FloatingImage:
Public Member Functions | |
| FloatingImage (const std::string &spritefile) | |
| void | set_layer (int layer) |
| Sets the layer of the floating image. More... | |
| int | get_layer () const |
| Returns the layer the floating image is on. | |
| void | set_pos (float x, float y) |
| Sets the location of the image, in relation to the current anchor point. More... | |
| float | get_pos_x () const |
| Returns the image's X coordinate relative to the current anchor point. | |
| float | get_pos_y () const |
| Returns the image's Y coordinate relative to the current anchor point. | |
| void | set_anchor_point (int anchor) |
| Sets the image's anchor point. More... | |
| int | get_anchor_point () const |
| Returns the current anchor point. | |
| void | set_visible (bool visible) |
| Sets the visibility of the floating image. More... | |
| bool | get_visible () const |
| Returns the visibility state of the floating image. | |
| void | set_action (const std::string &action) |
| Sets the action of the image This is only useful when the image is a sprite. More... | |
| std::string | get_action () const |
| Returns the action of the image This is only useful when the image is a sprite. More... | |
| void | fade_in (float fadetime) |
| void | fade_out (float fadetime) |
 Public Member Functions inherited from scripting::GameObject<::FloatingImage > | |
| GameObject (UID uid) | |
| ::FloatingImage * | get_object_ptr () const |
Additional Inherited Members | |
| Protected Attributes inherited from scripting::GameObject<::FloatingImage > | |
| UID | m_uid |
Member Function Documentation
§ get_action()
| std::string FloatingImage::get_action | ( | ) | const |
Returns the action of the image This is only useful when the image is a sprite.
- Returns
- Name of the action, as defined in the sprite
§ set_action()
| void FloatingImage::set_action | ( | const std::string & | action | ) |
Sets the action of the image This is only useful when the image is a sprite.
- Parameters
-
action Name of the action, as defined in the sprite
§ set_anchor_point()
| void FloatingImage::set_anchor_point | ( | int | anchor | ) |
Sets the image's anchor point.
- Parameters
-
anchor Anchor point as represented by the ANCHOR_* constants
§ set_layer()
| void FloatingImage::set_layer | ( | int | layer | ) |
Sets the layer of the floating image.
- Parameters
-
layer Target layer
§ set_pos()
| void FloatingImage::set_pos | ( | float | x, |
| float | y | ||
| ) |
Sets the location of the image, in relation to the current anchor point.
- Parameters
-
x X coordinate y Y coordinate
§ set_visible()
| void FloatingImage::set_visible | ( | bool | visible | ) |
Sets the visibility of the floating image.
- Parameters
-
visible Visibility
The documentation for this class was generated from the following files:
- src/scripting/floating_image.hpp
- src/scripting/floating_image.cpp
