2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name= "CollisionObject2D" inherits= "Node2D" version= "4.0" >
2017-09-12 20:42:36 +00:00
<brief_description >
2017-09-24 02:47:13 +00:00
Base node for 2D collision objects.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2017-10-21 10:33:50 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "_input_event" qualifiers= "virtual" >
<return type= "void" >
</return>
<argument index= "0" name= "viewport" type= "Object" >
</argument>
<argument index= "1" name= "event" type= "InputEvent" >
</argument>
<argument index= "2" name= "shape_idx" type= "int" >
</argument>
<description >
2019-07-21 07:57:36 +00:00
Accepts unhandled [InputEvent]s. Requires [member input_pickable] to be [code]true[/code]. [code]shape_idx[/code] is the child index of the clicked [Shape2D]. Connect to the [code]input_event[/code] signal to easily pick up these events.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "create_shape_owner" >
<return type= "int" >
</return>
<argument index= "0" name= "owner" type= "Object" >
</argument>
<description >
2017-09-24 02:47:13 +00:00
Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-10-13 13:09:31 +00:00
<method name= "get_collision_layer_bit" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "bit" type= "int" >
</argument>
<description >
Returns whether or not the specified [code]bit[/code] of the [member collision_layer] is set.
</description>
</method>
<method name= "get_collision_mask_bit" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "bit" type= "int" >
</argument>
<description >
Returns whether or not the specified [code]bit[/code] of the [member collision_mask] is set.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_rid" qualifiers= "const" >
<return type= "RID" >
</return>
<description >
2017-09-24 02:47:13 +00:00
Returns the object's [RID].
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-01-26 21:21:53 +00:00
<method name= "get_shape_owner_one_way_collision_margin" qualifiers= "const" >
<return type= "float" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<description >
2020-01-13 22:08:42 +00:00
Returns the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code].
2019-01-26 21:21:53 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_shape_owners" >
<return type= "Array" >
</return>
<description >
2017-09-24 02:47:13 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_shape_owner_disabled" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<description >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the shape owner and its shapes are disabled.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_shape_owner_one_way_collision_enabled" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<description >
2019-03-29 22:37:35 +00:00
Returns [code]true[/code] if collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "remove_shape_owner" >
<return type= "void" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<description >
2017-09-24 02:47:13 +00:00
Removes the given shape owner.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-10-13 13:09:31 +00:00
<method name= "set_collision_layer_bit" >
<return type= "void" >
</return>
<argument index= "0" name= "bit" type= "int" >
</argument>
<argument index= "1" name= "value" type= "bool" >
</argument>
<description >
If [code]value[/value] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_layer].
If [code]value[/value] is [code]false[/code], clears the specified [code]bit[/code] in the the [member collision_layer].
</description>
</method>
<method name= "set_collision_mask_bit" >
<return type= "void" >
</return>
<argument index= "0" name= "bit" type= "int" >
</argument>
<argument index= "1" name= "value" type= "bool" >
</argument>
<description >
If [code]value[/value] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_mask].
If [code]value[/value] is [code]false[/code], clears the specified [code]bit[/code] in the the [member collision_mask].
</description>
</method>
2021-04-29 10:10:58 +00:00
<method name= "shape_find_owner" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "shape_index" type= "int" >
</argument>
<description >
Returns the [code]owner_id[/code] of the given shape.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "shape_owner_add_shape" >
<return type= "void" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<argument index= "1" name= "shape" type= "Shape2D" >
</argument>
<description >
2017-09-24 02:47:13 +00:00
Adds a [Shape2D] to the shape owner.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shape_owner_clear_shapes" >
<return type= "void" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<description >
2017-09-24 02:47:13 +00:00
Removes all shapes from the shape owner.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shape_owner_get_owner" qualifiers= "const" >
<return type= "Object" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<description >
2017-09-24 02:47:13 +00:00
Returns the parent object of the given shape owner.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shape_owner_get_shape" qualifiers= "const" >
<return type= "Shape2D" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<argument index= "1" name= "shape_id" type= "int" >
</argument>
<description >
2017-09-24 02:47:13 +00:00
Returns the [Shape2D] with the given id from the given shape owner.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shape_owner_get_shape_count" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<description >
2017-09-24 02:47:13 +00:00
Returns the number of shapes the given shape owner contains.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shape_owner_get_shape_index" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<argument index= "1" name= "shape_id" type= "int" >
</argument>
<description >
2017-12-07 19:17:08 +00:00
Returns the child index of the [Shape2D] with the given id from the given shape owner.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shape_owner_get_transform" qualifiers= "const" >
<return type= "Transform2D" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<description >
2017-09-24 02:47:13 +00:00
Returns the shape owner's [Transform2D].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shape_owner_remove_shape" >
<return type= "void" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<argument index= "1" name= "shape_id" type= "int" >
</argument>
<description >
2017-09-24 02:47:13 +00:00
Removes a shape from the given shape owner.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shape_owner_set_disabled" >
<return type= "void" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<argument index= "1" name= "disabled" type= "bool" >
</argument>
<description >
2018-12-20 12:46:54 +00:00
If [code]true[/code], disables the given shape owner.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shape_owner_set_one_way_collision" >
<return type= "void" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<argument index= "1" name= "enable" type= "bool" >
</argument>
<description >
2019-03-29 22:37:35 +00:00
If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s.
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-01-26 21:21:53 +00:00
<method name= "shape_owner_set_one_way_collision_margin" >
<return type= "void" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<argument index= "1" name= "margin" type= "float" >
</argument>
<description >
2020-01-13 22:08:42 +00:00
Sets the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code] to [code]margin[/code] pixels.
2019-01-26 21:21:53 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "shape_owner_set_transform" >
<return type= "void" >
</return>
<argument index= "0" name= "owner_id" type= "int" >
</argument>
<argument index= "1" name= "transform" type= "Transform2D" >
</argument>
<description >
2017-09-24 02:47:13 +00:00
Sets the [Transform2D] of the given shape owner.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members >
2020-10-13 13:09:31 +00:00
<member name= "collision_layer" type= "int" setter= "set_collision_layer" getter= "get_collision_layer" default= "1" >
The physics layers this CollisionObject2D is in. Collision objects can exist in one or more of 32 different layers. See also [member collision_mask].
[b]Note:[/b] A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.
</member>
<member name= "collision_mask" type= "int" setter= "set_collision_mask" getter= "get_collision_mask" default= "1" >
The physics layers this CollisionObject2D scans. Collision objects can scan one or more of 32 different layers. See also [member collision_layer].
[b]Note:[/b] A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.
</member>
2021-06-18 01:09:40 +00:00
<member name= "disable_mode" type= "int" setter= "set_disable_mode" getter= "get_disable_mode" enum= "CollisionObject2D.DisableMode" default= "0" >
Defines the behavior in physics when [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED]. See [enum DisableMode] for more details about the different modes.
</member>
2020-07-15 06:43:21 +00:00
<member name= "input_pickable" type= "bool" setter= "set_pickable" getter= "is_pickable" default= "true" >
2020-07-27 20:45:01 +00:00
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. Requires at least one [code]collision_layer[/code] bit to be set.
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals >
<signal name= "input_event" >
2018-09-01 10:05:51 +00:00
<argument index= "0" name= "viewport" type= "Node" >
2017-09-12 20:42:36 +00:00
</argument>
2018-08-31 19:12:35 +00:00
<argument index= "1" name= "event" type= "InputEvent" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "2" name= "shape_idx" type= "int" >
</argument>
<description >
2020-07-27 20:45:01 +00:00
Emitted when an input event occurs. Requires [member input_pickable] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. See [method _input_event] for details.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name= "mouse_entered" >
<description >
2020-07-27 20:45:01 +00:00
Emitted when the mouse pointer enters any of this object's shapes. Requires [member input_pickable] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name= "mouse_exited" >
<description >
2020-07-27 20:45:01 +00:00
Emitted when the mouse pointer exits all this object's shapes. Requires [member input_pickable] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
<constants >
2021-06-18 01:09:40 +00:00
<constant name= "DISABLE_MODE_REMOVE" value= "0" enum= "DisableMode" >
When [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED], remove from the physics simulation to stop all physics interactions with this [CollisionObject2D].
Automatically re-added to the physics simulation when the [Node] is processed again.
</constant>
<constant name= "DISABLE_MODE_MAKE_STATIC" value= "1" enum= "DisableMode" >
When [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED], make the body static. Doesn't affect [Area2D]. [PhysicsBody2D] can't be affected by forces or other bodies while static.
Automatically set [PhysicsBody2D] back to its original mode when the [Node] is processed again.
</constant>
<constant name= "DISABLE_MODE_KEEP_ACTIVE" value= "2" enum= "DisableMode" >
When [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED], do not affect the physics simulation.
</constant>
2017-09-12 20:42:36 +00:00
</constants>
</class>
