godot/doc/classes/Sprite3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Sprite3D" inherits="SpriteBase3D" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<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. See also [SpriteBase3D] where properties such as the billboard mode are defined.
	</description>
	<tutorials>
	</tutorials>
	<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="Vector2i" setter="set_frame_coords" getter="get_frame_coords" default="Vector2i(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_enabled" getter="is_region_enabled" default="false">
			If [code]true[/code], the sprite will use [member region_rect] and display only the specified part of its texture.
		</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="Texture2D" setter="set_texture" getter="get_texture">
			[Texture2D] object to draw. If [member GeometryInstance3D.material_override] is used, this will be overridden. The size information is still used.
		</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>
		<signal name="texture_changed">
			<description>
				Emitted when the [member texture] changes.
			</description>
		</signal>
	</signals>
</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" ?>`
Bump version to 4.1-dev Can't stop, won't stop, they said, huh? 2023-03-01 00:44:37 +00:00			`<class name="Sprite3D" inherits="SpriteBase3D" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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>`
Update and complete the Sprite3D and SpriteBase3D class documentations This removes an outdated notice about Sprite3D performance issues which will most likely be fixed in the new implementation. 2020-09-10 19:38:36 +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. See also [SpriteBase3D] where properties such as the billboard mode are defined.`
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>`
			`<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 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>`
Better format arguments in variant parser 2019-09-24 17:45:03 +00:00			`<member name="frame_coords" type="Vector2i" setter="set_frame_coords" getter="get_frame_coords" default="Vector2i(0, 0)">`
Reorder sprite h_frames & v_frames 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>`
Rename Sprite.region_enabled getter and setter to match properties Also renames Sprite2D.region_filter_clip property and its setter to region_filter_clip_enabled and set_region_filter_clip_enabled. 2021-03-14 13:43:43 +00:00			`<member name="region_enabled" type="bool" setter="set_region_enabled" getter="is_region_enabled" default="false">`
Fill random docs 2022-11-21 02:48:36 +00:00			`If [code]true[/code], the sprite will use [member region_rect] and display only the specified part of its texture.`
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>`
Better format arguments in variant parser 2019-09-24 17:45:03 +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 Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer. 2020-02-12 08:59:06 +00:00			`<member name="texture" type="Texture2D" setter="set_texture" getter="get_texture">`
Added to Sprite3D Documentation 2022-08-09 04:08:26 +00:00			`[Texture2D] object to draw. If [member GeometryInstance3D.material_override] is used, this will be overridden. The size information is still used.`
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>`
Add `texture_changed` signal to `Sprite3D` 2021-10-01 07:14:05 +00:00			`<signal name="texture_changed">`
			`<description>`
			`Emitted when the [member texture] changes.`
			`</description>`
			`</signal>`
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			`</signals>`
			`</class>`