Skip to content

Commit

Permalink
update class docs
Browse files Browse the repository at this point in the history
  • Loading branch information
KellyThomas authored and akien-mga committed Aug 31, 2018
1 parent e00baaf commit 29f2571
Show file tree
Hide file tree
Showing 13 changed files with 35 additions and 25 deletions.
2 changes: 2 additions & 0 deletions doc/classes/@GlobalScope.xml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
<member name="Geometry" type="Geometry" setter="" getter="">
[Geometry] singleton
</member>
<member name="GodotSharp" type="GodotSharp" setter="" getter="">
</member>
<member name="IP" type="IP" setter="" getter="">
[IP] singleton
</member>
Expand Down
8 changes: 4 additions & 4 deletions doc/classes/Area.xml
Original file line number Diff line number Diff line change
Expand Up @@ -142,14 +142,14 @@
</members>
<signals>
<signal name="area_entered">
<argument index="0" name="area" type="Object">
<argument index="0" name="area" type="Area">
</argument>
<description>
Emitted when another area enters.
</description>
</signal>
<signal name="area_exited">
<argument index="0" name="area" type="Object">
<argument index="0" name="area" type="Area">
</argument>
<description>
Emitted when another area exits.
Expand All @@ -158,7 +158,7 @@
<signal name="area_shape_entered">
<argument index="0" name="area_id" type="int">
</argument>
<argument index="1" name="area" type="Object">
<argument index="1" name="area" type="Area">
</argument>
<argument index="2" name="area_shape" type="int">
</argument>
Expand All @@ -171,7 +171,7 @@
<signal name="area_shape_exited">
<argument index="0" name="area_id" type="int">
</argument>
<argument index="1" name="area" type="Object">
<argument index="1" name="area" type="Area">
</argument>
<argument index="2" name="area_shape" type="int">
</argument>
Expand Down
16 changes: 8 additions & 8 deletions doc/classes/Area2D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -130,14 +130,14 @@
</members>
<signals>
<signal name="area_entered">
<argument index="0" name="area" type="Object">
<argument index="0" name="area" type="Area2D">
</argument>
<description>
Emitted when another area enters.
</description>
</signal>
<signal name="area_exited">
<argument index="0" name="area" type="Object">
<argument index="0" name="area" type="Area2D">
</argument>
<description>
Emitted when another area exits.
Expand All @@ -146,7 +146,7 @@
<signal name="area_shape_entered">
<argument index="0" name="area_id" type="int">
</argument>
<argument index="1" name="area" type="Object">
<argument index="1" name="area" type="Area2D">
</argument>
<argument index="2" name="area_shape" type="int">
</argument>
Expand All @@ -159,7 +159,7 @@
<signal name="area_shape_exited">
<argument index="0" name="area_id" type="int">
</argument>
<argument index="1" name="area" type="Object">
<argument index="1" name="area" type="Area2D">
</argument>
<argument index="2" name="area_shape" type="int">
</argument>
Expand All @@ -170,14 +170,14 @@
</description>
</signal>
<signal name="body_entered">
<argument index="0" name="body" type="Object">
<argument index="0" name="body" type="PhysicsBody2D">
</argument>
<description>
Emitted when a [PhysicsBody2D] object enters.
</description>
</signal>
<signal name="body_exited">
<argument index="0" name="body" type="Object">
<argument index="0" name="body" type="PhysicsBody2D">
</argument>
<description>
Emitted when a [PhysicsBody2D] object exits.
Expand All @@ -186,7 +186,7 @@
<signal name="body_shape_entered">
<argument index="0" name="body_id" type="int">
</argument>
<argument index="1" name="body" type="Object">
<argument index="1" name="body" type="PhysicsBody2D">
</argument>
<argument index="2" name="body_shape" type="int">
</argument>
Expand All @@ -199,7 +199,7 @@
<signal name="body_shape_exited">
<argument index="0" name="body_id" type="int">
</argument>
<argument index="1" name="body" type="Object">
<argument index="1" name="body" type="PhysicsBody2D">
</argument>
<argument index="2" name="body_shape" type="int">
</argument>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/CollisionObject.xml
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@
<signal name="input_event">
<argument index="0" name="camera" type="Object">
</argument>
<argument index="1" name="event" type="Object">
<argument index="1" name="event" type="InputEvent">
</argument>
<argument index="2" name="click_position" type="Vector3">
</argument>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/CollisionObject2D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@
<signal name="input_event">
<argument index="0" name="viewport" type="Object">
</argument>
<argument index="1" name="event" type="Object">
<argument index="1" name="event" type="InputEvent">
</argument>
<argument index="2" name="shape_idx" type="int">
</argument>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Control.xml
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,7 @@
</description>
</signal>
<signal name="gui_input">
<argument index="0" name="ev" type="Object">
<argument index="0" name="ev" type="InputEvent">
</argument>
<description>
Emitted when the node receives an [InputEvent].
Expand Down
4 changes: 2 additions & 2 deletions doc/classes/EditorPlugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -445,13 +445,13 @@
</description>
</signal>
<signal name="resource_saved">
<argument index="0" name="resource" type="Object">
<argument index="0" name="resource" type="Resource">
</argument>
<description>
</description>
</signal>
<signal name="scene_changed">
<argument index="0" name="scene_root" type="Object">
<argument index="0" name="scene_root" type="Node">
</argument>
<description>
Emitted when user change scene. The argument is a root node of freshly opened scene.
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/EditorProperty.xml
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
<signal name="resource_selected">
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="resource" type="Object">
<argument index="1" name="resource" type="Resource">
</argument>
<description>
</description>
Expand Down
8 changes: 8 additions & 0 deletions doc/classes/ProjectSettings.xml
Original file line number Diff line number Diff line change
Expand Up @@ -576,6 +576,14 @@
<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.
</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="">
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>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/ScriptCreateDialog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</methods>
<signals>
<signal name="script_created">
<argument index="0" name="script" type="Object">
<argument index="0" name="script" type="Script">
</argument>
<description>
Emitted when the user clicks the OK button.
Expand Down
4 changes: 2 additions & 2 deletions doc/classes/ScriptEditor.xml
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,14 @@
</methods>
<signals>
<signal name="editor_script_changed">
<argument index="0" name="script" type="Object">
<argument index="0" name="script" type="Script">
</argument>
<description>
Emitted when user changed active script. Argument is a freshly activated [Script].
</description>
</signal>
<signal name="script_close">
<argument index="0" name="script" type="Object">
<argument index="0" name="script" type="Script">
</argument>
<description>
Emitted when editor is about to close the active script. Argument is a [Script] that is going to be closed.
Expand Down
4 changes: 2 additions & 2 deletions doc/classes/VisibilityNotifier.xml
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@
</members>
<signals>
<signal name="camera_entered">
<argument index="0" name="camera" type="Object">
<argument index="0" name="camera" type="Camera">
</argument>
<description>
Emitted when the VisibilityNotifier enters a [Camera]'s view.
</description>
</signal>
<signal name="camera_exited">
<argument index="0" name="camera" type="Object">
<argument index="0" name="camera" type="Camera">
</argument>
<description>
Emitted when the VisibilityNotifier exits a [Camera]'s view.
Expand Down
4 changes: 2 additions & 2 deletions doc/classes/VisibilityNotifier2D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@
</description>
</signal>
<signal name="viewport_entered">
<argument index="0" name="viewport" type="Object">
<argument index="0" name="viewport" type="Viewport">
</argument>
<description>
Emitted when the VisibilityNotifier2D enters a [Viewport]'s view.
</description>
</signal>
<signal name="viewport_exited">
<argument index="0" name="viewport" type="Object">
<argument index="0" name="viewport" type="Viewport">
</argument>
<description>
Emitted when the VisibilityNotifier2D exits a [Viewport]'s view.
Expand Down

0 comments on commit 29f2571

Please sign in to comment.