Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-02-18 13:44:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Re-extracted class docs.

Browse Source
This commit is contained in:
Relintai 2022-10-09 12:43:55 +02:00
parent 10437e2f01
commit 54643bc1fc
13 changed files with 137 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/classes/EditorPlugin.xml
View File

@ -46,6 +46,22 @@
When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_docks] and free it with [method Node.queue_free].
</description>
</method>
<method name="add_convert_menu_item">
<return type="void" />
<argument index="0" name="name" type="String" />
<argument index="1" name="handler" type="Object" />
<argument index="2" name="callback" type="String" />
<argument index="3" name="ud" type="Variant" default="null" />
<description>
</description>
</method>
<method name="add_convert_submenu_item">
<return type="void" />
<argument index="0" name="name" type="String" />
<argument index="1" name="submenu" type="Object" />
<description>
</description>
</method>
<method name="add_custom_type">
<return type="void" />
<argument index="0" name="type" type="String" />
@ -408,6 +424,12 @@
Removes the control from the dock. You have to manually [method Node.queue_free] the control.
</description>
</method>
<method name="remove_convert_menu_item">
<return type="void" />
<argument index="0" name="name" type="String" />
<description>
</description>
</method>
<method name="remove_custom_type">
<return type="void" />
<argument index="0" name="type" type="String" />

33
doc/classes/EditorSettings.xml
View File

@ -274,10 +274,6 @@
<member name="editors/3d/grid_yz_plane" type="bool" setter="" getter="">
If [code]true[/code], render the grid on an YZ plane. This can be useful for 3D side-scrolling games.
</member>
<member name="editors/3d/lightmap_baking_number_of_cpu_threads" type="int" setter="" getter="">
The number of CPU threads to use for baking lightmaps with [BakedLightmap]. A value of [code]0[/code] will use all CPU logical cores, while positive values will set the maximum number of CPU threads that can be used when baking lightmaps. Negative values will use all CPU cores [i]minus[/i] the amount specified in the negative number.
Using less CPU cores than the total amount of cores available will slow down lightmap baking, but will allow other tasks on the PC to be more reactive while lightmaps are baking.
</member>
<member name="editors/3d/navigation/emulate_3_button_mouse" type="bool" setter="" getter="">
If [code]true[/code], enables 3-button mouse emulation mode. This is useful on laptops when using a trackpad.
When 3-button mouse emulation mode is enabled, the pan, zoom and orbit modifiers can always be used in the 3D editor viewport, even when not holding down any mouse button.
@ -343,15 +339,6 @@
<member name="editors/3d/selection_box_color" type="Color" setter="" getter="">
The color to use for the selection box that surrounds selected nodes in the 3D editor viewport. The color's alpha channel influences the selection box's opacity.
</member>
<member name="editors/3d_gizmos/gizmo_colors/instanced" type="Color" setter="" getter="">
The color override to use for 3D editor gizmos if the [Spatial] in question is part of an instanced scene file (from the perspective of the current scene).
</member>
<member name="editors/3d_gizmos/gizmo_colors/joint" type="Color" setter="" getter="">
The 3D editor gizmo color for [Joint]s and [PhysicalBone]s.
</member>
<member name="editors/3d_gizmos/gizmo_colors/shape" type="Color" setter="" getter="">
The 3D editor gizmo color for [CollisionShape]s, [VehicleWheel]s, [RayCast]s and [SpringArm]s.
</member>
<member name="editors/animation/autorename_animation_tracks" type="bool" setter="" getter="">
If [code]true[/code], automatically updates animation tracks' target paths when renaming or reparenting nodes in the Scene tree dock.
</member>
@ -370,12 +357,6 @@
<member name="editors/animation/onion_layers_past_color" type="Color" setter="" getter="">
The modulate color to use for "past" frames displayed in the animation editor's onion skinning feature.
</member>
<member name="editors/grid_map/pick_distance" type="float" setter="" getter="">
The maximum distance at which tiles can be placed on a GridMap, relative to the camera position (in 3D units).
</member>
<member name="editors/grid_map/preview_size" type="int" setter="" getter="">
The size of tiles in the GridMap editor sidebar (in pixels).
</member>
<member name="editors/poly_editor/point_grab_radius" type="int" setter="" getter="">
The radius of each point's clickable area in 2D and 3D polygon editors (in pixels). Increase this value if you are having trouble selecting points in polygon editors. However, increasing this value may make it more difficult to select points located close to each other.
</member>
@ -527,14 +508,6 @@
<member name="network/debug/remote_port" type="int" setter="" getter="">
The port to listen to when starting the remote debugger. Godot will try to use port numbers above the configured number if the configured number is already taken by another application.
</member>
<member name="network/http_proxy/host" type="String" setter="" getter="">
The host to use to contact the HTTP and HTTPS proxy in the editor (for the asset library and export template downloads). See also [member network/http_proxy/port].
[b]Note:[/b] Godot currently doesn't automatically use system proxy settings, so you have to enter them manually here if needed.
</member>
<member name="network/http_proxy/port" type="int" setter="" getter="">
The port number to use to contact the HTTP and HTTPS proxy in the editor (for the asset library and export template downloads). See also [member network/http_proxy/host].
[b]Note:[/b] Godot currently doesn't automatically use system proxy settings, so you have to enter them manually here if needed.
</member>
<member name="network/ssl/editor_ssl_certificates" type="String" setter="" getter="">
The SSL certificate bundle to use for HTTP requests made within the editor (e.g. from the AssetLib tab). If left empty, the [url=https://github.com/godotengine/godot/blob/master/thirdparty/certs/ca-certificates.crt]included Mozilla certificate bundle[/url] will be used.
</member>
@ -634,12 +607,6 @@
<member name="text_editor/cursor/scroll_past_end_of_file" type="bool" setter="" getter="">
If [code]true[/code], allows scrolling past the end of the file in the script editor.
</member>
<member name="text_editor/files/auto_reload_and_parse_scripts_on_save" type="bool" setter="" getter="">
If [code]true[/code], automatically reloads and parses scripts in the editor when they are saved. This is mainly relevant for [code]tool[/code] scripts which run in the editor.
</member>
<member name="text_editor/files/auto_reload_scripts_on_external_change" type="bool" setter="" getter="">
If [code]true[/code], automatically reloads scripts in the editor when they have been modified and saved by external editors.
</member>
<member name="text_editor/files/autosave_interval_secs" type="int" setter="" getter="">
If set to a value greater than [code]0[/code], automatically saves the current script following the specified interval (in seconds). This can be used to prevent data loss if the editor crashes.
</member>

2
doc/classes/ProjectSettings.xml
View File

@ -1910,6 +1910,8 @@
</member>
<member name="thread_pool/max_work_per_frame_percent" type="int" setter="" getter="" default="25">
</member>
<member name="thread_pool/target_fps" type="int" setter="" getter="" default="60">
</member>
<member name="thread_pool/thread_count" type="int" setter="" getter="" default="-1">
</member>
<member name="thread_pool/thread_fallback_count" type="int" setter="" getter="" default="4">

2
doc/classes/RenderingServer.xml
View File

@ -1910,7 +1910,7 @@
<method name="multimesh_set_physics_interpolation_quality">
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="quality" type="int" enum="VisualServer.MultimeshPhysicsInterpolationQuality" />
<argument index="1" name="quality" type="int" enum="RenderingServer.MultimeshPhysicsInterpolationQuality" />
<description>
Sets the physics interpolation quality for the [MultiMesh].
A value of [code]0[/code] gives fast but low quality interpolation, a value of [code]1[/code] gives slower but higher quality interpolation.

9
doc/classes/ThreadPool.xml
View File

@ -13,6 +13,11 @@
<description>
</description>
</method>
<method name="apply_max_work_per_frame_percent">
<return type="void" />
<description>
</description>
</method>
<method name="cancel_job">
<return type="void" />
<argument index="0" name="job" type="ThreadPoolJob" />
@ -52,7 +57,9 @@
</member>
<member name="max_work_per_frame_percent" type="float" setter="set_max_work_per_frame_percent" getter="get_max_work_per_frame_percent" default="25.0">
</member>
<member name="thread_count" type="int" setter="set_thread_count" getter="get_thread_count" default="5">
<member name="target_fps" type="float" setter="set_target_fps" getter="get_target_fps" default="60.0">
</member>
<member name="thread_count" type="int" setter="set_thread_count" getter="get_thread_count" default="3">
</member>
<member name="thread_fallback_count" type="int" setter="set_thread_fallback_count" getter="get_thread_fallback_count" default="4">
</member>

2
editor_modules/gltf/doc_classes/GLTFTextureSampler.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFTextureSampler" inherits="Resource" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<class name="GLTFTextureSampler" inherits="Resource" version="3.8">
<brief_description>
Represents a GLTF texture sampler
</brief_description>

2
modules/broken_seals_module/doc_classes/BiomeTerrarinGenerator.xml → modules/broken_seals_module/doc_classes/BiomeTerrainGenerator.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BiomeTerrarinGenerator" inherits="Reference" version="3.8">
<class name="BiomeTerrainGenerator" inherits="Reference" version="3.8">
<brief_description>
</brief_description>
<description>

12
modules/entity_spell_system/doc_classes/ESSMaterialCache.xml
View File

@ -84,6 +84,18 @@
<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>

2
modules/gridmap/doc_classes/GridMap.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GridMap" inherits="Spatial" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<class name="GridMap" inherits="Spatial" version="3.8">
<brief_description>
Node for 3D tile-based maps.
</brief_description>

2
modules/gridmap/doc_classes/MeshLibrary.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="MeshLibrary" inherits="Resource" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<class name="MeshLibrary" inherits="Resource" version="3.8">
<brief_description>
Library of meshes.
</brief_description>

38
modules/props/doc_classes/GroundClutter.xml
View File

@ -7,18 +7,56 @@
<tutorials>
</tutorials>
<methods>
<method name="_add_meshes_to" qualifiers="virtual">
<return type="void" />
<argument index="0" name="mesher" type="VoxelMesher" />
<argument index="1" name="chunk" type="VoxelChunk" />
<argument index="2" name="x" type="int" />
<argument index="3" name="y" type="int" />
<argument index="4" name="z" type="int" />
<description>
</description>
</method>
<method name="_add_textures_to" qualifiers="virtual">
<return type="void" />
<argument index="0" name="packer" type="TexturePacker" />
<description>
</description>
</method>
<method name="_should_spawn" qualifiers="virtual">
<return type="bool" />
<argument index="0" name="chunk" type="VoxelChunk" />
<argument index="1" name="x" type="int" />
<argument index="2" name="y" type="int" />
<argument index="3" name="z" type="int" />
<description>
</description>
</method>
<method name="add_meshes_to">
<return type="void" />
<argument index="0" name="mesher" type="VoxelMesher" />
<argument index="1" name="chunk" type="VoxelChunk" />
<argument index="2" name="x" type="int" />
<argument index="3" name="y" type="int" />
<argument index="4" name="z" type="int" />
<description>
</description>
</method>
<method name="add_textures_to">
<return type="void" />
<argument index="0" name="packer" type="TexturePacker" />
<description>
</description>
</method>
<method name="should_spawn">
<return type="bool" />
<argument index="0" name="chunk" type="VoxelChunk" />
<argument index="1" name="x" type="int" />
<argument index="2" name="y" type="int" />
<argument index="3" name="z" type="int" />
<description>
</description>
</method>
</methods>
<constants>
</constants>

12
modules/props/doc_classes/TiledWallData.xml
View File

@ -13,6 +13,12 @@
<description>
</description>
</method>
<method name="_setup_ess_cache" qualifiers="virtual">
<return type="void" />
<argument index="0" name="cache" type="ESSMaterialCache" />
<description>
</description>
</method>
<method name="add_flavour_tile">
<return type="void" />
<argument index="0" name="texture" type="Texture" />
@ -194,6 +200,12 @@
<description>
</description>
</method>
<method name="setup_ess_cache">
<return type="void" />
<argument index="0" name="cache" type="ESSMaterialCache" />
<description>
</description>
</method>
</methods>
<members>
<member name="collider_type" type="int" setter="set_collider_type" getter="get_collider_type" enum="TiledWallData.TiledWallColliderType" default="1">

38
modules/props_2d/doc_classes/GroundClutter2D.xml
View File

@ -7,18 +7,56 @@
<tutorials>
</tutorials>
<methods>
<method name="_add_meshes_to" qualifiers="virtual">
<return type="void" />
<argument index="0" name="mesher" type="VoxelMesher" />
<argument index="1" name="chunk" type="VoxelChunk" />
<argument index="2" name="x" type="int" />
<argument index="3" name="y" type="int" />
<argument index="4" name="z" type="int" />
<description>
</description>
</method>
<method name="_add_textures_to" qualifiers="virtual">
<return type="void" />
<argument index="0" name="packer" type="TexturePacker" />
<description>
</description>
</method>
<method name="_should_spawn" qualifiers="virtual">
<return type="bool" />
<argument index="0" name="chunk" type="VoxelChunk" />
<argument index="1" name="x" type="int" />
<argument index="2" name="y" type="int" />
<argument index="3" name="z" type="int" />
<description>
</description>
</method>
<method name="add_meshes_to">
<return type="void" />
<argument index="0" name="mesher" type="VoxelMesher" />
<argument index="1" name="chunk" type="VoxelChunk" />
<argument index="2" name="x" type="int" />
<argument index="3" name="y" type="int" />
<argument index="4" name="z" type="int" />
<description>
</description>
</method>
<method name="add_textures_to">
<return type="void" />
<argument index="0" name="packer" type="TexturePacker" />
<description>
</description>
</method>
<method name="should_spawn">
<return type="bool" />
<argument index="0" name="chunk" type="VoxelChunk" />
<argument index="1" name="x" type="int" />
<argument index="2" name="y" type="int" />
<argument index="3" name="z" type="int" />
<description>
</description>
</method>
</methods>
<constants>
</constants>