Re-extracted the class docs.

This commit is contained in:
Relintai 2022-01-12 22:15:46 +01:00
parent 2afd6eff45
commit 1c59be4575
28 changed files with 1669 additions and 115 deletions

View File

@ -33,6 +33,18 @@ def get_doc_classes():
"PropSceneInstance",
"PropUtils",
"PropInstanceMerger",
"PropCache",
"PropInstanceJob",
"PropInstanceMerger",
"PropInstancePropJob",
"PropMaterialCache",
"PropMaterialCachePCM",
"PropMesher",
"PropMesherJobStep",
"PropTextureJob",
"PropLight",
]
def get_doc_path():

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GroundClutter" inherits="Resource" version="3.2">
<class name="GroundClutter" inherits="Resource" version="3.5">
<brief_description>
</brief_description>
<description>
@ -7,79 +7,15 @@
<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>
<return type="void" />
<argument index="0" name="packer" type="TexturePacker" />
<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>
<return type="void" />
<argument index="0" name="packer" type="TexturePacker" />
<description>
</description>
</method>

View File

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

119
doc_classes/PropCache.xml Normal file
View File

@ -0,0 +1,119 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropCache" inherits="Object" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="ensure_materials_loaded">
<return type="void" />
<description>
</description>
</method>
<method name="load_resource">
<return type="Resource" />
<argument index="0" name="path" type="String" />
<argument index="1" name="type_hint" type="String" default="&quot;&quot;" />
<description>
</description>
</method>
<method name="material_add">
<return type="void" />
<argument index="0" name="value" type="Material" />
<description>
</description>
</method>
<method name="material_cache_custom_key_get">
<return type="PropMaterialCache" />
<argument index="0" name="key" type="int" />
<description>
</description>
</method>
<method name="material_cache_custom_key_unref">
<return type="void" />
<argument index="0" name="key" type="int" />
<description>
</description>
</method>
<method name="material_cache_get">
<return type="PropMaterialCache" />
<argument index="0" name="prop" type="PropData" />
<description>
</description>
</method>
<method name="material_cache_unref">
<return type="void" />
<argument index="0" name="prop" type="PropData" />
<description>
</description>
</method>
<method name="material_get">
<return type="Material" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="material_get_num" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="material_remove">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="material_set">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="value" type="Material" />
<description>
</description>
</method>
<method name="materials_clear">
<return type="void" />
<description>
</description>
</method>
<method name="materials_load">
<return type="void" />
<description>
</description>
</method>
<method name="tiled_wall_material_cache_get">
<return type="PropMaterialCache" />
<argument index="0" name="twd" type="TiledWallData" />
<description>
</description>
</method>
<method name="tiled_wall_material_cache_unref">
<return type="void" />
<argument index="0" name="twd" type="TiledWallData" />
<description>
</description>
</method>
</methods>
<members>
<member name="background_color" type="Color" setter="set_background_color" getter="get_background_color" default="Color( 0, 0, 0, 1 )">
</member>
<member name="default_prop_material_cache_class" type="String" setter="set_default_prop_material_cache_class" getter="get_default_prop_material_cache_class" default="&quot;PropMaterialCachePCM&quot;">
</member>
<member name="keep_original_atlases" type="bool" setter="set_keep_original_atlases" getter="get_keep_original_atlases" default="false">
</member>
<member name="margin" type="int" setter="set_margin" getter="get_margin" default="0">
</member>
<member name="material_paths" type="PoolStringArray" setter="material_paths_set" getter="material_paths_get" default="PoolStringArray( )">
</member>
<member name="materials" type="Array" setter="materials_set" getter="materials_get" default="[ ]">
</member>
<member name="max_atlas_size" type="int" setter="set_max_atlas_size" getter="get_max_atlas_size" default="1024">
</member>
<member name="texture_flags" type="int" setter="set_texture_flags" getter="get_texture_flags" default="5">
</member>
</members>
<constants>
</constants>
</class>

67
doc_classes/PropData.xml Normal file
View File

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropData" inherits="Resource" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_prop">
<return type="void" />
<argument index="0" name="prop" type="PropDataEntry" />
<description>
</description>
</method>
<method name="add_textures_into">
<return type="void" />
<argument index="0" name="texture_packer" type="TexturePacker" />
<description>
</description>
</method>
<method name="copy_from">
<return type="void" />
<argument index="0" name="prop_data" type="PropData" />
<description>
</description>
</method>
<method name="get_prop" qualifiers="const">
<return type="PropDataEntry" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_prop_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="remove_prop">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="set_prop">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="spell" type="PropDataEntry" />
<description>
</description>
</method>
</methods>
<members>
<member name="is_room" type="bool" setter="set_is_room" getter="get_is_room" default="false">
</member>
<member name="props" type="Array" setter="set_props" getter="get_props" default="[ ]">
</member>
<member name="room_bounds" type="PoolVector3Array" setter="set_room_bounds" getter="get_room_bounds" default="PoolVector3Array( )">
</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,78 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropDataEntry" inherits="Resource" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_add_textures_into" qualifiers="virtual">
<return type="void" />
<argument index="0" name="texture_packer" type="TexturePacker" />
<description>
</description>
</method>
<method name="_processor_evaluate_children" qualifiers="virtual">
<return type="bool" />
<description>
</description>
</method>
<method name="_processor_get_node_for" qualifiers="virtual">
<return type="Node" />
<argument index="0" name="transform" type="Transform" />
<description>
</description>
</method>
<method name="_processor_handles" qualifiers="virtual">
<return type="bool" />
<description>
</description>
</method>
<method name="_processor_process" qualifiers="virtual">
<return type="void" />
<argument index="0" name="prop_data" type="PropData" />
<argument index="1" name="node" type="Node" />
<argument index="2" name="transform" type="Transform" />
<description>
</description>
</method>
<method name="add_textures_into">
<return type="void" />
<argument index="0" name="texture_packer" type="TexturePacker" />
<description>
</description>
</method>
<method name="processor_evaluate_children">
<return type="bool" />
<description>
</description>
</method>
<method name="processor_get_node_for">
<return type="Node" />
<argument index="0" name="prop_data" type="Transform" />
<description>
</description>
</method>
<method name="processor_handles">
<return type="bool" />
<argument index="0" name="node" type="Node" />
<description>
</description>
</method>
<method name="processor_process">
<return type="void" />
<argument index="0" name="prop_data" type="PropData" />
<argument index="1" name="node" type="Node" />
<argument index="2" name="transform" type="Transform" />
<description>
</description>
</method>
</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.5">
<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="0">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropDataPortal" inherits="PropDataEntry" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="is_active" type="bool" setter="set_is_active" getter="get_is_active" default="true">
</member>
<member name="is_two_way" type="bool" setter="set_is_two_way" getter="get_is_two_way" default="true">
</member>
<member name="points" type="PoolVector2Array" setter="set_points" getter="get_points" default="PoolVector2Array( )">
</member>
<member name="portal_margin" type="float" setter="set_portal_margin" getter="get_portal_margin" default="1.0">
</member>
<member name="use_default_margin" type="bool" setter="set_use_default_margin" getter="get_use_default_margin" default="true">
</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.5">
<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.5">
<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>

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropDataTiledWall" inherits="PropDataEntry" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="collision" type="bool" setter="set_collision" getter="get_collision" default="true">
</member>
<member name="data" type="TiledWallData" setter="set_data" getter="get_data">
</member>
<member name="heigth" type="int" setter="set_heigth" getter="get_heigth" default="1">
</member>
<member name="width" type="int" setter="set_width" getter="get_width" default="1">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropESSEntity" inherits="Spatial" version="3.2">
<class name="PropESSEntity" inherits="Spatial" version="3.5">
<brief_description>
</brief_description>
<description>

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropInstance" inherits="Spatial" version="3.2">
<class name="PropInstance" inherits="Spatial" version="3.5">
<brief_description>
</brief_description>
<description>
@ -7,11 +7,64 @@
<tutorials>
</tutorials>
<methods>
<method name="_build" qualifiers="virtual">
<return type="void" />
<description>
</description>
</method>
<method name="_build_finished" qualifiers="virtual">
<return type="void" />
<description>
</description>
</method>
<method name="_init_materials" qualifiers="virtual">
<return type="void" />
<description>
</description>
</method>
<method name="_prop_preprocess" qualifiers="virtual">
<return type="void" />
<argument index="0" name="tarnsform" type="Transform" />
<argument index="1" name="prop_data" type="PropData" />
<description>
</description>
</method>
<method name="build">
<return type="void" />
<description>
</description>
</method>
<method name="build_finished">
<return type="void" />
<description>
</description>
</method>
<method name="init_materials">
<return type="void" />
<description>
</description>
</method>
<method name="prop_preprocess">
<return type="void" />
<argument index="0" name="tarnsform" type="Transform" />
<argument index="1" name="prop" type="PropData" />
<description>
</description>
</method>
<method name="queue_build">
<return type="void" />
<description>
</description>
</method>
</methods>
<members>
<member name="snap_axis" type="Vector3" setter="set_snap_axis" getter="get_snap_axis" default="Vector3( 0, -1, 0 )">
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1">
</member>
<member name="snap_to_mesh" type="bool" setter="set_snap_to_mesh" getter="get_snap_to_mesh" default="false">
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1">
</member>
<member name="material" type="Material" setter="set_material" getter="get_material">
</member>
<member name="prop_data" type="PropData" setter="set_prop_data" getter="get_prop_data">
</member>
</members>
<constants>

View File

@ -0,0 +1,98 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropInstanceJob" inherits="ThreadPoolJob" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_execute_phase" qualifiers="virtual">
<return type="void" />
<description>
</description>
</method>
<method name="_physics_process" qualifiers="virtual">
<return type="void" />
<argument index="0" name="delta" type="float" />
<description>
</description>
</method>
<method name="_process" qualifiers="virtual">
<return type="void" />
<argument index="0" name="delta" type="float" />
<description>
</description>
</method>
<method name="_reset" qualifiers="virtual">
<return type="void" />
<description>
</description>
</method>
<method name="execute_phase">
<return type="void" />
<description>
</description>
</method>
<method name="finished">
<return type="void" />
<description>
</description>
</method>
<method name="get_build_done">
<return type="bool" />
<description>
</description>
</method>
<method name="get_phase">
<return type="int" />
<description>
</description>
</method>
<method name="next_phase">
<return type="void" />
<description>
</description>
</method>
<method name="prop_instance_exit_tree">
<return type="void" />
<description>
</description>
</method>
<method name="reset">
<return type="void" />
<description>
</description>
</method>
<method name="set_build_done">
<return type="void" />
<argument index="0" name="val" type="bool" />
<description>
</description>
</method>
<method name="set_phase">
<return type="void" />
<argument index="0" name="phase" type="int" />
<description>
</description>
</method>
<method name="set_prop">
<return type="void" />
<argument index="0" name="prop" type="PropData" />
<description>
</description>
</method>
<method name="set_prop_instance">
<return type="void" />
<argument index="0" name="instance" type="Node" />
<description>
</description>
</method>
</methods>
<members>
<member name="build_phase_type" type="int" setter="set_build_phase_type" getter="get_build_phase_type" enum="PropInstanceJob.ActiveBuildPhaseType" default="0">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,191 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropInstanceMerger" inherits="PropInstance" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="apply_lod_level">
<return type="void" />
<description>
</description>
</method>
<method name="check_auto_lod">
<return type="void" />
<description>
</description>
</method>
<method name="collider_add">
<return type="int" />
<argument index="0" name="local_transform" type="Transform" />
<argument index="1" name="shape" type="Shape" />
<argument index="2" name="shape_rid" type="RID" />
<argument index="3" name="body" type="RID" />
<argument index="4" name="arg4" type="bool" />
<description>
</description>
</method>
<method name="collider_body_get">
<return type="RID" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="collider_get_num" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="collider_local_transform_get">
<return type="Transform" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="collider_shape_get">
<return type="Shape" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="collider_shape_rid_get">
<return type="RID" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="colliders_clear">
<return type="void" />
<description>
</description>
</method>
<method name="debug_mesh_add_vertices_to">
<return type="void" />
<argument index="0" name="arr" type="PoolVector3Array" />
<description>
</description>
</method>
<method name="debug_mesh_allocate">
<return type="void" />
<description>
</description>
</method>
<method name="debug_mesh_array_clear">
<return type="void" />
<description>
</description>
</method>
<method name="debug_mesh_clear">
<return type="void" />
<description>
</description>
</method>
<method name="debug_mesh_free">
<return type="void" />
<description>
</description>
</method>
<method name="debug_mesh_has">
<return type="bool" />
<description>
</description>
</method>
<method name="debug_mesh_send">
<return type="void" />
<description>
</description>
</method>
<method name="draw_debug_mdr_colliders">
<return type="void" />
<description>
</description>
</method>
<method name="free_colliders">
<return type="void" />
<description>
</description>
</method>
<method name="free_meshes">
<return type="void" />
<description>
</description>
</method>
<method name="material_add">
<return type="void" />
<argument index="0" name="value" type="Material" />
<description>
</description>
</method>
<method name="material_get">
<return type="Material" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="material_get_num" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="materials_clear">
<return type="void" />
<description>
</description>
</method>
<method name="mesh_add">
<return type="void" />
<argument index="0" name="mesh_instance" type="RID" />
<argument index="1" name="mesh" type="RID" />
<description>
</description>
</method>
<method name="mesh_get">
<return type="RID" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="mesh_get_num" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="mesh_instance_get">
<return type="RID" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="meshes_clear">
<return type="void" />
<description>
</description>
</method>
<method name="meshes_create">
<return type="void" />
<argument index="0" name="num" type="int" />
<description>
</description>
</method>
</methods>
<members>
<member name="auto_lod" type="bool" setter="set_auto_lod" getter="get_auto_lod" default="true">
</member>
<member name="first_lod_distance_squared" type="float" setter="set_first_lod_distance_squared" getter="get_first_lod_distance_squared" default="1000.0">
</member>
<member name="job" type="PropInstanceJob" setter="set_job" getter="get_job">
</member>
<member name="lod_level" type="int" setter="set_lod_level" getter="get_lod_level" default="0">
</member>
<member name="lod_reduction_distance_squared" type="float" setter="set_lod_reduction_distance_squared" getter="get_lod_reduction_distance_squared" default="600.0">
</member>
<member name="materials" type="Array" setter="materials_set" getter="materials_get" default="[ ]">
</member>
<member name="meshes" type="Array" setter="meshes_set" getter="meshes_get">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,61 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropInstancePropJob" inherits="PropInstanceJob" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_jobs_step">
<return type="void" />
<argument index="0" name="mesher" type="PropMesherJobStep" />
<description>
</description>
</method>
<method name="add_light">
<return type="void" />
<argument index="0" name="light" type="PropLight" />
<description>
</description>
</method>
<method name="clear_lights">
<return type="void" />
<description>
</description>
</method>
<method name="get_jobs_step" qualifiers="const">
<return type="PropMesherJobStep" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_jobs_step_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="remove_jobs_step">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="set_jobs_step">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="mesher" type="PropMesherJobStep" />
<description>
</description>
</method>
</methods>
<members>
<member name="build_phase_type" type="int" setter="set_build_phase_type" getter="get_build_phase_type" overrides="PropInstanceJob" enum="PropInstanceJob.ActiveBuildPhaseType" default="2" />
<member name="material_cache" type="PropMaterialCache" setter="set_material_cache" getter="get_material_cache">
</member>
<member name="prop_mesher" type="PropMesher" setter="set_prop_mesher" getter="get_prop_mesher">
</member>
</members>
<constants>
</constants>
</class>

21
doc_classes/PropLight.xml Normal file
View File

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropLight" inherits="Reference" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="color" type="Color" setter="set_color" getter="get_color" default="Color( 0, 0, 0, 1 )">
</member>
<member name="size" type="float" setter="set_size" getter="get_size" default="0.0">
</member>
<member name="world_position" type="Vector3" setter="set_position" getter="get_position" default="Vector3( 0, 0, 0 )">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,168 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropMaterialCache" inherits="Resource" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_setup_material_albedo" qualifiers="virtual">
<return type="void" />
<argument index="0" name="texture" type="Texture" />
<description>
</description>
</method>
<method name="dec_ref_count">
<return type="void" />
<description>
</description>
</method>
<method name="inc_ref_count">
<return type="void" />
<description>
</description>
</method>
<method name="material_add">
<return type="void" />
<argument index="0" name="value" type="Material" />
<description>
</description>
</method>
<method name="material_get">
<return type="Material" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="material_get_num" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="material_lod_get">
<return type="Material" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="material_remove">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="material_set">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="value" type="Material" />
<description>
</description>
</method>
<method name="materials_clear">
<return type="void" />
<description>
</description>
</method>
<method name="mutex_lock">
<return type="void" />
<description>
</description>
</method>
<method name="mutex_locked">
<return type="bool" />
<description>
</description>
</method>
<method name="mutex_unlock">
<return type="void" />
<description>
</description>
</method>
<method name="prop_add_textures">
<return type="void" />
<argument index="0" name="prop" type="PropData" />
<description>
</description>
</method>
<method name="prop_remove_textures">
<return type="void" />
<argument index="0" name="prop" type="PropData" />
<description>
</description>
</method>
<method name="refresh_rects">
<return type="void" />
<description>
</description>
</method>
<method name="setup_material_albedo">
<return type="void" />
<argument index="0" name="texture" type="Texture" />
<description>
</description>
</method>
<method name="texture_add">
<return type="void" />
<argument index="0" name="texture" type="Texture" />
<description>
</description>
</method>
<method name="texture_count">
<return type="int" />
<description>
</description>
</method>
<method name="texture_get">
<return type="Texture" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="texture_get_atlas">
<return type="AtlasTexture" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="texture_get_atlas_tex">
<return type="AtlasTexture" />
<argument index="0" name="index" type="Texture" />
<description>
</description>
</method>
<method name="texture_get_uv_rect">
<return type="Rect2" />
<argument index="0" name="texture" type="Texture" />
<description>
</description>
</method>
<method name="texture_remove">
<return type="void" />
<argument index="0" name="texture" type="Texture" />
<description>
</description>
</method>
<method name="texture_remove_index">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="textures_clear">
<return type="void" />
<description>
</description>
</method>
</methods>
<members>
<member name="initialized" type="bool" setter="set_initialized" getter="get_initialized" default="false">
</member>
<member name="mat_ref_count" type="int" setter="set_ref_count" getter="get_ref_count" default="0">
</member>
<member name="materials" type="Array" setter="materials_set" getter="materials_get" default="[ ]">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropMaterialCachePCM" inherits="PropMaterialCache" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="background_color" type="Color" setter="set_background_color" getter="get_background_color" default="Color( 0, 0, 0, 1 )">
</member>
<member name="keep_original_atlases" type="bool" setter="set_keep_original_atlases" getter="get_keep_original_atlases" default="false">
</member>
<member name="margin" type="int" setter="set_margin" getter="get_margin" default="0">
</member>
<member name="max_atlas_size" type="int" setter="set_max_atlas_size" getter="get_max_atlas_size" default="1024">
</member>
<member name="texture_flags" type="int" setter="set_texture_flags" getter="get_texture_flags" default="5">
</member>
</members>
<constants>
</constants>
</class>

View File

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

326
doc_classes/PropMesher.xml Normal file
View File

@ -0,0 +1,326 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropMesher" inherits="Reference" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_add_mesher" qualifiers="virtual">
<return type="void" />
<argument index="0" name="mesher" type="PropMesher" />
<description>
</description>
</method>
<method name="add_color">
<return type="void" />
<argument index="0" name="color" type="Color" />
<description>
</description>
</method>
<method name="add_indices">
<return type="void" />
<argument index="0" name="indice" type="int" />
<description>
</description>
</method>
<method name="add_light">
<return type="void" />
<argument index="0" name="light" type="PropLight" />
<description>
</description>
</method>
<method name="add_mesh_data_resource">
<return type="void" />
<argument index="0" name="mesh" type="MeshDataResource" />
<argument index="1" name="position" type="Vector3" default="Rect2( 0, 0, 1, 1 )" />
<argument index="2" name="rotation" type="Vector3" default="Vector3( 1, 1, 1 )" />
<argument index="3" name="scale" type="Vector3" default="Vector3( 0, 0, 0 )" />
<argument index="4" name="uv_rect" type="Rect2" default="Vector3( 0, 0, 0 )" />
<description>
</description>
</method>
<method name="add_mesh_data_resource_transform">
<return type="void" />
<argument index="0" name="mesh" type="MeshDataResource" />
<argument index="1" name="transform" type="Transform" />
<argument index="2" name="uv_rect" type="Rect2" default="Rect2( 0, 0, 1, 1 )" />
<description>
</description>
</method>
<method name="add_mesh_data_resource_transform_colored">
<return type="void" />
<argument index="0" name="mesh" type="MeshDataResource" />
<argument index="1" name="transform" type="Transform" />
<argument index="2" name="colors" type="PoolColorArray" />
<argument index="3" name="uv_rect" type="Rect2" default="Rect2( 0, 0, 1, 1 )" />
<description>
</description>
</method>
<method name="add_mesher">
<return type="void" />
<argument index="0" name="mesher" type="PropMesher" />
<description>
</description>
</method>
<method name="add_normal">
<return type="void" />
<argument index="0" name="normal" type="Vector3" />
<description>
</description>
</method>
<method name="add_tiled_wall_mesh_rect_simple">
<return type="void" />
<argument index="0" name="x" type="int" />
<argument index="1" name="y" type="int" />
<argument index="2" name="transform" type="Transform" />
<argument index="3" name="texture_rect" type="Rect2" />
<description>
</description>
</method>
<method name="add_tiled_wall_simple">
<return type="void" />
<argument index="0" name="width" type="int" />
<argument index="1" name="height" type="int" />
<argument index="2" name="transform" type="Transform" />
<argument index="3" name="tiled_wall_data" type="TiledWallData" />
<argument index="4" name="cache" type="PropMaterialCache" />
<description>
</description>
</method>
<method name="add_uv">
<return type="void" />
<argument index="0" name="uv" type="Vector2" />
<description>
</description>
</method>
<method name="add_uv2">
<return type="void" />
<argument index="0" name="uv" type="Vector2" />
<description>
</description>
</method>
<method name="add_vertex">
<return type="void" />
<argument index="0" name="vertex" type="Vector3" />
<description>
</description>
</method>
<method name="bake_colors">
<return type="void" />
<description>
</description>
</method>
<method name="build_collider" qualifiers="const">
<return type="PoolVector3Array" />
<description>
</description>
</method>
<method name="build_mesh">
<return type="Array" />
<description>
</description>
</method>
<method name="build_mesh_into">
<return type="void" />
<argument index="0" name="mesh_rid" type="RID" />
<description>
</description>
</method>
<method name="clear_lights">
<return type="void" />
<description>
</description>
</method>
<method name="generate_ao">
<return type="void" />
<description>
</description>
</method>
<method name="generate_normals">
<return type="void" />
<argument index="0" name="flip" type="bool" default="false" />
<description>
</description>
</method>
<method name="get_color" qualifiers="const">
<return type="Color" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="get_colors" qualifiers="const">
<return type="PoolColorArray" />
<description>
</description>
</method>
<method name="get_index" qualifiers="const">
<return type="int" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="get_indices" qualifiers="const">
<return type="PoolIntArray" />
<description>
</description>
</method>
<method name="get_indices_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="get_normal" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="get_normals" qualifiers="const">
<return type="PoolVector3Array" />
<description>
</description>
</method>
<method name="get_random_ao">
<return type="float" />
<argument index="0" name="position" type="Vector3" />
<description>
</description>
</method>
<method name="get_uv" qualifiers="const">
<return type="Vector2" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="get_uv2" qualifiers="const">
<return type="Vector2" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="get_uv2s" qualifiers="const">
<return type="PoolVector2Array" />
<description>
</description>
</method>
<method name="get_uvs" qualifiers="const">
<return type="PoolVector2Array" />
<description>
</description>
</method>
<method name="get_vertex" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="get_vertex_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="get_vertices" qualifiers="const">
<return type="PoolVector3Array" />
<description>
</description>
</method>
<method name="remove_doubles">
<return type="void" />
<description>
</description>
</method>
<method name="remove_doubles_hashed">
<return type="void" />
<description>
</description>
</method>
<method name="remove_index">
<return type="void" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="remove_vertex">
<return type="void" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="reset">
<return type="void" />
<description>
</description>
</method>
<method name="set_colors">
<return type="void" />
<argument index="0" name="values" type="PoolColorArray" />
<description>
</description>
</method>
<method name="set_indices">
<return type="void" />
<argument index="0" name="values" type="PoolIntArray" />
<description>
</description>
</method>
<method name="set_normals">
<return type="void" />
<argument index="0" name="values" type="PoolVector3Array" />
<description>
</description>
</method>
<method name="set_uv2s">
<return type="void" />
<argument index="0" name="values" type="PoolVector2Array" />
<description>
</description>
</method>
<method name="set_uvs">
<return type="void" />
<argument index="0" name="values" type="PoolVector2Array" />
<description>
</description>
</method>
<method name="set_vertices">
<return type="void" />
<argument index="0" name="values" type="PoolVector3Array" />
<description>
</description>
</method>
<method name="transform_uv" qualifiers="const">
<return type="Vector2" />
<argument index="0" name="uv" type="Vector2" />
<argument index="1" name="rect" type="Rect2" />
<description>
</description>
</method>
</methods>
<members>
<member name="ao_strength" type="float" setter="set_ao_strength" getter="get_ao_strength" default="0.25">
</member>
<member name="base_light_value" type="float" setter="set_base_light_value" getter="get_base_light_value" default="0.5">
</member>
<member name="build_flags" type="int" setter="set_build_flags" getter="get_build_flags" default="0">
</member>
<member name="channel_index_isolevel" type="int" setter="set_channel_index_isolevel" getter="get_channel_index_isolevel" default="0">
</member>
<member name="channel_index_type" type="int" setter="set_channel_index_type" getter="get_channel_index_type" default="0">
</member>
<member name="format" type="int" setter="set_format" getter="get_format" default="18">
</member>
<member name="material" type="Material" setter="set_material" getter="get_material">
</member>
<member name="mesher_index" type="int" setter="set_mesher_index" getter="get_mesher_index" default="0">
</member>
<member name="texture_scale" type="int" setter="set_texture_scale" getter="get_texture_scale" default="1">
</member>
<member name="uv_margin" type="Rect2" setter="set_uv_margin" getter="get_uv_margin" default="Rect2( 0, 0, 1, 1 )">
</member>
<member name="voxel_scale" type="float" setter="set_voxel_scale" getter="get_voxel_scale" default="1.0">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,41 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropMesherJobStep" inherits="Reference" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="fqms" type="FastQuadraticMeshSimplifier" setter="set_fqms" getter="get_fqms">
</member>
<member name="job_type" type="int" setter="set_job_type" getter="get_job_type" enum="PropMesherJobStep.PropMesherJobStepType" default="0">
</member>
<member name="lod_index" type="int" setter="set_lod_index" getter="get_lod_index" default="0">
</member>
<member name="simplification_agressiveness" type="float" setter="set_simplification_agressiveness" getter="get_simplification_agressiveness" default="7.0">
</member>
<member name="simplification_step_ratio" type="float" setter="set_simplification_step_ratio" getter="get_simplification_step_ratio" default="0.8">
</member>
<member name="simplification_steps" type="int" setter="set_simplification_steps" getter="get_simplification_steps" default="2">
</member>
</members>
<constants>
<constant name="TYPE_NORMAL" value="0" enum="PropMesherJobStepType">
</constant>
<constant name="TYPE_NORMAL_LOD" value="1" enum="PropMesherJobStepType">
</constant>
<constant name="TYPE_DROP_UV2" value="2" enum="PropMesherJobStepType">
</constant>
<constant name="TYPE_MERGE_VERTS" value="3" enum="PropMesherJobStepType">
</constant>
<constant name="TYPE_BAKE_TEXTURE" value="4" enum="PropMesherJobStepType">
</constant>
<constant name="TYPE_SIMPLIFY_MESH" value="5" enum="PropMesherJobStepType">
</constant>
<constant name="TYPE_OTHER" value="6" enum="PropMesherJobStepType">
</constant>
</constants>
</class>

View File

@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropSceneInstance" inherits="Spatial" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="build">
<return type="void" />
<description>
</description>
</method>
</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="false">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropMeshDataInstance" inherits="Spatial" version="3.2">
<class name="PropTextureJob" inherits="ThreadPoolJob" version="3.5">
<brief_description>
</brief_description>
<description>
@ -8,6 +8,10 @@
</tutorials>
<methods>
</methods>
<members>
<member name="merger" type="TexturePacker" setter="set_merger" getter="get_merger">
</member>
</members>
<constants>
</constants>
</class>

49
doc_classes/PropUtils.xml Normal file
View File

@ -0,0 +1,49 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropUtils" inherits="Object" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_processor">
<return type="int" />
<argument index="0" name="processor" type="PropDataEntry" />
<description>
</description>
</method>
<method name="convert_tree">
<return type="PropData" />
<argument index="0" name="root" type="Node" />
<description>
</description>
</method>
<method name="get_processor">
<return type="PropDataEntry" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_processor_count">
<return type="int" />
<description>
</description>
</method>
<method name="remove_processor">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="swap_processors">
<return type="void" />
<argument index="0" name="index1" type="int" />
<argument index="1" name="index2" type="int" />
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

View File

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

57
doc_classes/TiledWall.xml Normal file
View File

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="TiledWall" inherits="GeometryInstance" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="clear_mesh">
<return type="void" />
<description>
</description>
</method>
<method name="create_colliders">
<return type="void" />
<description>
</description>
</method>
<method name="free_colliders">
<return type="void" />
<description>
</description>
</method>
<method name="free_mesh">
<return type="void" />
<description>
</description>
</method>
<method name="generate_mesh">
<return type="void" />
<description>
</description>
</method>
<method name="refresh">
<return type="void" />
<description>
</description>
</method>
</methods>
<members>
<member name="collision" type="bool" setter="set_collision" getter="get_collision" default="true">
</member>
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1">
</member>
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1">
</member>
<member name="data" type="TiledWallData" setter="set_data" getter="get_data">
</member>
<member name="heigth" type="int" setter="set_heigth" getter="get_heigth" default="1">
</member>
<member name="width" type="int" setter="set_width" getter="get_width" default="1">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,146 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="TiledWallData" inherits="Resource" version="3.5">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_setup_cache" qualifiers="virtual">
<return type="void" />
<argument index="0" name="cache" type="PropMaterialCache" />
<description>
</description>
</method>
<method name="add_texture">
<return type="void" />
<argument index="0" name="texture" type="Texture" />
<description>
</description>
</method>
<method name="add_textures_into">
<return type="void" />
<argument index="0" name="texture_packer" type="TexturePacker" />
<description>
</description>
</method>
<method name="add_tflavour_exture">
<return type="void" />
<argument index="0" name="texture" type="Texture" />
<description>
</description>
</method>
<method name="copy_from">
<return type="void" />
<argument index="0" name="prop_data" type="TiledWallData" />
<description>
</description>
</method>
<method name="get_flavour_texture" qualifiers="const">
<return type="Texture" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_flavour_texture_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="get_texture" qualifiers="const">
<return type="Texture" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_texture_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="material_add">
<return type="void" />
<argument index="0" name="value" type="Material" />
<description>
</description>
</method>
<method name="material_get_num" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="material_remove">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="material_set">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="value" type="Material" />
<description>
</description>
</method>
<method name="materials_clear">
<return type="void" />
<description>
</description>
</method>
<method name="remove_flavour_texture">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="remove_texture">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="set_flavour_texture">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="texture" type="Texture" />
<description>
</description>
</method>
<method name="set_texture">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="texture" type="Texture" />
<description>
</description>
</method>
<method name="setup_cache">
<return type="void" />
<argument index="0" name="cache" type="PropMaterialCache" />
<description>
</description>
</method>
</methods>
<members>
<member name="flavour_chance" type="float" setter="set_flavour_chance" getter="get_flavour_chance" default="0.15">
</member>
<member name="flavour_textures" type="Array" setter="set_flavour_textures" getter="get_flavour_textures" default="[ ]">
</member>
<member name="materials" type="Array" setter="materials_set" getter="materials_get" default="[ ]">
</member>
<member name="textures" type="Array" setter="set_textures" getter="get_textures" default="[ ]">
</member>
<member name="tiling_type" type="int" setter="set_tiling_type" getter="get_tiling_type" enum="TiledWallData.TiledWallTilingType" default="0">
</member>
</members>
<constants>
<constant name="TILED_WALL_TILING_TYPE_NONE" value="0" enum="TiledWallTilingType">
</constant>
<constant name="TILED_WALL_TILING_TYPE_HORIZONTAL" value="1" enum="TiledWallTilingType">
</constant>
<constant name="TILED_WALL_TILING_TYPE_VERTICAL" value="2" enum="TiledWallTilingType">
</constant>
<constant name="TILED_WALL_TILING_TYPE_BOTH" value="3" enum="TiledWallTilingType">
</constant>
</constants>
</class>