242 lines
6.9 KiB
XML
242 lines
6.9 KiB
XML
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||
|
|
<class name="Sprite" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
|
||
|
|
<brief_description>
|
||
|
|
General purpose Sprite node.
|
||
|
|
</brief_description>
|
||
|
|
<description>
|
||
|
|
General purpose Sprite node. This Sprite node can show any texture as a sprite. The texture can be used as a spritesheet for animation, or only a region from a bigger texture can referenced, like an atlas.
|
||
|
|
</description>
|
||
|
|
<tutorials>
|
||
|
|
</tutorials>
|
||
|
|
<demos>
|
||
|
|
</demos>
|
||
|
|
<methods>
|
||
|
|
<method name="get_frame" qualifiers="const">
|
||
|
|
<return type="int">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="get_hframes" qualifiers="const">
|
||
|
|
<return type="int">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
Return the amount of horizontal frames. See [method set_hframes].
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="get_normal_map" qualifiers="const">
|
||
|
|
<return type="Texture">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="get_offset" qualifiers="const">
|
||
|
|
<return type="Vector2">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
Return sprite draw offset.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="get_region_rect" qualifiers="const">
|
||
|
|
<return type="Rect2">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
Return the region rect to read from.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="get_texture" qualifiers="const">
|
||
|
|
<return type="Texture">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
Return the base texture for the sprite.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="get_vframes" qualifiers="const">
|
||
|
|
<return type="int">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
Return the amount of vertical frames. See [method set_vframes].
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="is_centered" qualifiers="const">
|
||
|
|
<return type="bool">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
Return if the sprite is centered at the local origin.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="is_flipped_h" qualifiers="const">
|
||
|
|
<return type="bool">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
Return true if the sprite is flipped horizontally.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="is_flipped_v" qualifiers="const">
|
||
|
|
<return type="bool">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
Return true if the sprite is flipped vertically.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="is_region" qualifiers="const">
|
||
|
|
<return type="bool">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
Return if the sprite reads from a region.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="is_region_filter_clip_enabled" qualifiers="const">
|
||
|
|
<return type="bool">
|
||
|
|
</return>
|
||
|
|
<description>
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_centered">
|
||
|
|
<return type="void">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="centered" type="bool">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Set whether the sprite should be centered on the origin.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_flip_h">
|
||
|
|
<return type="void">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="flip_h" type="bool">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Set true to flip the sprite horizontally.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_flip_v">
|
||
|
|
<return type="void">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="flip_v" type="bool">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Set true to flip the sprite vertically.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_frame">
|
||
|
|
<return type="void">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="frame" type="int">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_hframes">
|
||
|
|
<return type="void">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="hframes" type="int">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_normal_map">
|
||
|
|
<return type="void">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="normal_map" type="Texture">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_offset">
|
||
|
|
<return type="void">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="offset" type="Vector2">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Set the sprite draw offset, useful for setting rotation pivots.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_region">
|
||
|
|
<return type="void">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="enabled" type="bool">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_region_filter_clip">
|
||
|
|
<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>
|
||
|
|
Set the region rect to read from.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_texture">
|
||
|
|
<return type="void">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="texture" type="Texture">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Set the base texture for the sprite.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_vframes">
|
||
|
|
<return type="void">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="vframes" type="int">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
</methods>
|
||
|
|
<members>
|
||
|
|
<member name="centered" type="bool" setter="set_centered" getter="is_centered" brief="">
|
||
|
|
</member>
|
||
|
|
<member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h" brief="">
|
||
|
|
</member>
|
||
|
|
<member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v" brief="">
|
||
|
|
</member>
|
||
|
|
<member name="frame" type="int" setter="set_frame" getter="get_frame" brief="">
|
||
|
|
</member>
|
||
|
|
<member name="hframes" type="int" setter="set_hframes" getter="get_hframes" brief="">
|
||
|
|
</member>
|
||
|
|
<member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map" brief="">
|
||
|
|
</member>
|
||
|
|
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset" brief="">
|
||
|
|
</member>
|
||
|
|
<member name="region_enabled" type="bool" setter="set_region" getter="is_region" brief="">
|
||
|
|
</member>
|
||
|
|
<member name="region_filter_clip" type="bool" setter="set_region_filter_clip" getter="is_region_filter_clip_enabled" brief="">
|
||
|
|
</member>
|
||
|
|
<member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" brief="">
|
||
|
|
</member>
|
||
|
|
<member name="texture" type="Texture" setter="set_texture" getter="get_texture" brief="">
|
||
|
|
</member>
|
||
|
|
<member name="vframes" type="int" setter="set_vframes" getter="get_vframes" brief="">
|
||
|
|
</member>
|
||
|
|
</members>
|
||
|
|
<signals>
|
||
|
|
<signal name="frame_changed">
|
||
|
|
<description>
|
||
|
|
</description>
|
||
|
|
</signal>
|
||
|
|
<signal name="texture_changed">
|
||
|
|
<description>
|
||
|
|
</description>
|
||
|
|
</signal>
|
||
|
|
</signals>
|
||
|
|
<constants>
|
||
|
|
</constants>
|
||
|
|
</class>
|