Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2024-12-27 06:07:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Re-extracted class docs. Also fixed smaller issues.

Browse Source
This commit is contained in:
Relintai 2023-09-10 08:42:24 +02:00
parent b572af1287
commit 70db9caf20
15 changed files with 60 additions and 140 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/@GlobalScope.xml
View File

@ -102,14 +102,14 @@
<member name="ResourceSaver" type="ResourceSaver" setter="" getter=""> <member name="ResourceSaver" type="ResourceSaver" setter="" getter="">
The [ResourceSaver] singleton. The [ResourceSaver] singleton.
</member> </member>
<member name="ScriptServer" type="ScriptServer" setter="" getter="">
The [ScriptServer] singleton.
</member>
<member name="ThreadPool" type="ThreadPool" setter="" getter=""> <member name="ThreadPool" type="ThreadPool" setter="" getter="">
</member> </member>
<member name="Time" type="Time" setter="" getter=""> <member name="Time" type="Time" setter="" getter="">
The [Time] singleton. The [Time] singleton.
</member> </member>
<member name="ScriptServer" type="ScriptServer" setter="" getter="">
The [ScriptServer] singleton.
</member>
<member name="TranslationServer" type="TranslationServer" setter="" getter=""> <member name="TranslationServer" type="TranslationServer" setter="" getter="">
The [TranslationServer] singleton. The [TranslationServer] singleton.
</member> </member>

17
doc/classes/CanvasItem.xml
View File

@ -352,12 +352,6 @@
Returns [code]true[/code] if local transform notifications are communicated to children. Returns [code]true[/code] if local transform notifications are communicated to children.
</description> </description>
</method> </method>
<method name="is_set_as_toplevel" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] if the node is set as top-level. See [method set_as_toplevel].
</description>
</method>
<method name="is_transform_notification_enabled" qualifiers="const"> <method name="is_transform_notification_enabled" qualifiers="const">
<return type="bool" /> <return type="bool" />
<description> <description>
@ -384,13 +378,6 @@
Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space. Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space.
</description> </description>
</method> </method>
<method name="set_as_toplevel">
<return type="void" />
<argument index="0" name="enable" type="bool" />
<description>
If [code]enable[/code] is [code]true[/code], this [CanvasItem] will [i]not[/i] inherit its transform from parent [CanvasItem]s. Its draw order will also be changed to make it draw on top of other [CanvasItem]s that are not set as top-level. The [CanvasItem] will effectively act as if it was placed as a child of a bare [Node]. See also [method is_set_as_toplevel].
</description>
</method>
<method name="set_notify_local_transform"> <method name="set_notify_local_transform">
<return type="void" /> <return type="void" />
<argument index="0" name="enable" type="bool" /> <argument index="0" name="enable" type="bool" />
@ -434,8 +421,8 @@
<member name="show_behind_parent" type="bool" setter="set_draw_behind_parent" getter="is_draw_behind_parent_enabled" default="false"> <member name="show_behind_parent" type="bool" setter="set_draw_behind_parent" getter="is_draw_behind_parent_enabled" default="false">
If [code]true[/code], the object draws behind its parent. If [code]true[/code], the object draws behind its parent.
</member> </member>
<member name="show_on_top" type="bool" setter="_set_on_top" getter="_is_on_top"> <member name="toplevel" type="bool" setter="set_as_toplevel" getter="is_set_as_toplevel" default="false">
If [code]true[/code], the object draws on top of its parent. If [code]true[/code], this [CanvasItem] will [i]not[/i] inherit its transform from parent [CanvasItem]s. Its draw order will also be changed to make it draw on top of other [CanvasItem]s that do not have [member top_level] set to [code]true[/code]. The [CanvasItem] will effectively act as if it was placed as a child of a bare [Node].
</member> </member>
<member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material" default="false"> <member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material" default="false">
If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material. If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material.

7
doc/classes/Control.xml
View File

@ -440,6 +440,11 @@
Best used with [constant Node.NOTIFICATION_DRAG_END]. Best used with [constant Node.NOTIFICATION_DRAG_END].
</description> </description>
</method> </method>
<method name="is_focus_owner_in_shortcut_context" qualifiers="const">
<return type="bool" />
<description>
</description>
</method>
<method name="minimum_size_changed"> <method name="minimum_size_changed">
<return type="void" /> <return type="void" />
<description> <description>
@ -777,7 +782,7 @@
The [Node] which must be a parent of the focused [Control] for the shortcut to be activated. If [code]null[/code], the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused. The [Node] which must be a parent of the focused [Control] for the shortcut to be activated. If [code]null[/code], the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused.
Setting this will override the node [member shortcut_context_path] is pointing. You can get rid of this override by setting this back to null. Setting this will override the node [member shortcut_context_path] is pointing. You can get rid of this override by setting this back to null.
</member> </member>
<member name="shortcut_context_path" type="NodePath" setter="set_shortcut_context_path" getter="get_shortcut_context_path"> <member name="shortcut_context_path" type="NodePath" setter="set_shortcut_context_path" getter="get_shortcut_context_path" default="NodePath(&quot;&quot;)">
The [NodePath] for the [Node] which must be a parent of the focused [Control] for the shortcut to be activated. If [code]null[/code], the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused. The [NodePath] for the [Node] which must be a parent of the focused [Control] for the shortcut to be activated. If [code]null[/code], the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused.
[member shortcut_context] can be used to temporarily override this when needed. [member shortcut_context] can be used to temporarily override this when needed.
</member> </member>

4
doc/classes/InputEventShortCut.xml
View File

@ -8,9 +8,13 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="shortcut" type="ShortCut" setter="set_shortcut" getter="get_shortcut"> <member name="shortcut" type="ShortCut" setter="set_shortcut" getter="get_shortcut">
The [ShortCut] represented by this event. Its [method ShortCut.matches_event] method will always return [code]true[/code] for this event. The [ShortCut] represented by this event. Its [method ShortCut.matches_event] method will always return [code]true[/code] for this event.
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

15
doc/classes/Navigation2DServer.xml
View File

@ -367,13 +367,6 @@
Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code]. Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code].
</description> </description>
</method> </method>
<method name="map_get_cell_height" qualifiers="const">
<return type="float" />
<argument index="0" name="map" type="RID" />
<description>
Returns the map cell height. [b]Note:[/b] Currently not implemented.
</description>
</method>
<method name="map_get_cell_size" qualifiers="const"> <method name="map_get_cell_size" qualifiers="const">
<return type="float" /> <return type="float" />
<argument index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
@ -465,14 +458,6 @@
Sets the map active. Sets the map active.
</description> </description>
</method> </method>
<method name="map_set_cell_height">
<return type="void" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="cell_height" type="float" />
<description>
Set the map cell height used to weld the navigation mesh polygons. [b]Note:[/b] Currently not implemented.
</description>
</method>
<method name="map_set_cell_size"> <method name="map_set_cell_size">
<return type="void" /> <return type="void" />
<argument index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />

6
doc/classes/NavigationAgent.xml
View File

@ -179,16 +179,16 @@
<member name="height" type="float" setter="set_height" getter="get_height" default="1.0"> <member name="height" type="float" setter="set_height" getter="get_height" default="1.0">
The height of the avoidance agent. Agents will ignore other agents or obstacles that are above or below their current position + height in 2D avoidance. Does nothing in 3D avoidance which uses radius spheres alone. The height of the avoidance agent. Agents will ignore other agents or obstacles that are above or below their current position + height in 2D avoidance. Does nothing in 3D avoidance which uses radius spheres alone.
</member> </member>
<member name="max_neighbors" type="int" setter="set_max_neighbors" getter="get_max_neighbors" default="0"> <member name="max_neighbors" type="int" setter="set_max_neighbors" getter="get_max_neighbors" default="10">
The maximum number of neighbors for the agent to consider. The maximum number of neighbors for the agent to consider.
</member> </member>
<member name="max_speed" type="float" setter="set_max_speed" getter="get_max_speed" default="0.0"> <member name="max_speed" type="float" setter="set_max_speed" getter="get_max_speed" default="10.0">
The maximum speed that an agent can move. The maximum speed that an agent can move.
</member> </member>
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1"> <member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
A bitfield determining which navigation layers of navigation regions this agent will use to calculate a path. Changing it during runtime will clear the current navigation path and generate a new one, according to the new navigation layers. A bitfield determining which navigation layers of navigation regions this agent will use to calculate a path. Changing it during runtime will clear the current navigation path and generate a new one, according to the new navigation layers.
</member> </member>
<member name="neighbor_distance" type="float" setter="set_neighbor_distance" getter="get_neighbor_distance" default="1.0"> <member name="neighbor_distance" type="float" setter="set_neighbor_distance" getter="get_neighbor_distance" default="50.0">
The distance to search for other agents. The distance to search for other agents.
</member> </member>
<member name="path_desired_distance" type="float" setter="set_path_desired_distance" getter="get_path_desired_distance" default="1.0"> <member name="path_desired_distance" type="float" setter="set_path_desired_distance" getter="get_path_desired_distance" default="1.0">

8
doc/classes/NavigationMesh.xml
View File

@ -144,13 +144,10 @@
<member name="geometry_source_geometry_mode" type="int" setter="set_source_geometry_mode" getter="get_source_geometry_mode" enum="NavigationMesh.SourceGeometryMode" default="0"> <member name="geometry_source_geometry_mode" type="int" setter="set_source_geometry_mode" getter="get_source_geometry_mode" enum="NavigationMesh.SourceGeometryMode" default="0">
The source of the geometry used when baking. See [enum SourceGeometryMode] for possible values. The source of the geometry used when baking. See [enum SourceGeometryMode] for possible values.
</member> </member>
<member name="geometry_source_group_name" type="StringName" setter="set_source_group_name" getter="get_source_group_name" default="@&quot;navigation_mesh_source_group&quot;"> <member name="geometry_source_group_name" type="StringName" setter="set_source_group_name" getter="get_source_group_name" default="@&quot;navigation_mesh&quot;">
The name of the group to scan for geometry. The name of the group to scan for geometry.
Only used when [member geometry_source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT]. Only used when [member geometry_source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT].
</member> </member>
<member name="polygon_vertices_per_polygon" type="float" setter="set_vertices_per_polygon" getter="get_vertices_per_polygon" default="6.0">
The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process.
</member>
<member name="region_merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size" default="20.0"> <member name="region_merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size" default="20.0">
Any regions with a size smaller than this will be merged with larger regions if possible. Any regions with a size smaller than this will be merged with larger regions if possible.
[b]Note:[/b] This value will be squared to calculate the number of cells. For example, a value of 20 will set the number of cells to 400. [b]Note:[/b] This value will be squared to calculate the number of cells. For example, a value of 20 will set the number of cells to 400.
@ -161,6 +158,9 @@
</member> </member>
<member name="sample_partition_type" type="int" setter="set_sample_partition_type" getter="get_sample_partition_type" enum="NavigationMesh.SamplePartitionType" default="0"> <member name="sample_partition_type" type="int" setter="set_sample_partition_type" getter="get_sample_partition_type" enum="NavigationMesh.SamplePartitionType" default="0">
</member> </member>
<member name="vertices_per_polygon" type="float" setter="set_vertices_per_polygon" getter="get_vertices_per_polygon" default="6.0">
The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process.
</member>
</members> </members>
<constants> <constants>
<constant name="SAMPLE_PARTITION_WATERSHED" value="0" enum="SamplePartitionType"> <constant name="SAMPLE_PARTITION_WATERSHED" value="0" enum="SamplePartitionType">

6
doc/classes/NavigationPolygon.xml
View File

@ -193,6 +193,9 @@
<member name="agent_radius" type="float" setter="set_agent_radius" getter="get_agent_radius" default="10.0"> <member name="agent_radius" type="float" setter="set_agent_radius" getter="get_agent_radius" default="10.0">
The distance to erode/shrink the traversable area from obstructions when baking polygons. The distance to erode/shrink the traversable area from obstructions when baking polygons.
</member> </member>
<member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size" default="1.0">
The cell size used to rasterize the navigation mesh vertices. Must match with the cell size on the navigation map.
</member>
<member name="geometry_collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295"> <member name="geometry_collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295">
The physics layers to scan for static colliders. Only used when [member geometry_parsed_geometry_type] is [constant PARSED_GEOMETRY_STATIC_COLLIDERS] or [constant PARSED_GEOMETRY_BOTH]. The physics layers to scan for static colliders. Only used when [member geometry_parsed_geometry_type] is [constant PARSED_GEOMETRY_STATIC_COLLIDERS] or [constant PARSED_GEOMETRY_BOTH].
</member> </member>
@ -211,9 +214,6 @@
<member name="polygon_bake_fillrule" type="int" setter="set_polygon_bake_fillrule" getter="get_polygon_bake_fillrule" enum="NavigationPolygon.PolygonFillRule" default="0"> <member name="polygon_bake_fillrule" type="int" setter="set_polygon_bake_fillrule" getter="get_polygon_bake_fillrule" enum="NavigationPolygon.PolygonFillRule" default="0">
Filling rule for baking polygons that defines in complex polygons which polygon sub-regions will be considered inside a given polygon, and which sub-regions will not, aka what is a hole. Filling rule for baking polygons that defines in complex polygons which polygon sub-regions will be considered inside a given polygon, and which sub-regions will not, aka what is a hole.
</member> </member>
<member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size" default="1.0">
The cell size used to rasterize the navigation mesh vertices. Must match with the cell size on the navigation map.
</member>
</members> </members>
<constants> <constants>
<constant name="PARSED_GEOMETRY_MESH_INSTANCES" value="0" enum="ParsedGeometryType"> <constant name="PARSED_GEOMETRY_MESH_INSTANCES" value="0" enum="ParsedGeometryType">

1
doc/classes/Popup.xml
View File

@ -57,6 +57,7 @@
If [code]true[/code], the popup will not be hidden when a click event occurs outside of it, or when it receives the [code]ui_cancel[/code] action event. If [code]true[/code], the popup will not be hidden when a click event occurs outside of it, or when it receives the [code]ui_cancel[/code] action event.
[b]Note:[/b] Enabling this property doesn't affect the Close or Cancel buttons' behavior in dialogs that inherit from this class. As a workaround, you can use [method WindowDialog.get_close_button] or [method ConfirmationDialog.get_cancel] and hide the buttons in question by setting their [member CanvasItem.visible] property to [code]false[/code]. [b]Note:[/b] Enabling this property doesn't affect the Close or Cancel buttons' behavior in dialogs that inherit from this class. As a workaround, you can use [method WindowDialog.get_close_button] or [method ConfirmationDialog.get_cancel] and hide the buttons in question by setting their [member CanvasItem.visible] property to [code]false[/code].
</member> </member>
<member name="toplevel" type="bool" setter="set_as_toplevel" getter="is_set_as_toplevel" overrides="CanvasItem" default="true" />
<member name="visible" type="bool" setter="set_visible" getter="is_visible" overrides="CanvasItem" default="false" /> <member name="visible" type="bool" setter="set_visible" getter="is_visible" overrides="CanvasItem" default="false" />
</members> </members>
<signals> <signals>

68
doc/classes/ProjectSettings.xml
View File

@ -333,68 +333,6 @@
<member name="compression/formats/zstd/window_log_size" type="int" setter="" getter="" default="27"> <member name="compression/formats/zstd/window_log_size" type="int" setter="" getter="" default="27">
Largest size limit (in power of 2) allowed when compressing using long-distance matching with Zstandard. Higher values can result in better compression, but will require more memory when compressing and decompressing. Largest size limit (in power of 2) allowed when compressing using long-distance matching with Zstandard. Higher values can result in better compression, but will require more memory when compressing and decompressing.
</member> </member>
<member name="debug/cscript/completion/autocomplete_setters_and_getters" type="bool" setter="" getter="" default="false">
</member>
<member name="debug/cscript/warnings/constant_used_as_function" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/deprecated_keyword" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/enable" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/exclude_addons" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/export_hint_type_mistmatch" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/function_conflicts_constant" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/function_conflicts_variable" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/function_used_as_property" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/incompatible_ternary" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/integer_division" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/narrowing_conversion" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/property_used_as_function" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/return_value_discarded" type="bool" setter="" getter="" default="false">
</member>
<member name="debug/cscript/warnings/shadowed_variable" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/standalone_expression" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/standalone_ternary" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/treat_warnings_as_errors" type="bool" setter="" getter="" default="false">
</member>
<member name="debug/cscript/warnings/unassigned_variable" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/unassigned_variable_op_assign" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/unreachable_code" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/unsafe_call_argument" type="bool" setter="" getter="" default="false">
</member>
<member name="debug/cscript/warnings/unsafe_cast" type="bool" setter="" getter="" default="false">
</member>
<member name="debug/cscript/warnings/unsafe_method_access" type="bool" setter="" getter="" default="false">
</member>
<member name="debug/cscript/warnings/unsafe_property_access" type="bool" setter="" getter="" default="false">
</member>
<member name="debug/cscript/warnings/unused_argument" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/unused_class_variable" type="bool" setter="" getter="" default="false">
</member>
<member name="debug/cscript/warnings/unused_signal" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/unused_variable" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/variable_conflicts_function" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/cscript/warnings/void_assignment" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/gdscript/completion/autocomplete_setters_and_getters" type="bool" setter="" getter="" default="false"> <member name="debug/gdscript/completion/autocomplete_setters_and_getters" type="bool" setter="" getter="" default="false">
If [code]true[/code], displays getters and setters in autocompletion results in the script editor. This setting is meant to be used when porting old projects (Godot 2), as using member variables is the preferred style from Godot 3 onwards. If [code]true[/code], displays getters and setters in autocompletion results in the script editor. This setting is meant to be used when porting old projects (Godot 2), as using member variables is the preferred style from Godot 3 onwards.
</member> </member>
@ -497,8 +435,6 @@
<member name="debug/settings/crash_handler/message.editor" type="String" setter="" getter="" default="&quot;Please include this when reporting the bug on: https://github.com/Relintai/pandemonium_engine/issues&quot;"> <member name="debug/settings/crash_handler/message.editor" type="String" setter="" getter="" default="&quot;Please include this when reporting the bug on: https://github.com/Relintai/pandemonium_engine/issues&quot;">
Editor-only override for [member debug/settings/crash_handler/message]. Does not affect exported projects in debug or release mode. Editor-only override for [member debug/settings/crash_handler/message]. Does not affect exported projects in debug or release mode.
</member> </member>
<member name="debug/settings/cscript/max_call_stack" type="int" setter="" getter="" default="1024">
</member>
<member name="debug/settings/fps/force_fps" type="int" setter="" getter="" default="0"> <member name="debug/settings/fps/force_fps" type="int" setter="" getter="" default="0">
Maximum number of frames per second allowed. The actual number of frames per second may still be below this value if the game is lagging. See also [member physics/common/physics_ticks_per_second]. Maximum number of frames per second allowed. The actual number of frames per second may still be below this value if the game is lagging. See also [member physics/common/physics_ticks_per_second].
If [member display/window/vsync/use_vsync] is enabled, it takes precedence and the forced FPS number cannot exceed the monitor's refresh rate. If [member display/window/vsync/use_vsync] is enabled, it takes precedence and the forced FPS number cannot exceed the monitor's refresh rate.
@ -1504,10 +1440,6 @@
<member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="" default="60"> <member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="" default="60">
This is used by servers when used in multi-threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number. This is used by servers when used in multi-threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number.
</member> </member>
<member name="navigation/2d/default_cell_height" type="float" setter="" getter="" default="1.0">
Default cell height for 2D navigation maps. See [method Navigation2DServer.map_set_cell_height].
[b]Note:[/b] Currently not implemented.
</member>
<member name="navigation/2d/default_cell_size" type="float" setter="" getter="" default="1.0"> <member name="navigation/2d/default_cell_size" type="float" setter="" getter="" default="1.0">
Default cell size for 2D navigation maps. See [method Navigation2DServer.map_set_cell_size]. Default cell size for 2D navigation maps. See [method Navigation2DServer.map_set_cell_size].
</member> </member>

7
doc/classes/RichTextLabel.xml
View File

@ -177,6 +177,13 @@
Adds a context marker to the tag stack. See [method pop_context]. Adds a context marker to the tag stack. See [method pop_context].
</description> </description>
</method> </method>
<method name="push_customfx">
<return type="void" />
<argument index="0" name="effect" type="RichTextEffect" />
<argument index="1" name="env" type="Dictionary" />
<description>
</description>
</method>
<method name="push_font"> <method name="push_font">
<return type="void" /> <return type="void" />
<argument index="0" name="font" type="Font" /> <argument index="0" name="font" type="Font" />

8
doc/classes/ScriptServer.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="ScriptServer" inherits="Object" version="3.5"> <class name="ScriptServer" inherits="Object" version="4.1">
<brief_description> <brief_description>
Global script class management singleton. Global script class management singleton.
</brief_description> </brief_description>
@ -12,7 +12,7 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_global_class_base" qualifiers="const"> <method name="get_global_class_base" qualifiers="const">
<return type="String" /> <return type="StringName" />
<argument index="0" name="class" type="String" /> <argument index="0" name="class" type="String" />
<description> <description>
Returns the class name that the script named [code]class[/code] directly extends. This may be an engine class or another global script class. Returns the class name that the script named [code]class[/code] directly extends. This may be an engine class or another global script class.
@ -25,14 +25,14 @@
</description> </description>
</method> </method>
<method name="get_global_class_name" qualifiers="const"> <method name="get_global_class_name" qualifiers="const">
<return type="String" /> <return type="StringName" />
<argument index="0" name="path" type="String" /> <argument index="0" name="path" type="String" />
<description> <description>
Returns the global class name bound to the [Script] at [code]path[/code]. Returns the global class name bound to the [Script] at [code]path[/code].
</description> </description>
</method> </method>
<method name="get_global_class_native_base" qualifiers="const"> <method name="get_global_class_native_base" qualifiers="const">
<return type="String" /> <return type="StringName" />
<argument index="0" name="class" type="String" /> <argument index="0" name="class" type="String" />
<description> <description>
Returns the native engine class that the script named [code]class[/code] eventually extends. Returns the native engine class that the script named [code]class[/code] eventually extends.

1
doc/classes/StringName.xml
View File

@ -8,7 +8,6 @@
You will usually just pass a [String] to methods expecting a [StringName] and it will be automatically converted, but you may occasionally want to construct a [StringName] ahead of time with the [StringName] constructor or, in GDScript, the literal syntax [code]@"example"[/code]. You will usually just pass a [String] to methods expecting a [StringName] and it will be automatically converted, but you may occasionally want to construct a [StringName] ahead of time with the [StringName] constructor or, in GDScript, the literal syntax [code]@"example"[/code].
See also [NodePath], which is a similar concept specifically designed to store pre-parsed scene tree paths. See also [NodePath], which is a similar concept specifically designed to store pre-parsed scene tree paths.
</description> </description>
</description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>

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

@ -161,6 +161,13 @@
Sets an individual bit on the [member collision_mask]. Sets an individual bit on the [member collision_mask].
</description> </description>
</method> </method>
<method name="set_navigation_map">
<return type="void" />
<argument index="0" name="navigation_map" type="RID" />
<description>
Sets the [RID] of the navigation map this GridMap node should use for its cell baked navigation meshes.
</description>
</method>
<method name="world_to_map" qualifiers="const"> <method name="world_to_map" qualifiers="const">
<return type="Vector3" /> <return type="Vector3" />
<argument index="0" name="pos" type="Vector3" /> <argument index="0" name="pos" type="Vector3" />
@ -169,13 +176,6 @@
[code]pos[/code] should be in the GridMap's local coordinate space. [code]pos[/code] should be in the GridMap's local coordinate space.
</description> </description>
</method> </method>
<method name="set_navigation_map">
<return type="void" />
<argument index="0" name="navigation_map" type="RID" />
<description>
Sets the [RID] of the navigation map this GridMap node should use for its cell baked navigation meshes.
</description>
</method>
</methods> </methods>
<members> <members>
<member name="bake_navigation" type="bool" setter="set_bake_navigation" getter="is_baking_navigation" default="false"> <member name="bake_navigation" type="bool" setter="set_bake_navigation" getter="is_baking_navigation" default="false">

26
modules/tile_map/doc_classes/TileMap.xml
View File

@ -49,6 +49,12 @@
<description> <description>
</description> </description>
</method> </method>
<method name="get_navigation_map" qualifiers="const">
<return type="RID" />
<description>
Returns the current navigation map [RID] use by this region.
</description>
</method>
<method name="get_used_cells" qualifiers="const"> <method name="get_used_cells" qualifiers="const">
<return type="Array" /> <return type="Array" />
<description> <description>
@ -129,6 +135,13 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_navigation_map">
<return type="void" />
<argument index="0" name="navigation_map" type="RID" />
<description>
Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World2D] default navigation map so this function is only required to override the default map.
</description>
</method>
<method name="update_bitmask_area"> <method name="update_bitmask_area">
<return type="void" /> <return type="void" />
<argument index="0" name="position" type="Vector2" /> <argument index="0" name="position" type="Vector2" />
@ -153,19 +166,6 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_navigation_map">
<return type="void" />
<argument index="0" name="navigation_map" type="RID" />
<description>
Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World2D] default navigation map so this function is only required to override the default map.
</description>
</method>
<method name="get_navigation_map" qualifiers="const">
<return type="RID" />
<description>
Returns the current navigation map [RID] use by this region.
</description>
</method>
</methods> </methods>
<members> <members>
<member name="bake_navigation" type="bool" setter="set_bake_navigation" getter="is_baking_navigation" default="false"> <member name="bake_navigation" type="bool" setter="set_bake_navigation" getter="is_baking_navigation" default="false">