From 5d53d6dd8c6c4ac48b280d0c33e3bb6bc76e364d Mon Sep 17 00:00:00 2001 From: Chris Bradfield Date: Sun, 16 Sep 2018 10:52:21 -0700 Subject: [PATCH] [DOCS] Classref additions and consistency fixes (cherry picked from commit ec5cc708ce987259ba9667bf48e4445fa675d94a) --- doc/classes/PhysicsBody.xml | 6 +++++- doc/classes/PhysicsBody2D.xml | 12 ++++++------ doc/classes/SceneState.xml | 2 +- doc/classes/Shape2D.xml | 6 +++--- doc/classes/ShortCut.xml | 8 ++++---- doc/classes/Timer.xml | 17 +++++++++-------- 6 files changed, 28 insertions(+), 23 deletions(-) diff --git a/doc/classes/PhysicsBody.xml b/doc/classes/PhysicsBody.xml index e34f1f1c570..57dc6b99538 100644 --- a/doc/classes/PhysicsBody.xml +++ b/doc/classes/PhysicsBody.xml @@ -27,6 +27,7 @@ + Returns an individual bit on the collision mask. @@ -35,6 +36,7 @@ + Returns an individual bit on the collision mask. @@ -54,6 +56,7 @@ + Sets individual bits on the layer mask. Use this if you only need to change one layer's value. @@ -64,6 +67,7 @@ + Sets individual bits on the collision mask. Use this if you only need to change one layer's value. @@ -74,7 +78,7 @@ A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - The physics layers this area can scan for collisions. + The physics layers this area scans for collisions. diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index 85848827378..397d1d21ca5 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -27,7 +27,7 @@ - Return an individual bit on the collision mask. + Returns an individual bit on the collision mask. @@ -36,7 +36,7 @@ - Return an individual bit on the collision mask. + Returns an individual bit on the collision mask. @@ -56,7 +56,7 @@ - Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. + Sets individual bits on the layer mask. Use this if you only need to change one layer's value. @@ -67,7 +67,7 @@ - Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. + Sets individual bits on the collision mask. Use this if you only need to change one layer's value. @@ -78,10 +78,10 @@ A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - The physics layers this area can scan for collisions. + The physics layers this area scans for collisions. - Both collision_layer and collision_mask. Returns collision_layer when accessed. Updates collision_layers and collision_mask when modified. + Both [member collision_layer] and [member collision_mask]. Returns [member collision_layer] when accessed. Updates [member collision_layer] and [member collision_mask] when modified. diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index b4f13bbc880..d21ea0e24e2 100644 --- a/doc/classes/SceneState.xml +++ b/doc/classes/SceneState.xml @@ -4,7 +4,7 @@ A script interface to a scene file's data. - Maintains a list of resources, nodes, exported and overridden properties, and built-in scripts associated with a scene. + Maintains a list of resources, nodes, exported, and overridden properties, and built-in scripts associated with a scene. diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 5e77551cd31..6ccfbfe97cd 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -22,7 +22,7 @@ - Return whether this shape is colliding with another. + Returns [code]true[/code] if this shape is colliding with another. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). @@ -36,7 +36,7 @@ - Return a list of the points where this shape touches another. If there are no collisions, the list is empty. + Returns a list of the points where this shape touches another. If there are no collisions the list is empty. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). @@ -72,7 +72,7 @@ - Return a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions, the list is empty. + Returns a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions the list is empty. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). diff --git a/doc/classes/ShortCut.xml b/doc/classes/ShortCut.xml index 121040c7cf6..b9277d3ea1a 100644 --- a/doc/classes/ShortCut.xml +++ b/doc/classes/ShortCut.xml @@ -16,7 +16,7 @@ - Returns the Shortcut's [InputEvent] as a [String]. + Returns the shortcut's [InputEvent] as a [String]. @@ -25,20 +25,20 @@ - Returns [code]true[/code] if the Shortcut's [InputEvent] equals [code]event[/code]. + Returns [code]true[/code] if the shortcut's [InputEvent] equals [code]event[/code]. - If [code]true[/code] this Shortcut is valid. + If [code]true[/code] this shortcut is valid. - The Shortcut's [InputEvent]. + The shortcut's [InputEvent]. Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent]. diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 3b2ca2ff5b4..043c624d09a 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -30,25 +30,26 @@ - Stop (cancel) the Timer. + Stops the timer. - If [code]true[/code], Timer will automatically start when entering the scene tree. Default value: [code]false[/code]. + If [code]true[/code] the timer will automatically start when entering the scene tree. Default value: [code]false[/code]. - If [code]true[/code], Timer will stop when reaching 0. If [code]false[/code], it will restart. Default value: [code]false[/code]. + If [code]true[/code] the timer will stop when reaching 0. If [code]false[/code] it will restart. Default value: [code]false[/code]. - If [code]true[/code], the timer is paused and will not process until it is unpaused again, even if [method start] is called. + If [code]true[/code] the timer is paused and will not process until it is unpaused again, even if [method start] is called. - Processing mode. Uses TIMER_PROCESS_* constants as value. + Processing mode. See [enum TimerProcessMode]. The timer's remaining time in seconds. Returns 0 if the timer is inactive. + Note: You cannot set this value. To change the timer's remaining time, use [member wait_time]. Wait time in seconds. @@ -57,16 +58,16 @@ - Emitted when the Timer reaches 0. + Emitted when the timer reaches 0. - Update the Timer during the physics step at each frame (fixed framerate processing). + Update the timer during the physics step at each frame (fixed framerate processing). - Update the Timer during the idle time at each frame. + Update the timer during the idle time at each frame.