asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/Sprite3D.xml

47 lines
2.3 KiB
XML
Raw Normal View History

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 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:05 +02:00
<class name="Sprite3D" inherits="SpriteBase3D" 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 22:42:36 +02: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-22 01:04:47 +02: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 22:42:36 +02: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 21:38:36 +02: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 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="frame" type="int" setter="set_frame" getter="get_frame" default="0">
Reorder sprite h_frames & v_frames
2020-08-22 01:56:14 +02: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 22:42:36 +02:00
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +02: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-22 01:56:14 +02: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 19:21:23 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02: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 18:33:16 +02: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 22:42:36 +02: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 14:43:43 +01:00
<member name="region_enabled" type="bool" setter="set_region_enabled" getter="is_region_enabled" default="false">
Fill random docs
2022-11-21 03:48:36 +01: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 22:42:36 +02:00
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +02: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 18:33:16 +02: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 22:42:36 +02: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 09:59:06 +01:00
<member name="texture" type="Texture2D" setter="set_texture" getter="get_texture">
Added to Sprite3D Documentation
2022-08-09 06:08:26 +02: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 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02: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 18:33:16 +02: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 22:42:36 +02:00
</member>
</members>
<signals>
<signal name="frame_changed">
<description>
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc.
2017-10-06 18:33:16 +02: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 22:42:36 +02:00
</description>
</signal>
Add `texture_changed` signal to `Sprite3D`
2021-10-01 09:14:05 +02: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 22:42:36 +02:00
</signals>
</class>
Reference in a new issue Copy permalink