asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2019-04-24 07:49:38 +02:00
parent 6cf7cfa081
commit ea56d18256
3 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/classes/EditorInspectorPlugin.xml
View file

@ -4,13 +4,13 @@
Plugin for adding custom property editors on inspector.
</brief_description>
<description>
This plugins allows adding custom property editors to [EditorInspector].
Plugins are registered via [method EditorPlugin.add_inspector_plugin].
When an object is edited, the [method can_handle] function is called and must return true if the object type is supported.
If supported, the function [method parse_begin] will be called, allowing to place custom controls at the beginning of the class.
Subsequently, the [method parse_category] and [method parse_property] are called for every category and property. They offer the ability to add custom controls to the inspector too.
Finally [method parse_end] will be called.
On each of these calls, the "add" functions can be called.
This plugins allows adding custom property editors to [EditorInspector].
Plugins are registered via [method EditorPlugin.add_inspector_plugin].
When an object is edited, the [method can_handle] function is called and must return true if the object type is supported.
If supported, the function [method parse_begin] will be called, allowing to place custom controls at the beginning of the class.
Subsequently, the [method parse_category] and [method parse_property] are called for every category and property. They offer the ability to add custom controls to the inspector too.
Finally [method parse_end] will be called.
On each of these calls, the "add" functions can be called.
</description>
<tutorials>
</tutorials>

4
doc/classes/EditorProperty.xml
View file

@ -15,7 +15,7 @@
<argument index="0" name="control" type="Control">
</argument>
<description>
If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed.
If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed.
</description>
</method>
<method name="emit_changed">
@ -60,7 +60,7 @@
<argument index="0" name="editor" type="Control">
</argument>
<description>
Add controls with this function if you want them on the bottom (below the label).
Add controls with this function if you want them on the bottom (below the label).
</description>
</method>
<method name="update_property" qualifiers="virtual">

10
doc/classes/MeshTexture.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="MeshTexture" inherits="Texture" category="Core" version="3.2">
<brief_description>
Simple texture that uses a mesh to draw itself.
Simple texture that uses a mesh to draw itself.
</brief_description>
<description>
Simple texture that uses a mesh to draw itself. It's limited because flags can't be changed and region drawing is not supported.
Simple texture that uses a mesh to draw itself. It's limited because flags can't be changed and region drawing is not supported.
</description>
<tutorials>
</tutorials>
@ -12,13 +12,13 @@
</methods>
<members>
<member name="base_texture" type="Texture" setter="set_base_texture" getter="get_base_texture">
Set the base texture that the Mesh will use to draw.
Set the base texture that the Mesh will use to draw.
</member>
<member name="image_size" type="Vector2" setter="set_image_size" getter="get_image_size">
Set the size of the image, needed for reference.
Set the size of the image, needed for reference.
</member>
<member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh">
Set the mesh used to draw. It must be a mesh using 2D vertices.
Set the mesh used to draw. It must be a mesh using 2D vertices.
</member>
</members>
<constants>