Extract docs.

This commit is contained in:
Relintai 2020-04-03 09:36:06 +02:00
parent af09392363
commit c1e692f968
15 changed files with 503 additions and 0 deletions

View File

@ -0,0 +1,89 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GroundClutter" inherits="Resource" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_add_meshes_to" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="mesher" type="VoxelMesher">
</argument>
<argument index="1" name="chunk" type="VoxelChunk">
</argument>
<argument index="2" name="x" type="int">
</argument>
<argument index="3" name="y" type="int">
</argument>
<argument index="4" name="z" type="int">
</argument>
<description>
</description>
</method>
<method name="_add_textures_to" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="packer" type="TexturePacker">
</argument>
<description>
</description>
</method>
<method name="_should_spawn" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="chunk" type="VoxelChunk">
</argument>
<argument index="1" name="x" type="int">
</argument>
<argument index="2" name="y" type="int">
</argument>
<argument index="3" name="z" type="int">
</argument>
<description>
</description>
</method>
<method name="add_meshes_to">
<return type="void">
</return>
<argument index="0" name="mesher" type="VoxelMesher">
</argument>
<argument index="1" name="chunk" type="VoxelChunk">
</argument>
<argument index="2" name="x" type="int">
</argument>
<argument index="3" name="y" type="int">
</argument>
<argument index="4" name="z" type="int">
</argument>
<description>
</description>
</method>
<method name="add_textures_to">
<return type="void">
</return>
<argument index="0" name="packer" type="TexturePacker">
</argument>
<description>
</description>
</method>
<method name="should_spawn">
<return type="bool">
</return>
<argument index="0" name="chunk" type="VoxelChunk">
</argument>
<argument index="1" name="x" type="int">
</argument>
<argument index="2" name="y" type="int">
</argument>
<argument index="3" name="z" type="int">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

View File

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GroundClutterFoliage" inherits="GroundClutter" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_texture">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
<description>
</description>
</method>
<method name="get_texture">
<return type="Texture">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="get_texture_count" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="remove_texture">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

109
doc_classes/PropData.xml Normal file
View File

@ -0,0 +1,109 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropData" inherits="Resource" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_meshes_into">
<return type="void">
</return>
<argument index="0" name="mesher" type="VoxelMesher">
</argument>
<argument index="1" name="texture_packer" type="TexturePacker">
</argument>
<argument index="2" name="parent_transform" type="Transform">
</argument>
<argument index="3" name="snap_spatial" type="Node">
</argument>
<description>
</description>
</method>
<method name="add_prop">
<return type="void">
</return>
<argument index="0" name="prop" type="PropDataEntry">
</argument>
<description>
</description>
</method>
<method name="add_prop_lights_into">
<return type="void">
</return>
<argument index="0" name="chunk" type="VoxelChunk">
</argument>
<argument index="1" name="parent_transform" type="Transform">
</argument>
<argument index="2" name="allow_snap" type="bool">
</argument>
<description>
</description>
</method>
<method name="add_textures_into">
<return type="void">
</return>
<argument index="0" name="texture_packer" type="TexturePacker">
</argument>
<description>
</description>
</method>
<method name="get_next_snapped_prop_transform">
<return type="Transform">
</return>
<argument index="0" name="spatial" type="Node">
</argument>
<argument index="1" name="parent_transform" type="Transform">
</argument>
<argument index="2" name="snap_to_mesh" type="bool">
</argument>
<argument index="3" name="snap_axis" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="get_prop" qualifiers="const">
<return type="PropDataEntry">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="get_prop_count" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="remove_prop">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="set_prop">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="spell" type="PropDataEntry">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="props" type="Array" setter="set_props" getter="get_props" default="[ ]">
</member>
<member name="snap_axis" type="Vector3" setter="set_snap_axis" getter="get_snap_axis" default="Vector3( 0, -1, 0 )">
</member>
<member name="snap_to_mesh" type="bool" setter="set_snap_to_mesh" getter="get_snap_to_mesh" default="false">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropDataEntity" inherits="PropDataEntry" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="entity_data_id" type="int" setter="set_entity_data_id" getter="get_entity_data_id" default="0">
</member>
<member name="level" type="int" setter="set_level" getter="get_level" default="1">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropDataEntry" inherits="Resource" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="transform" type="Transform" setter="set_transform" getter="get_transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropDataLight" inherits="PropDataEntry" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="light_color" type="Color" setter="set_light_color" getter="get_light_color" default="Color( 0, 0, 0, 1 )">
</member>
<member name="light_size" type="int" setter="set_light_size" getter="get_light_size" default="5">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropDataMesh" inherits="PropDataEntry" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="mesh" type="MeshDataResource" setter="set_mesh" getter="get_mesh">
</member>
<member name="snap_axis" type="Vector3" setter="set_snap_axis" getter="get_snap_axis" default="Vector3( 0, 1, 0 )">
</member>
<member name="snap_to_mesh" type="bool" setter="set_snap_to_mesh" getter="get_snap_to_mesh" default="true">
</member>
<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropDataProp" inherits="PropDataEntry" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="prop" type="PropData" setter="set_prop" getter="get_prop">
</member>
<member name="snap_axis" type="Vector3" setter="set_snap_axis" getter="get_snap_axis" default="Vector3( 0, 1, 0 )">
</member>
<member name="snap_to_mesh" type="bool" setter="set_snap_to_mesh" getter="get_snap_to_mesh" default="false">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropDataScene" inherits="PropDataEntry" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="scene" type="PackedScene" setter="set_scene" getter="get_scene">
</member>
<member name="snap_axis" type="Vector3" setter="set_snap_axis" getter="get_snap_axis" default="Vector3( 0, 1, 0 )">
</member>
<member name="snap_to_mesh" type="bool" setter="set_snap_to_mesh" getter="get_snap_to_mesh" default="true">
</member>
</members>
<constants>
</constants>
</class>

13
doc_classes/PropTool.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropTool" inherits="Spatial" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropToolEntity" inherits="Spatial" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="evaluate_children" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="data" type="PropDataEntity" setter="set_data" getter="get_data">
</member>
<member name="entity_data" type="EntityData" setter="set_entity_data" getter="get_entity_data">
</member>
<member name="entity_data_id" type="int" setter="set_entity_data_id" getter="get_entity_data_id" default="0">
</member>
<member name="level" type="int" setter="set_level" getter="get_level" default="1">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropToolLight" inherits="OmniLight" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="data" type="PropDataLight" setter="set_data" getter="get_data">
</member>
<member name="snap_to_mesh" type="bool" setter="set_snap_to_mesh" getter="get_snap_to_mesh" default="false">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropToolMesh" inherits="MeshInstance" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="generate">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="data" type="PropDataMesh" setter="set_data" getter="get_data">
</member>
<member name="generate" type="bool" setter="set_generate" getter="get_generate" default="false">
</member>
<member name="mesh_data" type="MeshDataResource" setter="set_mesh_data" getter="get_mesh_data">
</member>
<member name="prop_mesh" type="MeshDataResource" setter="set_prop_mesh" getter="get_prop_mesh">
</member>
<member name="snap_axis" type="Vector3" setter="set_snap_axis" getter="get_snap_axis" default="Vector3( 0, -1, 0 )">
</member>
<member name="snap_to_mesh" type="bool" setter="set_snap_to_mesh" getter="get_snap_to_mesh" default="false">
</member>
<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropToolProp" inherits="Spatial" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="data" type="PropDataProp" setter="set_data" getter="get_data">
</member>
<member name="prop_data" type="PropData" setter="set_prop_data" getter="get_prop_data">
</member>
<member name="snap_axis" type="Vector3" setter="set_snap_axis" getter="get_snap_axis" default="Vector3( 0, -1, 0 )">
</member>
<member name="snap_to_mesh" type="bool" setter="set_snap_to_mesh" getter="get_snap_to_mesh" default="false">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropToolScene" inherits="Spatial" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="data" type="PropDataScene" setter="set_data" getter="get_data">
</member>
<member name="scene_data" type="PackedScene" setter="set_scene_data" getter="get_scene_data">
</member>
<member name="snap_axis" type="Vector3" setter="set_snap_axis" getter="get_snap_axis" default="Vector3( 0, -1, 0 )">
</member>
<member name="snap_to_mesh" type="bool" setter="set_snap_to_mesh" getter="get_snap_to_mesh" default="false">
</member>
</members>
<constants>
</constants>
</class>