f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
236 lines
11 KiB
XML
236 lines
11 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="CollisionObject2D" inherits="Node2D" version="3.4">
|
|
<brief_description>
|
|
Base node for 2D collision objects.
|
|
</brief_description>
|
|
<description>
|
|
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.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="_input_event" qualifiers="virtual">
|
|
<return type="void" />
|
|
<argument index="0" name="viewport" type="Object" />
|
|
<argument index="1" name="event" type="InputEvent" />
|
|
<argument index="2" name="shape_idx" type="int" />
|
|
<description>
|
|
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.
|
|
</description>
|
|
</method>
|
|
<method name="create_shape_owner">
|
|
<return type="int" />
|
|
<argument index="0" name="owner" type="Object" />
|
|
<description>
|
|
Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference.
|
|
</description>
|
|
</method>
|
|
<method name="get_collision_layer_bit" qualifiers="const">
|
|
<return type="bool" />
|
|
<argument index="0" name="bit" type="int" />
|
|
<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" />
|
|
<argument index="0" name="bit" type="int" />
|
|
<description>
|
|
Returns whether or not the specified [code]bit[/code] of the [member collision_mask] is set.
|
|
</description>
|
|
</method>
|
|
<method name="get_rid" qualifiers="const">
|
|
<return type="RID" />
|
|
<description>
|
|
Returns the object's [RID].
|
|
</description>
|
|
</method>
|
|
<method name="get_shape_owner_one_way_collision_margin" qualifiers="const">
|
|
<return type="float" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<description>
|
|
Returns the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code].
|
|
</description>
|
|
</method>
|
|
<method name="get_shape_owners">
|
|
<return type="Array" />
|
|
<description>
|
|
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.
|
|
</description>
|
|
</method>
|
|
<method name="is_shape_owner_disabled" qualifiers="const">
|
|
<return type="bool" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<description>
|
|
If [code]true[/code], the shape owner and its shapes are disabled.
|
|
</description>
|
|
</method>
|
|
<method name="is_shape_owner_one_way_collision_enabled" qualifiers="const">
|
|
<return type="bool" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<description>
|
|
Returns [code]true[/code] if collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s.
|
|
</description>
|
|
</method>
|
|
<method name="remove_shape_owner">
|
|
<return type="void" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<description>
|
|
Removes the given shape owner.
|
|
</description>
|
|
</method>
|
|
<method name="set_collision_layer_bit">
|
|
<return type="void" />
|
|
<argument index="0" name="bit" type="int" />
|
|
<argument index="1" name="value" type="bool" />
|
|
<description>
|
|
If [code]value[/code] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_layer].
|
|
If [code]value[/code] 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" />
|
|
<argument index="0" name="bit" type="int" />
|
|
<argument index="1" name="value" type="bool" />
|
|
<description>
|
|
If [code]value[/code] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_mask].
|
|
If [code]value[/code] is [code]false[/code], clears the specified [code]bit[/code] in the the [member collision_mask].
|
|
</description>
|
|
</method>
|
|
<method name="shape_find_owner" qualifiers="const">
|
|
<return type="int" />
|
|
<argument index="0" name="shape_index" type="int" />
|
|
<description>
|
|
Returns the [code]owner_id[/code] of the given shape.
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_add_shape">
|
|
<return type="void" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<argument index="1" name="shape" type="Shape2D" />
|
|
<description>
|
|
Adds a [Shape2D] to the shape owner.
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_clear_shapes">
|
|
<return type="void" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<description>
|
|
Removes all shapes from the shape owner.
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_get_owner" qualifiers="const">
|
|
<return type="Object" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<description>
|
|
Returns the parent object of the given shape owner.
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_get_shape" qualifiers="const">
|
|
<return type="Shape2D" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<argument index="1" name="shape_id" type="int" />
|
|
<description>
|
|
Returns the [Shape2D] with the given id from the given shape owner.
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_get_shape_count" qualifiers="const">
|
|
<return type="int" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<description>
|
|
Returns the number of shapes the given shape owner contains.
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_get_shape_index" qualifiers="const">
|
|
<return type="int" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<argument index="1" name="shape_id" type="int" />
|
|
<description>
|
|
Returns the child index of the [Shape2D] with the given id from the given shape owner.
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_get_transform" qualifiers="const">
|
|
<return type="Transform2D" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<description>
|
|
Returns the shape owner's [Transform2D].
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_remove_shape">
|
|
<return type="void" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<argument index="1" name="shape_id" type="int" />
|
|
<description>
|
|
Removes a shape from the given shape owner.
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_set_disabled">
|
|
<return type="void" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<argument index="1" name="disabled" type="bool" />
|
|
<description>
|
|
If [code]true[/code], disables the given shape owner.
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_set_one_way_collision">
|
|
<return type="void" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<argument index="1" name="enable" type="bool" />
|
|
<description>
|
|
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.
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_set_one_way_collision_margin">
|
|
<return type="void" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<argument index="1" name="margin" type="float" />
|
|
<description>
|
|
Sets the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code] to [code]margin[/code] pixels.
|
|
</description>
|
|
</method>
|
|
<method name="shape_owner_set_transform">
|
|
<return type="void" />
|
|
<argument index="0" name="owner_id" type="int" />
|
|
<argument index="1" name="transform" type="Transform2D" />
|
|
<description>
|
|
Sets the [Transform2D] of the given shape owner.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<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>
|
|
<member name="input_pickable" type="bool" setter="set_pickable" getter="is_pickable" default="true">
|
|
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.
|
|
</member>
|
|
</members>
|
|
<signals>
|
|
<signal name="input_event">
|
|
<argument index="0" name="viewport" type="Node" />
|
|
<argument index="1" name="event" type="InputEvent" />
|
|
<argument index="2" name="shape_idx" type="int" />
|
|
<description>
|
|
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.
|
|
</description>
|
|
</signal>
|
|
<signal name="mouse_entered">
|
|
<description>
|
|
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.
|
|
</description>
|
|
</signal>
|
|
<signal name="mouse_exited">
|
|
<description>
|
|
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.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
</constants>
|
|
</class>
|