Re-extracted class docs.

This commit is contained in:
Relintai 2023-10-20 15:06:38 +02:00
parent 2e7709185a
commit 3b8f836a41
6 changed files with 207 additions and 4 deletions

View File

@ -13,6 +13,57 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="collapse_all_folding">
<return type="void" />
<description>
</description>
</method>
<method name="edit">
<return type="void" />
<argument index="0" name="object" type="Object" />
<description>
</description>
</method>
<method name="expand_all_folding">
<return type="void" />
<description>
</description>
</method>
<method name="get_edited_object">
<return type="Object" />
<description>
</description>
</method>
<method name="get_object_class" qualifiers="const">
<return type="String" />
<description>
</description>
</method>
<method name="get_property_clipboard" qualifiers="const">
<return type="Variant" />
<description>
</description>
</method>
<method name="get_property_prefix" qualifiers="const">
<return type="String" />
<description>
</description>
</method>
<method name="get_scroll_offset" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="is_sub_inspector" qualifiers="const">
<return type="bool" />
<description>
</description>
</method>
<method name="is_using_folding">
<return type="bool" />
<description>
</description>
</method>
<method name="refresh"> <method name="refresh">
<return type="void" /> <return type="void" />
<description> <description>
@ -20,6 +71,72 @@
[b]Note:[/b] To save on CPU resources, calling this method will do nothing if the time specified in [code]docks/property_editor/auto_refresh_interval[/code] editor setting hasn't passed yet since this method was last called. (By default, this interval is set to 0.3 seconds.) [b]Note:[/b] To save on CPU resources, calling this method will do nothing if the time specified in [code]docks/property_editor/auto_refresh_interval[/code] editor setting hasn't passed yet since this method was last called. (By default, this interval is set to 0.3 seconds.)
</description> </description>
</method> </method>
<method name="register_text_enter">
<return type="void" />
<argument index="0" name="line_edit" type="Node" />
<description>
</description>
</method>
<method name="set_hide_script">
<return type="void" />
<argument index="0" name="hide" type="bool" />
<description>
</description>
</method>
<method name="set_object_class">
<return type="void" />
<argument index="0" name="class" type="String" />
<description>
</description>
</method>
<method name="set_property_clipboard">
<return type="void" />
<argument index="0" name="value" type="Variant" />
<description>
</description>
</method>
<method name="set_property_prefix">
<return type="void" />
<argument index="0" name="prefix" type="String" />
<description>
</description>
</method>
<method name="set_scroll_offset">
<return type="void" />
<argument index="0" name="offset" type="int" />
<description>
</description>
</method>
<method name="set_show_categories">
<return type="void" />
<argument index="0" name="show" type="bool" />
<description>
</description>
</method>
<method name="set_sub_inspector">
<return type="void" />
<argument index="0" name="enable" type="bool" />
<description>
</description>
</method>
<method name="set_use_doc_hints">
<return type="void" />
<argument index="0" name="enable" type="bool" />
<description>
</description>
</method>
<method name="set_use_filter">
<return type="void" />
<argument index="0" name="use" type="bool" />
<description>
</description>
</method>
<method name="set_use_folding">
<return type="void" />
<argument index="0" name="enable" type="bool" />
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="scroll_horizontal_enabled" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled" overrides="ScrollContainer" default="false" /> <member name="scroll_horizontal_enabled" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled" overrides="ScrollContainer" default="false" />

View File

@ -400,9 +400,6 @@
- [b]Cancel First[/b] forces the ordering Cancel/OK. - [b]Cancel First[/b] forces the ordering Cancel/OK.
- [b]OK First[/b] forces the ordering OK/Cancel. - [b]OK First[/b] forces the ordering OK/Cancel.
</member> </member>
<member name="interface/editor/hide_main_screen_plugin_names" type="bool" setter="" getter="">
If [code]true[/code] the names of the main screen plugins will be hidden (when they have an icon).
</member>
<member name="interface/editor/automatically_open_screenshots" type="bool" setter="" getter=""> <member name="interface/editor/automatically_open_screenshots" type="bool" setter="" getter="">
If [code]true[/code], automatically opens screenshots with the default program associated to [code].png[/code] files after a screenshot is taken using the [b]Editor &gt; Take Screenshot[/b] action. If [code]true[/code], automatically opens screenshots with the default program associated to [code].png[/code] files after a screenshot is taken using the [b]Editor &gt; Take Screenshot[/b] action.
</member> </member>
@ -438,6 +435,9 @@
- [b]Normal:[/b] Use hinting on both X and Y axes. This results in a sharp font, but it doesn't look very smooth. - [b]Normal:[/b] Use hinting on both X and Y axes. This results in a sharp font, but it doesn't look very smooth.
If set to [b]Auto[/b], the font hinting mode will be set to match the current operating system in use. This means the [b]Light[/b] hinting mode will be used on Windows and Linux, and the [b]None[/b] hinting mode will be used on macOS. If set to [b]Auto[/b], the font hinting mode will be set to match the current operating system in use. This means the [b]Light[/b] hinting mode will be used on Windows and Linux, and the [b]None[/b] hinting mode will be used on macOS.
</member> </member>
<member name="interface/editor/hide_main_screen_plugin_names" type="bool" setter="" getter="">
If [code]true[/code] the names of the main screen plugins will be hidden (when they have an icon).
</member>
<member name="interface/editor/low_processor_mode_sleep_usec" type="float" setter="" getter=""> <member name="interface/editor/low_processor_mode_sleep_usec" type="float" setter="" getter="">
The amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU/GPU usage, which can improve battery life on laptops. However, higher values will result in a less responsive editor. The default value is set to allow for maximum smoothness on monitors up to 144 Hz. See also [member interface/editor/unfocused_low_processor_mode_sleep_usec]. The amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU/GPU usage, which can improve battery life on laptops. However, higher values will result in a less responsive editor. The default value is set to allow for maximum smoothness on monitors up to 144 Hz. See also [member interface/editor/unfocused_low_processor_mode_sleep_usec].
</member> </member>

View File

@ -23,6 +23,11 @@
<description> <description>
</description> </description>
</method> </method>
<method name="ensure_visible">
<return type="void" />
<description>
</description>
</method>
<method name="get_drag_data_fw"> <method name="get_drag_data_fw">
<return type="Variant" /> <return type="Variant" />
<argument index="0" name="point" type="Vector2" /> <argument index="0" name="point" type="Vector2" />

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="JSONRPC" inherits="Object" version="4.2"> <class name="JSONRPC" inherits="Object" version="4.2">
<brief_description> <brief_description>
A helper to handle dictionaries which look like JSONRPC documents. A helper to handle dictionaries which look like JSONRPC documents.
</brief_description> </brief_description>
<description> <description>

View File

@ -0,0 +1,60 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropDataCollisionObject" inherits="PropDataEntry" version="4.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_collision_shape">
<return type="void" />
<argument index="0" name="transform" type="Transform" />
<argument index="1" name="shape" type="Shape" />
<description>
</description>
</method>
<method name="get_collision_shape" qualifiers="const">
<return type="Shape" />
<argument index="0" name="arg0" type="int" />
<description>
</description>
</method>
<method name="get_collision_shape_transform" qualifiers="const">
<return type="Transform" />
<argument index="0" name="arg0" type="int" />
<description>
</description>
</method>
<method name="remove_collision_shape">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="set_collision_shape">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="shape" type="Shape" />
<description>
</description>
</method>
<method name="set_collision_shape_transform">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="transform" type="Transform" />
<description>
</description>
</method>
</methods>
<members>
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="0">
</member>
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="0">
</member>
<member name="collision_shape_count" type="int" setter="set_collision_shape_count" getter="get_collision_shape_count" default="0">
</member>
</members>
<constants>
</constants>
</class>

View File

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PropDataStaticBody" inherits="PropDataCollisionObject" version="4.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="constant_angular_velocity" type="Vector3" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity" default="Vector3( 0, 0, 0 )">
</member>
<member name="constant_linear_velocity" type="Vector3" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity" default="Vector3( 0, 0, 0 )">
</member>
<member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override">
</member>
</members>
<constants>
</constants>
</class>