classref: Add property overview and setter/getter like in editor docs

Output from godotengine/godot#22013.
Fixes #1729.
This commit is contained in:
Rémi Verschelde
2018-09-13 11:06:52 +02:00
parent f9caa4be29
commit ab3f908221
578 changed files with 33831 additions and 6706 deletions

View File

@@ -8,7 +8,9 @@ VisualInstance
==============
**Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`BakedLightmap<class_BakedLightmap>`, :ref:`Light<class_Light>`, :ref:`RootMotionView<class_RootMotionView>`, :ref:`ReflectionProbe<class_ReflectionProbe>`, :ref:`CSGShape<class_CSGShape>`, :ref:`GIProbe<class_GIProbe>`, :ref:`GeometryInstance<class_GeometryInstance>`
**Category:** Core
Brief Description
@@ -16,6 +18,13 @@ Brief Description
Properties
----------
+-----------------------+--------------------------------------------+
| :ref:`int<class_int>` | :ref:`layers<class_VisualInstance_layers>` |
+-----------------------+--------------------------------------------+
Methods
-------
@@ -36,25 +45,32 @@ Property Descriptions
.. _class_VisualInstance_layers:
- :ref:`int<class_int>` **layers** - The render layer(s) this VisualInstance is drawn on.
- :ref:`int<class_int>` **layers**
+----------+-----------------------+
| *Setter* | set_layer_mask(value) |
+----------+-----------------------+
| *Getter* | get_layer_mask() |
+----------+-----------------------+
The render layer(s) this VisualInstance is drawn on.
This object will only be visible for :ref:`Camera<class_Camera>`\ s whose cull mask includes the render object this VisualInstance is set to.
Method Descriptions
-------------------
.. _class_VisualInstance_get_aabb:
.. _class_VisualInstance_get_aabb:
- :ref:`AABB<class_AABB>` **get_aabb** **(** **)** const
Returns the :ref:`AABB<class_AABB>` (also known as the bounding box) for this VisualInstance.
.. _class_VisualInstance_get_layer_mask_bit:
.. _class_VisualInstance_get_layer_mask_bit:
- :ref:`bool<class_bool>` **get_layer_mask_bit** **(** :ref:`int<class_int>` layer **)** const
.. _class_VisualInstance_get_transformed_aabb:
.. _class_VisualInstance_get_transformed_aabb:
- :ref:`AABB<class_AABB>` **get_transformed_aabb** **(** **)** const
@@ -62,7 +78,7 @@ Returns the transformed :ref:`AABB<class_AABB>` (also known as the bounding box)
Transformed in this case means the :ref:`AABB<class_AABB>` plus the position, rotation, and scale of the :ref:`Spatial<class_Spatial>`\ s :ref:`Transform<class_Transform>`
.. _class_VisualInstance_set_base:
.. _class_VisualInstance_set_base:
- void **set_base** **(** :ref:`RID<class_RID>` base **)**
@@ -70,8 +86,7 @@ Sets the base of the VisualInstance, which changes how the engine handles the Vi
It is recommended to only use set_base if you know what you're doing.
.. _class_VisualInstance_set_layer_mask_bit:
.. _class_VisualInstance_set_layer_mask_bit:
- void **set_layer_mask_bit** **(** :ref:`int<class_int>` layer, :ref:`bool<class_bool>` enabled **)**