mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-12-23 12:26:59 +01:00
46 lines
2.0 KiB
XML
46 lines
2.0 KiB
XML
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||
|
|
<class name="Sprite3D" inherits="SpriteBase3D" version="3.5">
|
||
|
|
<brief_description>
|
||
|
|
2D sprite node in a 3D world.
|
||
|
|
</brief_description>
|
||
|
|
<description>
|
||
|
|
A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation.
|
||
|
|
</description>
|
||
|
|
<tutorials>
|
||
|
|
</tutorials>
|
||
|
|
<methods>
|
||
|
|
</methods>
|
||
|
|
<members>
|
||
|
|
<member name="frame" type="int" setter="set_frame" getter="get_frame" default="0">
|
||
|
|
Current frame to display from sprite sheet. [member hframes] or [member vframes] must be greater than 1.
|
||
|
|
</member>
|
||
|
|
<member name="frame_coords" type="Vector2" setter="set_frame_coords" getter="get_frame_coords" default="Vector2( 0, 0 )">
|
||
|
|
Coordinates of the frame to display from sprite sheet. This is as an alias for the [member frame] property. [member hframes] or [member vframes] must be greater than 1.
|
||
|
|
</member>
|
||
|
|
<member name="hframes" type="int" setter="set_hframes" getter="get_hframes" default="1">
|
||
|
|
The number of columns in the sprite sheet.
|
||
|
|
</member>
|
||
|
|
<member name="region_enabled" type="bool" setter="set_region" getter="is_region" default="false">
|
||
|
|
If [code]true[/code], texture will be cut from a larger atlas texture. See [member region_rect].
|
||
|
|
</member>
|
||
|
|
<member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" default="Rect2( 0, 0, 0, 0 )">
|
||
|
|
The region of the atlas texture to display. [member region_enabled] must be [code]true[/code].
|
||
|
|
</member>
|
||
|
|
<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
|
||
|
|
[Texture] object to draw. If [member GeometryInstance.material_override] is used, this will be overridden.
|
||
|
|
</member>
|
||
|
|
<member name="vframes" type="int" setter="set_vframes" getter="get_vframes" default="1">
|
||
|
|
The number of rows in the sprite sheet.
|
||
|
|
</member>
|
||
|
|
</members>
|
||
|
|
<signals>
|
||
|
|
<signal name="frame_changed">
|
||
|
|
<description>
|
||
|
|
Emitted when the [member frame] changes.
|
||
|
|
</description>
|
||
|
|
</signal>
|
||
|
|
</signals>
|
||
|
|
<constants>
|
||
|
|
</constants>
|
||
|
|
</class>
|