godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update class docs

This commit is contained in:
Kelly Thomas 2018-09-01 03:12:35 +08:00 committed by Rémi Verschelde
parent e00baaf6ce
commit 29f2571662
13 changed files with 35 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/@GlobalScope.xml
View File

@ -29,6 +29,8 @@
<member name="Geometry" type="Geometry" setter="" getter=""> <member name="Geometry" type="Geometry" setter="" getter="">
[Geometry] singleton [Geometry] singleton
</member> </member>
<member name="GodotSharp" type="GodotSharp" setter="" getter="">
</member>
<member name="IP" type="IP" setter="" getter=""> <member name="IP" type="IP" setter="" getter="">
[IP] singleton [IP] singleton
</member> </member>

8
doc/classes/Area.xml
View File

@ -142,14 +142,14 @@
</members> </members>
<signals> <signals>
<signal name="area_entered"> <signal name="area_entered">
<argument index="0" name="area" type="Object"> <argument index="0" name="area" type="Area">
</argument> </argument>
<description> <description>
Emitted when another area enters. Emitted when another area enters.
</description> </description>
</signal> </signal>
<signal name="area_exited"> <signal name="area_exited">
<argument index="0" name="area" type="Object"> <argument index="0" name="area" type="Area">
</argument> </argument>
<description> <description>
Emitted when another area exits. Emitted when another area exits.
@ -158,7 +158,7 @@
<signal name="area_shape_entered"> <signal name="area_shape_entered">
<argument index="0" name="area_id" type="int"> <argument index="0" name="area_id" type="int">
</argument> </argument>
<argument index="1" name="area" type="Object"> <argument index="1" name="area" type="Area">
</argument> </argument>
<argument index="2" name="area_shape" type="int"> <argument index="2" name="area_shape" type="int">
</argument> </argument>
@ -171,7 +171,7 @@
<signal name="area_shape_exited"> <signal name="area_shape_exited">
<argument index="0" name="area_id" type="int"> <argument index="0" name="area_id" type="int">
</argument> </argument>
<argument index="1" name="area" type="Object"> <argument index="1" name="area" type="Area">
</argument> </argument>
<argument index="2" name="area_shape" type="int"> <argument index="2" name="area_shape" type="int">
</argument> </argument>

16
doc/classes/Area2D.xml
View File

@ -130,14 +130,14 @@
</members> </members>
<signals> <signals>
<signal name="area_entered"> <signal name="area_entered">
<argument index="0" name="area" type="Object"> <argument index="0" name="area" type="Area2D">
</argument> </argument>
<description> <description>
Emitted when another area enters. Emitted when another area enters.
</description> </description>
</signal> </signal>
<signal name="area_exited"> <signal name="area_exited">
<argument index="0" name="area" type="Object"> <argument index="0" name="area" type="Area2D">
</argument> </argument>
<description> <description>
Emitted when another area exits. Emitted when another area exits.
@ -146,7 +146,7 @@
<signal name="area_shape_entered"> <signal name="area_shape_entered">
<argument index="0" name="area_id" type="int"> <argument index="0" name="area_id" type="int">
</argument> </argument>
<argument index="1" name="area" type="Object"> <argument index="1" name="area" type="Area2D">
</argument> </argument>
<argument index="2" name="area_shape" type="int"> <argument index="2" name="area_shape" type="int">
</argument> </argument>
@ -159,7 +159,7 @@
<signal name="area_shape_exited"> <signal name="area_shape_exited">
<argument index="0" name="area_id" type="int"> <argument index="0" name="area_id" type="int">
</argument> </argument>
<argument index="1" name="area" type="Object"> <argument index="1" name="area" type="Area2D">
</argument> </argument>
<argument index="2" name="area_shape" type="int"> <argument index="2" name="area_shape" type="int">
</argument> </argument>
@ -170,14 +170,14 @@
</description> </description>
</signal> </signal>
<signal name="body_entered"> <signal name="body_entered">
<argument index="0" name="body" type="Object"> <argument index="0" name="body" type="PhysicsBody2D">
</argument> </argument>
<description> <description>
Emitted when a [PhysicsBody2D] object enters. Emitted when a [PhysicsBody2D] object enters.
</description> </description>
</signal> </signal>
<signal name="body_exited"> <signal name="body_exited">
<argument index="0" name="body" type="Object"> <argument index="0" name="body" type="PhysicsBody2D">
</argument> </argument>
<description> <description>
Emitted when a [PhysicsBody2D] object exits. Emitted when a [PhysicsBody2D] object exits.
@ -186,7 +186,7 @@
<signal name="body_shape_entered"> <signal name="body_shape_entered">
<argument index="0" name="body_id" type="int"> <argument index="0" name="body_id" type="int">
</argument> </argument>
<argument index="1" name="body" type="Object"> <argument index="1" name="body" type="PhysicsBody2D">
</argument> </argument>
<argument index="2" name="body_shape" type="int"> <argument index="2" name="body_shape" type="int">
</argument> </argument>
@ -199,7 +199,7 @@
<signal name="body_shape_exited"> <signal name="body_shape_exited">
<argument index="0" name="body_id" type="int"> <argument index="0" name="body_id" type="int">
</argument> </argument>
<argument index="1" name="body" type="Object"> <argument index="1" name="body" type="PhysicsBody2D">
</argument> </argument>
<argument index="2" name="body_shape" type="int"> <argument index="2" name="body_shape" type="int">
</argument> </argument>

2
doc/classes/CollisionObject.xml
View File

@ -193,7 +193,7 @@
<signal name="input_event"> <signal name="input_event">
<argument index="0" name="camera" type="Object"> <argument index="0" name="camera" type="Object">
</argument> </argument>
<argument index="1" name="event" type="Object"> <argument index="1" name="event" type="InputEvent">
</argument> </argument>
<argument index="2" name="click_position" type="Vector3"> <argument index="2" name="click_position" type="Vector3">
</argument> </argument>

2
doc/classes/CollisionObject2D.xml
View File

@ -206,7 +206,7 @@
<signal name="input_event"> <signal name="input_event">
<argument index="0" name="viewport" type="Object"> <argument index="0" name="viewport" type="Object">
</argument> </argument>
<argument index="1" name="event" type="Object"> <argument index="1" name="event" type="InputEvent">
</argument> </argument>
<argument index="2" name="shape_idx" type="int"> <argument index="2" name="shape_idx" type="int">
</argument> </argument>

2
doc/classes/Control.xml
View File

@ -723,7 +723,7 @@
</description> </description>
</signal> </signal>
<signal name="gui_input"> <signal name="gui_input">
<argument index="0" name="ev" type="Object"> <argument index="0" name="ev" type="InputEvent">
</argument> </argument>
<description> <description>
Emitted when the node receives an [InputEvent]. Emitted when the node receives an [InputEvent].

4
doc/classes/EditorPlugin.xml
View File

@ -445,13 +445,13 @@
</description> </description>
</signal> </signal>
<signal name="resource_saved"> <signal name="resource_saved">
<argument index="0" name="resource" type="Object"> <argument index="0" name="resource" type="Resource">
</argument> </argument>
<description> <description>
</description> </description>
</signal> </signal>
<signal name="scene_changed"> <signal name="scene_changed">
<argument index="0" name="scene_root" type="Object"> <argument index="0" name="scene_root" type="Node">
</argument> </argument>
<description> <description>
Emitted when user change scene. The argument is a root node of freshly opened scene. Emitted when user change scene. The argument is a root node of freshly opened scene.

2
doc/classes/EditorProperty.xml
View File

@ -98,7 +98,7 @@
<signal name="resource_selected"> <signal name="resource_selected">
<argument index="0" name="path" type="String"> <argument index="0" name="path" type="String">
</argument> </argument>
<argument index="1" name="resource" type="Object"> <argument index="1" name="resource" type="Resource">
</argument> </argument>
<description> <description>
</description> </description>

8
doc/classes/ProjectSettings.xml
View File

@ -576,6 +576,14 @@
<member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter=""> <member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="">
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="mono/debugger_agent/port" type="int" setter="" getter="">
</member>
<member name="mono/debugger_agent/wait_for_debugger" type="bool" setter="" getter="">
</member>
<member name="mono/debugger_agent/wait_timeout" type="int" setter="" getter="">
</member>
<member name="mono/export/include_scripts_content" type="bool" setter="" getter="">
</member>
<member name="network/limits/debugger_stdout/max_chars_per_second" type="int" setter="" getter=""> <member name="network/limits/debugger_stdout/max_chars_per_second" type="int" setter="" getter="">
Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection.
</member> </member>

2
doc/classes/ScriptCreateDialog.xml
View File

@ -31,7 +31,7 @@
</methods> </methods>
<signals> <signals>
<signal name="script_created"> <signal name="script_created">
<argument index="0" name="script" type="Object"> <argument index="0" name="script" type="Script">
</argument> </argument>
<description> <description>
Emitted when the user clicks the OK button. Emitted when the user clicks the OK button.

4
doc/classes/ScriptEditor.xml
View File

@ -70,14 +70,14 @@
</methods> </methods>
<signals> <signals>
<signal name="editor_script_changed"> <signal name="editor_script_changed">
<argument index="0" name="script" type="Object"> <argument index="0" name="script" type="Script">
</argument> </argument>
<description> <description>
Emitted when user changed active script. Argument is a freshly activated [Script]. Emitted when user changed active script. Argument is a freshly activated [Script].
</description> </description>
</signal> </signal>
<signal name="script_close"> <signal name="script_close">
<argument index="0" name="script" type="Object"> <argument index="0" name="script" type="Script">
</argument> </argument>
<description> <description>
Emitted when editor is about to close the active script. Argument is a [Script] that is going to be closed. Emitted when editor is about to close the active script. Argument is a [Script] that is going to be closed.

4
doc/classes/VisibilityNotifier.xml
View File

@ -26,14 +26,14 @@
</members> </members>
<signals> <signals>
<signal name="camera_entered"> <signal name="camera_entered">
<argument index="0" name="camera" type="Object"> <argument index="0" name="camera" type="Camera">
</argument> </argument>
<description> <description>
Emitted when the VisibilityNotifier enters a [Camera]'s view. Emitted when the VisibilityNotifier enters a [Camera]'s view.
</description> </description>
</signal> </signal>
<signal name="camera_exited"> <signal name="camera_exited">
<argument index="0" name="camera" type="Object"> <argument index="0" name="camera" type="Camera">
</argument> </argument>
<description> <description>
Emitted when the VisibilityNotifier exits a [Camera]'s view. Emitted when the VisibilityNotifier exits a [Camera]'s view.

4
doc/classes/VisibilityNotifier2D.xml
View File

@ -36,14 +36,14 @@
</description> </description>
</signal> </signal>
<signal name="viewport_entered"> <signal name="viewport_entered">
<argument index="0" name="viewport" type="Object"> <argument index="0" name="viewport" type="Viewport">
</argument> </argument>
<description> <description>
Emitted when the VisibilityNotifier2D enters a [Viewport]'s view. Emitted when the VisibilityNotifier2D enters a [Viewport]'s view.
</description> </description>
</signal> </signal>
<signal name="viewport_exited"> <signal name="viewport_exited">
<argument index="0" name="viewport" type="Object"> <argument index="0" name="viewport" type="Viewport">
</argument> </argument>
<description> <description>
Emitted when the VisibilityNotifier2D exits a [Viewport]'s view. Emitted when the VisibilityNotifier2D exits a [Viewport]'s view.