generated from nathanfranke/gdextension
-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update docs w/ assets and instancer classes
- Loading branch information
1 parent
4da0b1a
commit 9197499
Showing
17 changed files
with
783 additions
and
305 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,167 @@ | ||
:github_url: hide | ||
|
||
.. DO NOT EDIT THIS FILE!!! | ||
.. Generated automatically from Godot engine sources. | ||
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. | ||
.. XML source: https://github.com/godotengine/godot/tree/master/../_plugins/Terrain3D/doc/classes/Terrain3DAssetList.xml. | ||
.. _class_Terrain3DAssetList: | ||
|
||
Terrain3DAssetList | ||
================== | ||
|
||
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>` | ||
|
||
.. rst-class:: classref-introduction-group | ||
|
||
Description | ||
----------- | ||
|
||
This class contains an array of ``Terrain3DTexture`` objects in 32 slots. It is a savable resource, so you can save it to disk and use the same texture list in multiple scenes that use Terrain3D. The amount of data is small, so it can be saved as a git-friendly, text based .tres file or left within the scene file. | ||
|
||
.. rst-class:: classref-reftable-group | ||
|
||
Properties | ||
---------- | ||
|
||
.. table:: | ||
:widths: auto | ||
|
||
+---------------------------------------------------+-------------------------------------------------------------+--------+ | ||
| :ref:`Terrain3DTexture[]<class_Terrain3DTexture>` | :ref:`textures<class_Terrain3DAssetList_property_textures>` | ``[]`` | | ||
+---------------------------------------------------+-------------------------------------------------------------+--------+ | ||
|
||
.. rst-class:: classref-reftable-group | ||
|
||
Methods | ||
------- | ||
|
||
.. table:: | ||
:widths: auto | ||
|
||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||
| :ref:`Terrain3DTexture<class_Terrain3DTexture>` | :ref:`get_texture<class_Terrain3DAssetList_method_get_texture>` **(** :ref:`int<class_int>` index **)** | | ||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||
| :ref:`int<class_int>` | :ref:`get_texture_count<class_Terrain3DAssetList_method_get_texture_count>` **(** **)** | | ||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||
| void | :ref:`save<class_Terrain3DAssetList_method_save>` **(** **)** | | ||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||
| void | :ref:`set_texture<class_Terrain3DAssetList_method_set_texture>` **(** :ref:`int<class_int>` index, :ref:`Terrain3DTexture<class_Terrain3DTexture>` texture **)** | | ||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||
|
||
.. rst-class:: classref-section-separator | ||
|
||
---- | ||
|
||
.. rst-class:: classref-descriptions-group | ||
|
||
Signals | ||
------- | ||
|
||
.. _class_Terrain3DAssetList_signal_textures_changed: | ||
|
||
.. rst-class:: classref-signal | ||
|
||
**textures_changed** **(** **)** | ||
|
||
Emitted when this list is updated due to changes in the texture slots, or the files or settings in any of the Terrain3DTextures. | ||
|
||
.. rst-class:: classref-section-separator | ||
|
||
---- | ||
|
||
.. rst-class:: classref-descriptions-group | ||
|
||
Constants | ||
--------- | ||
|
||
.. _class_Terrain3DAssetList_constant_MAX_TEXTURES: | ||
|
||
.. rst-class:: classref-constant | ||
|
||
**MAX_TEXTURES** = ``32`` | ||
|
||
Hard coded maximum number of textures, with IDs in the range of 0-31. | ||
|
||
.. rst-class:: classref-section-separator | ||
|
||
---- | ||
|
||
.. rst-class:: classref-descriptions-group | ||
|
||
Property Descriptions | ||
--------------------- | ||
|
||
.. _class_Terrain3DAssetList_property_textures: | ||
|
||
.. rst-class:: classref-property | ||
|
||
:ref:`Terrain3DTexture[]<class_Terrain3DTexture>` **textures** = ``[]`` | ||
|
||
.. rst-class:: classref-property-setget | ||
|
||
- void **set_textures** **(** :ref:`Terrain3DTexture[]<class_Terrain3DTexture>` value **)** | ||
- :ref:`Terrain3DTexture[]<class_Terrain3DTexture>` **get_textures** **(** **)** | ||
|
||
The array of Terrain3DTextures. | ||
|
||
.. rst-class:: classref-section-separator | ||
|
||
---- | ||
|
||
.. rst-class:: classref-descriptions-group | ||
|
||
Method Descriptions | ||
------------------- | ||
|
||
.. _class_Terrain3DAssetList_method_get_texture: | ||
|
||
.. rst-class:: classref-method | ||
|
||
:ref:`Terrain3DTexture<class_Terrain3DTexture>` **get_texture** **(** :ref:`int<class_int>` index **)** | ||
|
||
Returns the Terrain3DTexture with the requested ID. | ||
|
||
.. rst-class:: classref-item-separator | ||
|
||
---- | ||
|
||
.. _class_Terrain3DAssetList_method_get_texture_count: | ||
|
||
.. rst-class:: classref-method | ||
|
||
:ref:`int<class_int>` **get_texture_count** **(** **)** | ||
|
||
Returns the number of texture slots used. | ||
|
||
.. rst-class:: classref-item-separator | ||
|
||
---- | ||
|
||
.. _class_Terrain3DAssetList_method_save: | ||
|
||
.. rst-class:: classref-method | ||
|
||
void **save** **(** **)** | ||
|
||
Saves this texture list resource to disk, if saved as an external ``.tres`` or ``.res`` resource file. | ||
|
||
.. rst-class:: classref-item-separator | ||
|
||
---- | ||
|
||
.. _class_Terrain3DAssetList_method_set_texture: | ||
|
||
.. rst-class:: classref-method | ||
|
||
void **set_texture** **(** :ref:`int<class_int>` index, :ref:`Terrain3DTexture<class_Terrain3DTexture>` texture **)** | ||
|
||
Adds a Terrain3DTexture at the specified ID slot. The texture can be null to clear the slot, or remove it if its the last in the list. If the specified slot is full, it will be swapped with the source texture ID, or will find the next available ID. | ||
|
||
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` | ||
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` | ||
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` | ||
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` | ||
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` | ||
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` | ||
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` |
Oops, something went wrong.