godot/doc/classes/Sprite3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Sprite3D" inherits="SpriteBase3D" version="3.2">
	<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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Drop unused 'category' property from header We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0. 2020-01-26 15:01:49 +00:00			`<class name="Sprite3D" inherits="SpriteBase3D" version="3.2">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<brief_description>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-21 23:04:47 +00:00			`2D sprite node in a 3D world.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</brief_description>`
			`<description>`
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. 2017-10-06 16:33:16 +00:00			`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.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="frame" type="int" setter="set_frame" getter="get_frame" default="0">`
Reorder sprite h_frames & v_frames (cherry picked from commit 28326aec60f7f53f822a386c845507dbdc55e9e1) 2020-08-21 23:56:14 +00:00			`Current frame to display from sprite sheet. [member hframes] or [member vframes] must be greater than 1.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</member>`
doc: Sync classref with current source 2019-07-29 19:12:57 +00:00			`<member name="frame_coords" type="Vector2" setter="set_frame_coords" getter="get_frame_coords" default="Vector2( 0, 0 )">`
Reorder sprite h_frames & v_frames (cherry picked from commit 28326aec60f7f53f822a386c845507dbdc55e9e1) 2020-08-21 23:56:14 +00:00			`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.`
Add frame_cords accessors to Sprite and Sprite3D 2019-01-25 18:21:23 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="hframes" type="int" setter="set_hframes" getter="get_hframes" default="1">`
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. 2017-10-06 16:33:16 +00:00			`The number of columns in the sprite sheet.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="region_enabled" type="bool" setter="set_region" getter="is_region" default="false">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 13:24:23 +00:00			`If [code]true[/code], texture will be cut from a larger atlas texture. See [member region_rect].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" default="Rect2( 0, 0, 0, 0 )">`
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. 2017-10-06 16:33:16 +00:00			`The region of the atlas texture to display. [member region_enabled] must be [code]true[/code].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</member>`
doc: Sync classref with current source 2019-07-15 18:42:47 +00:00			`<member name="texture" type="Texture" setter="set_texture" getter="get_texture">`
Update Sprite3D docs to reflect recent changes 2020-08-06 20:10:39 +00:00			`[Texture] object to draw. If [member GeometryInstance.material_override] is used, this will be overridden.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="vframes" type="int" setter="set_vframes" getter="get_vframes" default="1">`
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. 2017-10-06 16:33:16 +00:00			`The number of rows in the sprite sheet.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</member>`
			`</members>`
			`<signals>`
			`<signal name="frame_changed">`
			`<description>`
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. 2017-10-06 16:33:16 +00:00			`Emitted when the [member frame] changes.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</description>`
			`</signal>`
			`</signals>`
			`<constants>`
			`</constants>`
			`</class>`