967bfb0c4a
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
128 lines
3.5 KiB
XML
128 lines
3.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Sprite3D" inherits="SpriteBase3D" category="Core" version="3.0-alpha">
|
|
<brief_description>
|
|
2D Sprite node in 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>
|
|
<demos>
|
|
</demos>
|
|
<methods>
|
|
<method name="get_frame" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_hframes" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_region_rect" qualifiers="const">
|
|
<return type="Rect2">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_texture" qualifiers="const">
|
|
<return type="Texture">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_vframes" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="is_region" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_frame">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="frame" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_hframes">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="hframes" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_region">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="enabled" type="bool">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_region_rect">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="rect" type="Rect2">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_texture">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="texture" type="Texture">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_vframes">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="vframes" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="frame" type="int" setter="set_frame" getter="get_frame">
|
|
Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1.
|
|
</member>
|
|
<member name="hframes" type="int" setter="set_hframes" getter="get_hframes">
|
|
The number of columns in the sprite sheet.
|
|
</member>
|
|
<member name="region_enabled" type="bool" setter="set_region" getter="is_region">
|
|
If [code]true[/code] texture will be cut from a larger atlas texture. See [member region_rect]. Default value: [code]false[/code].
|
|
</member>
|
|
<member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect">
|
|
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.
|
|
</member>
|
|
<member name="vframes" type="int" setter="set_vframes" getter="get_vframes">
|
|
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>
|