diff --git a/doc/classes/CollisionObject.xml b/doc/classes/CollisionObject.xml index 98023a58989..64e9e079255 100644 --- a/doc/classes/CollisionObject.xml +++ b/doc/classes/CollisionObject.xml @@ -1,8 +1,10 @@ + Base node for collision objects. + CollisionObject is the base class for physics objects. It can hold any number of collision [Shape]\ s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods. @@ -31,7 +33,7 @@ - Creates new holder for the shapes. Argument is a [CollisionShape] node. It will return owner_id which usually you will want to save for later use. + Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference. @@ -44,13 +46,14 @@ + Returns the object's [RID]. - Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods. + Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument. @@ -65,6 +68,7 @@ + If [code]true[/code] the shape owner and its shapes are disabled. @@ -73,6 +77,7 @@ + Removes the given shape owner. @@ -97,6 +102,7 @@ + Returns the [code]owner_id[/code] of the given shape. @@ -107,6 +113,7 @@ + Adds a [Shape] to the shape owner. @@ -115,7 +122,7 @@ - Will remove all the shapes associated with given owner. + Removes all shapes from the shape owner. @@ -124,6 +131,7 @@ + Returns the parent object of the given shape owner. @@ -134,7 +142,7 @@ - Will return a [Shape]. First argument owner_id is an integer that can be obtained from [method get_shape_owners]. Shape_id is a position of the shape inside owner; it's a value in range from 0 to [method shape_owner_get_shape_count]. + Returns the [Shape] with the given id from the given shape owner. @@ -143,7 +151,7 @@ - Returns number of shapes to which given owner is associated to. + Returns the number of shapes the given shape owner contains. @@ -162,7 +170,7 @@ - Will return [Transform] of an owner node. + Returns the shape owner's [Transform]. @@ -173,7 +181,7 @@ - Removes related shape from the owner. + Removes a shape from the given shape owner. @@ -184,6 +192,7 @@ + If [code]true[/code] disables the given shape owner. @@ -194,6 +203,7 @@ + Sets the [Transform] of the given shape owner. @@ -220,10 +230,12 @@ + Emitted when the mouse pointer enters any of this object's shapes. + Emitted when the mouse pointer exits all this object's shapes. diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index db1412805fa..52743bd37d0 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -1,10 +1,10 @@ - Base node for 2D collisionables. + Base node for 2D collision objects. - CollisionObject2D is the base class for 2D physics collisionables. They can hold any number of 2D collision shapes. Usually, they are edited by placing [CollisionShape2D] and/or [CollisionPolygon2D] nodes as children. Such nodes are for reference and not present outside the editor, so code should use the regular shape API. + CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision [Shape2D]\ s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods. @@ -29,21 +29,21 @@ - Creates new holder for the shapes. Argument is a [CollisionShape2D] node. It will return owner_id which usually you will want to save for later use. + Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference. - Return the RID of this object. + Returns the object's [RID]. - Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods. + Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument. @@ -59,6 +59,7 @@ + If [code]true[/code] the shape owner and its shapes are disabled. @@ -75,6 +76,7 @@ + Removes the given shape owner. @@ -92,6 +94,7 @@ + Returns the [code]owner_id[/code] of the given shape. @@ -102,6 +105,7 @@ + Adds a [Shape2D] to the shape owner. @@ -110,7 +114,7 @@ - Will remove all the shapes associated with given owner. + Removes all shapes from the shape owner. @@ -119,6 +123,7 @@ + Returns the parent object of the given shape owner. @@ -129,7 +134,7 @@ - Will return a [Shape2D]. First argument owner_id is an integer that can be obtained from [method get_shape_owners]. Shape_id is a position of the shape inside owner; it's a value in range from 0 to [method shape_owner_get_shape_count]. + Returns the [Shape2D] with the given id from the given shape owner. @@ -138,7 +143,7 @@ - Returns number of shapes to which given owner is associated to. + Returns the number of shapes the given shape owner contains. @@ -157,7 +162,7 @@ - Will return [Transform2D] of an owner node. + Returns the shape owner's [Transform2D]. @@ -168,7 +173,7 @@ - Removes related shape from the owner. + Removes a shape from the given shape owner. @@ -179,6 +184,7 @@ + If [code]true[/code] disables the given shape owner. @@ -199,11 +205,13 @@ + Sets the [Transform2D] of the given shape owner. + If [code]true[/code] this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. @@ -215,16 +223,17 @@ + Emitted when an input event occurs and [code]input_pickable[/code] is [code]true[/code]. - This event fires only once when the mouse pointer enters any shape of this object. + Emitted when the mouse pointer enters any of this object's shapes. - This event fires only once when the mouse pointer exits all shapes of this object. + Emitted when the mouse pointer exits all this object's shapes.