summaryrefslogtreecommitdiff
path: root/doc/classes/Sprite.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Sprite.xml')
-rw-r--r--doc/classes/Sprite.xml190
1 files changed, 1 insertions, 189 deletions
diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml
index 7996adab51..655e98b3ed 100644
--- a/doc/classes/Sprite.xml
+++ b/doc/classes/Sprite.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="Sprite" inherits="Node2D" category="Core" version="3.0-alpha">
+<class name="Sprite" inherits="Node2D" category="Core" version="3.0-beta">
<brief_description>
General purpose Sprite node.
</brief_description>
@@ -11,194 +11,6 @@
<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">