summaryrefslogtreecommitdiff
path: root/doc/classes/PhysicsServer2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/PhysicsServer2D.xml')
-rw-r--r--doc/classes/PhysicsServer2D.xml388
1 files changed, 194 insertions, 194 deletions
diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml
index 1413a3ec11..4bb44223b3 100644
--- a/doc/classes/PhysicsServer2D.xml
+++ b/doc/classes/PhysicsServer2D.xml
@@ -11,32 +11,32 @@
<methods>
<method name="area_add_shape">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="shape" type="RID" />
- <argument index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" />
- <argument index="3" name="disabled" type="bool" default="false" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="shape" type="RID" />
+ <param index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" />
+ <param index="3" name="disabled" type="bool" default="false" />
<description>
Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
</description>
</method>
<method name="area_attach_canvas_instance_id">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="id" type="int" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="id" type="int" />
<description>
</description>
</method>
<method name="area_attach_object_instance_id">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="id" type="int" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="id" type="int" />
<description>
Assigns the area to a descendant of [Object], so it can exist in the node tree.
</description>
</method>
<method name="area_clear_shapes">
<return type="void" />
- <argument index="0" name="area" type="RID" />
+ <param index="0" name="area" type="RID" />
<description>
Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
</description>
@@ -49,97 +49,97 @@
</method>
<method name="area_get_canvas_instance_id" qualifiers="const">
<return type="int" />
- <argument index="0" name="area" type="RID" />
+ <param index="0" name="area" type="RID" />
<description>
</description>
</method>
<method name="area_get_object_instance_id" qualifiers="const">
<return type="int" />
- <argument index="0" name="area" type="RID" />
+ <param index="0" name="area" type="RID" />
<description>
Gets the instance ID of the object the area is assigned to.
</description>
</method>
<method name="area_get_param" qualifiers="const">
<return type="Variant" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="param" type="int" enum="PhysicsServer2D.AreaParameter" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="param" type="int" enum="PhysicsServer2D.AreaParameter" />
<description>
Returns an area parameter value. See [enum AreaParameter] for a list of available parameters.
</description>
</method>
<method name="area_get_shape" qualifiers="const">
<return type="RID" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
<description>
Returns the [RID] of the nth shape of an area.
</description>
</method>
<method name="area_get_shape_count" qualifiers="const">
<return type="int" />
- <argument index="0" name="area" type="RID" />
+ <param index="0" name="area" type="RID" />
<description>
Returns the number of shapes assigned to an area.
</description>
</method>
<method name="area_get_shape_transform" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
<description>
Returns the transform matrix of a shape within an area.
</description>
</method>
<method name="area_get_space" qualifiers="const">
<return type="RID" />
- <argument index="0" name="area" type="RID" />
+ <param index="0" name="area" type="RID" />
<description>
Returns the space assigned to the area.
</description>
</method>
<method name="area_get_transform" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="area" type="RID" />
+ <param index="0" name="area" type="RID" />
<description>
Returns the transform matrix for an area.
</description>
</method>
<method name="area_remove_shape">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
<description>
Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
</description>
</method>
<method name="area_set_area_monitor_callback">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="callback" type="Callable" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="callback" type="Callable" />
<description>
</description>
</method>
<method name="area_set_collision_layer">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="layer" type="int" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="layer" type="int" />
<description>
Assigns the area to one or many physics layers.
</description>
</method>
<method name="area_set_collision_mask">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="mask" type="int" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="mask" type="int" />
<description>
Sets which physics layers the area will monitor.
</description>
</method>
<method name="area_set_monitor_callback">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="callback" type="Callable" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="callback" type="Callable" />
<description>
Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters:
1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area.
@@ -151,75 +151,75 @@
</method>
<method name="area_set_monitorable">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="monitorable" type="bool" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="monitorable" type="bool" />
<description>
</description>
</method>
<method name="area_set_param">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="param" type="int" enum="PhysicsServer2D.AreaParameter" />
- <argument index="2" name="value" type="Variant" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="param" type="int" enum="PhysicsServer2D.AreaParameter" />
+ <param index="2" name="value" type="Variant" />
<description>
Sets the value for an area parameter. See [enum AreaParameter] for a list of available parameters.
</description>
</method>
<method name="area_set_shape">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
- <argument index="2" name="shape" type="RID" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
+ <param index="2" name="shape" type="RID" />
<description>
Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID].
</description>
</method>
<method name="area_set_shape_disabled">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
- <argument index="2" name="disabled" type="bool" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
+ <param index="2" name="disabled" type="bool" />
<description>
Disables a given shape in an area.
</description>
</method>
<method name="area_set_shape_transform">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
- <argument index="2" name="transform" type="Transform2D" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
+ <param index="2" name="transform" type="Transform2D" />
<description>
Sets the transform matrix for an area shape.
</description>
</method>
<method name="area_set_space">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="space" type="RID" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="space" type="RID" />
<description>
Assigns a space to the area.
</description>
</method>
<method name="area_set_transform">
<return type="void" />
- <argument index="0" name="area" type="RID" />
- <argument index="1" name="transform" type="Transform2D" />
+ <param index="0" name="area" type="RID" />
+ <param index="1" name="transform" type="Transform2D" />
<description>
Sets the transform matrix for an area.
</description>
</method>
<method name="body_add_collision_exception">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="excepted_body" type="RID" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="excepted_body" type="RID" />
<description>
Adds a body to the list of bodies exempt from collisions.
</description>
</method>
<method name="body_add_constant_central_force">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="force" type="Vector2" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="force" type="Vector2" />
<description>
Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]body_set_constant_force(body, Vector2(0, 0))[/code].
This is equivalent to using [method body_add_constant_force] at the body's center of mass.
@@ -227,9 +227,9 @@
</method>
<method name="body_add_constant_force">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="force" type="Vector2" />
- <argument index="2" name="position" type="Vector2" default="Vector2(0, 0)" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="force" type="Vector2" />
+ <param index="2" name="position" type="Vector2" default="Vector2(0, 0)" />
<description>
Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]body_set_constant_force(body, Vector2(0, 0))[/code].
[code]position[/code] is the offset from the body origin in global coordinates.
@@ -237,26 +237,26 @@
</method>
<method name="body_add_constant_torque">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="torque" type="float" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="torque" type="float" />
<description>
Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]body_set_constant_torque(body, 0)[/code].
</description>
</method>
<method name="body_add_shape">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="shape" type="RID" />
- <argument index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" />
- <argument index="3" name="disabled" type="bool" default="false" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="shape" type="RID" />
+ <param index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" />
+ <param index="3" name="disabled" type="bool" default="false" />
<description>
Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
</description>
</method>
<method name="body_apply_central_force">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="force" type="Vector2" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="force" type="Vector2" />
<description>
Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
This is equivalent to using [method body_apply_force] at the body's center of mass.
@@ -264,8 +264,8 @@
</method>
<method name="body_apply_central_impulse">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="impulse" type="Vector2" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="impulse" type="Vector2" />
<description>
Applies a directional impulse without affecting rotation.
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
@@ -274,9 +274,9 @@
</method>
<method name="body_apply_force">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="force" type="Vector2" />
- <argument index="2" name="position" type="Vector2" default="Vector2(0, 0)" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="force" type="Vector2" />
+ <param index="2" name="position" type="Vector2" default="Vector2(0, 0)" />
<description>
Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
[code]position[/code] is the offset from the body origin in global coordinates.
@@ -284,9 +284,9 @@
</method>
<method name="body_apply_impulse">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="impulse" type="Vector2" />
- <argument index="2" name="position" type="Vector2" default="Vector2(0, 0)" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="impulse" type="Vector2" />
+ <param index="2" name="position" type="Vector2" default="Vector2(0, 0)" />
<description>
Applies a positioned impulse to the body.
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
@@ -295,16 +295,16 @@
</method>
<method name="body_apply_torque">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="torque" type="float" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="torque" type="float" />
<description>
Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
</description>
</method>
<method name="body_apply_torque_impulse">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="impulse" type="float" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="impulse" type="float" />
<description>
Applies a rotational impulse to the body without affecting the position.
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
@@ -312,22 +312,22 @@
</method>
<method name="body_attach_canvas_instance_id">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="id" type="int" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="id" type="int" />
<description>
</description>
</method>
<method name="body_attach_object_instance_id">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="id" type="int" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="id" type="int" />
<description>
Assigns the area to a descendant of [Object], so it can exist in the node tree.
</description>
</method>
<method name="body_clear_shapes">
<return type="void" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Removes all shapes from a body.
</description>
@@ -340,27 +340,27 @@
</method>
<method name="body_get_canvas_instance_id" qualifiers="const">
<return type="int" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
</description>
</method>
<method name="body_get_collision_layer" qualifiers="const">
<return type="int" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Returns the physics layer or layers a body belongs to.
</description>
</method>
<method name="body_get_collision_mask" qualifiers="const">
<return type="int" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Returns the physics layer or layers a body can collide with.
</description>
</method>
<method name="body_get_constant_force" qualifiers="const">
<return type="Vector2" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Returns the body's total constant positional forces applied during each physics update.
See [method body_add_constant_force] and [method body_add_constant_central_force].
@@ -368,7 +368,7 @@
</method>
<method name="body_get_constant_torque" qualifiers="const">
<return type="float" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Returns the body's total constant rotational forces applied during each physics update.
See [method body_add_constant_torque].
@@ -376,143 +376,143 @@
</method>
<method name="body_get_continuous_collision_detection_mode" qualifiers="const">
<return type="int" enum="PhysicsServer2D.CCDMode" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Returns the continuous collision detection mode.
</description>
</method>
<method name="body_get_direct_state">
<return type="PhysicsDirectBodyState2D" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Returns the [PhysicsDirectBodyState2D] of the body. Returns [code]null[/code] if the body is destroyed or removed from the physics space.
</description>
</method>
<method name="body_get_max_contacts_reported" qualifiers="const">
<return type="int" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported].
</description>
</method>
<method name="body_get_mode" qualifiers="const">
<return type="int" enum="PhysicsServer2D.BodyMode" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Returns the body mode.
</description>
</method>
<method name="body_get_object_instance_id" qualifiers="const">
<return type="int" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Gets the instance ID of the object the area is assigned to.
</description>
</method>
<method name="body_get_param" qualifiers="const">
<return type="Variant" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="param" type="int" enum="PhysicsServer2D.BodyParameter" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="param" type="int" enum="PhysicsServer2D.BodyParameter" />
<description>
Returns the value of a body parameter. See [enum BodyParameter] for a list of available parameters.
</description>
</method>
<method name="body_get_shape" qualifiers="const">
<return type="RID" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
<description>
Returns the [RID] of the nth shape of a body.
</description>
</method>
<method name="body_get_shape_count" qualifiers="const">
<return type="int" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Returns the number of shapes assigned to a body.
</description>
</method>
<method name="body_get_shape_transform" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
<description>
Returns the transform matrix of a body shape.
</description>
</method>
<method name="body_get_space" qualifiers="const">
<return type="RID" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Returns the [RID] of the space assigned to a body.
</description>
</method>
<method name="body_get_state" qualifiers="const">
<return type="Variant" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="state" type="int" enum="PhysicsServer2D.BodyState" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="state" type="int" enum="PhysicsServer2D.BodyState" />
<description>
Returns a body state.
</description>
</method>
<method name="body_is_omitting_force_integration" qualifiers="const">
<return type="bool" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).
</description>
</method>
<method name="body_remove_collision_exception">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="excepted_body" type="RID" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="excepted_body" type="RID" />
<description>
Removes a body from the list of bodies exempt from collisions.
</description>
</method>
<method name="body_remove_shape">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
<description>
Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
</description>
</method>
<method name="body_reset_mass_properties">
<return type="void" />
- <argument index="0" name="body" type="RID" />
+ <param index="0" name="body" type="RID" />
<description>
Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using [method body_set_param].
</description>
</method>
<method name="body_set_axis_velocity">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="axis_velocity" type="Vector2" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="axis_velocity" type="Vector2" />
<description>
Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
</description>
</method>
<method name="body_set_collision_layer">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="layer" type="int" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="layer" type="int" />
<description>
Sets the physics layer or layers a body belongs to.
</description>
</method>
<method name="body_set_collision_mask">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="mask" type="int" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="mask" type="int" />
<description>
Sets the physics layer or layers a body can collide with.
</description>
</method>
<method name="body_set_constant_force">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="force" type="Vector2" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="force" type="Vector2" />
<description>
Sets the body's total constant positional forces applied during each physics update.
See [method body_add_constant_force] and [method body_add_constant_central_force].
@@ -520,8 +520,8 @@
</method>
<method name="body_set_constant_torque">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="torque" type="float" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="torque" type="float" />
<description>
Sets the body's total constant rotational forces applied during each physics update.
See [method body_add_constant_torque].
@@ -529,8 +529,8 @@
</method>
<method name="body_set_continuous_collision_detection_mode">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="mode" type="int" enum="PhysicsServer2D.CCDMode" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="mode" type="int" enum="PhysicsServer2D.CCDMode" />
<description>
Sets the continuous collision detection mode using one of the [enum CCDMode] constants.
Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
@@ -538,9 +538,9 @@
</method>
<method name="body_set_force_integration_callback">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="callable" type="Callable" />
- <argument index="2" name="userdata" type="Variant" default="null" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="callable" type="Callable" />
+ <param index="2" name="userdata" type="Variant" default="null" />
<description>
Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]).
The force integration function takes 2 arguments:
@@ -550,87 +550,87 @@
</method>
<method name="body_set_max_contacts_reported">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="amount" type="int" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="amount" type="int" />
<description>
Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
</description>
</method>
<method name="body_set_mode">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="mode" type="int" enum="PhysicsServer2D.BodyMode" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="mode" type="int" enum="PhysicsServer2D.BodyMode" />
<description>
Sets the body mode using one of the [enum BodyMode] constants.
</description>
</method>
<method name="body_set_omit_force_integration">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).
</description>
</method>
<method name="body_set_param">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="param" type="int" enum="PhysicsServer2D.BodyParameter" />
- <argument index="2" name="value" type="Variant" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="param" type="int" enum="PhysicsServer2D.BodyParameter" />
+ <param index="2" name="value" type="Variant" />
<description>
Sets a body parameter. See [enum BodyParameter] for a list of available parameters.
</description>
</method>
<method name="body_set_shape">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
- <argument index="2" name="shape" type="RID" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
+ <param index="2" name="shape" type="RID" />
<description>
Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID].
</description>
</method>
<method name="body_set_shape_as_one_way_collision">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
- <argument index="2" name="enable" type="bool" />
- <argument index="3" name="margin" type="float" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
+ <param index="2" name="enable" type="bool" />
+ <param index="3" name="margin" type="float" />
<description>
Enables one way collision on body if [code]enable[/code] is [code]true[/code].
</description>
</method>
<method name="body_set_shape_disabled">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
- <argument index="2" name="disabled" type="bool" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
+ <param index="2" name="disabled" type="bool" />
<description>
Disables shape in body if [code]disable[/code] is [code]true[/code].
</description>
</method>
<method name="body_set_shape_transform">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="shape_idx" type="int" />
- <argument index="2" name="transform" type="Transform2D" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="shape_idx" type="int" />
+ <param index="2" name="transform" type="Transform2D" />
<description>
Sets the transform matrix for a body shape.
</description>
</method>
<method name="body_set_space">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="space" type="RID" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="space" type="RID" />
<description>
Assigns a space to the body (see [method space_create]).
</description>
</method>
<method name="body_set_state">
<return type="void" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="state" type="int" enum="PhysicsServer2D.BodyState" />
- <argument index="2" name="value" type="Variant" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="state" type="int" enum="PhysicsServer2D.BodyState" />
+ <param index="2" name="value" type="Variant" />
<description>
Sets a body state using one of the [enum BodyState] constants.
Note that the method doesn't take effect immediately. The state will change on the next physics frame.
@@ -638,9 +638,9 @@
</method>
<method name="body_test_motion">
<return type="bool" />
- <argument index="0" name="body" type="RID" />
- <argument index="1" name="parameters" type="PhysicsTestMotionParameters2D" />
- <argument index="2" name="result" type="PhysicsTestMotionResult2D" default="null" />
+ <param index="0" name="body" type="RID" />
+ <param index="1" name="parameters" type="PhysicsTestMotionParameters2D" />
+ <param index="2" name="result" type="PhysicsTestMotionResult2D" default="null" />
<description>
Returns [code]true[/code] if a collision would result from moving along a motion vector from a given point in space. [PhysicsTestMotionParameters2D] is passed to set motion parameters. [PhysicsTestMotionResult2D] can be passed to return additional information.
</description>
@@ -667,38 +667,38 @@
</method>
<method name="damped_spring_joint_get_param" qualifiers="const">
<return type="float" />
- <argument index="0" name="joint" type="RID" />
- <argument index="1" name="param" type="int" enum="PhysicsServer2D.DampedSpringParam" />
+ <param index="0" name="joint" type="RID" />
+ <param index="1" name="param" type="int" enum="PhysicsServer2D.DampedSpringParam" />
<description>
Returns the value of a damped spring joint parameter. See [enum DampedSpringParam] for a list of available parameters.
</description>
</method>
<method name="damped_spring_joint_set_param">
<return type="void" />
- <argument index="0" name="joint" type="RID" />
- <argument index="1" name="param" type="int" enum="PhysicsServer2D.DampedSpringParam" />
- <argument index="2" name="value" type="float" />
+ <param index="0" name="joint" type="RID" />
+ <param index="1" name="param" type="int" enum="PhysicsServer2D.DampedSpringParam" />
+ <param index="2" name="value" type="float" />
<description>
Sets a damped spring joint parameter. See [enum DampedSpringParam] for a list of available parameters.
</description>
</method>
<method name="free_rid">
<return type="void" />
- <argument index="0" name="rid" type="RID" />
+ <param index="0" name="rid" type="RID" />
<description>
Destroys any of the objects created by PhysicsServer2D. If the [RID] passed is not one of the objects that can be created by PhysicsServer2D, an error will be sent to the console.
</description>
</method>
<method name="get_process_info">
<return type="int" />
- <argument index="0" name="process_info" type="int" enum="PhysicsServer2D.ProcessInfo" />
+ <param index="0" name="process_info" type="int" enum="PhysicsServer2D.ProcessInfo" />
<description>
Returns information about the current state of the 2D physics engine. See [enum ProcessInfo] for a list of available states.
</description>
</method>
<method name="joint_clear">
<return type="void" />
- <argument index="0" name="joint" type="RID" />
+ <param index="0" name="joint" type="RID" />
<description>
</description>
</method>
@@ -709,54 +709,54 @@
</method>
<method name="joint_get_param" qualifiers="const">
<return type="float" />
- <argument index="0" name="joint" type="RID" />
- <argument index="1" name="param" type="int" enum="PhysicsServer2D.JointParam" />
+ <param index="0" name="joint" type="RID" />
+ <param index="1" name="param" type="int" enum="PhysicsServer2D.JointParam" />
<description>
Returns the value of a joint parameter.
</description>
</method>
<method name="joint_get_type" qualifiers="const">
<return type="int" enum="PhysicsServer2D.JointType" />
- <argument index="0" name="joint" type="RID" />
+ <param index="0" name="joint" type="RID" />
<description>
Returns a joint's type (see [enum JointType]).
</description>
</method>
<method name="joint_make_damped_spring">
<return type="void" />
- <argument index="0" name="joint" type="RID" />
- <argument index="1" name="anchor_a" type="Vector2" />
- <argument index="2" name="anchor_b" type="Vector2" />
- <argument index="3" name="body_a" type="RID" />
- <argument index="4" name="body_b" type="RID" />
+ <param index="0" name="joint" type="RID" />
+ <param index="1" name="anchor_a" type="Vector2" />
+ <param index="2" name="anchor_b" type="Vector2" />
+ <param index="3" name="body_a" type="RID" />
+ <param index="4" name="body_b" type="RID" />
<description>
</description>
</method>
<method name="joint_make_groove">
<return type="void" />
- <argument index="0" name="joint" type="RID" />
- <argument index="1" name="groove1_a" type="Vector2" />
- <argument index="2" name="groove2_a" type="Vector2" />
- <argument index="3" name="anchor_b" type="Vector2" />
- <argument index="4" name="body_a" type="RID" />
- <argument index="5" name="body_b" type="RID" />
+ <param index="0" name="joint" type="RID" />
+ <param index="1" name="groove1_a" type="Vector2" />
+ <param index="2" name="groove2_a" type="Vector2" />
+ <param index="3" name="anchor_b" type="Vector2" />
+ <param index="4" name="body_a" type="RID" />
+ <param index="5" name="body_b" type="RID" />
<description>
</description>
</method>
<method name="joint_make_pin">
<return type="void" />
- <argument index="0" name="joint" type="RID" />
- <argument index="1" name="anchor" type="Vector2" />
- <argument index="2" name="body_a" type="RID" />
- <argument index="3" name="body_b" type="RID" />
+ <param index="0" name="joint" type="RID" />
+ <param index="1" name="anchor" type="Vector2" />
+ <param index="2" name="body_a" type="RID" />
+ <param index="3" name="body_b" type="RID" />
<description>
</description>
</method>
<method name="joint_set_param">
<return type="void" />
- <argument index="0" name="joint" type="RID" />
- <argument index="1" name="param" type="int" enum="PhysicsServer2D.JointParam" />
- <argument index="2" name="value" type="float" />
+ <param index="0" name="joint" type="RID" />
+ <param index="1" name="param" type="int" enum="PhysicsServer2D.JointParam" />
+ <param index="2" name="value" type="float" />
<description>
Sets a joint parameter. See [enum JointParam] for a list of available parameters.
</description>
@@ -778,29 +778,29 @@
</method>
<method name="set_active">
<return type="void" />
- <argument index="0" name="active" type="bool" />
+ <param index="0" name="active" type="bool" />
<description>
Activates or deactivates the 2D physics engine.
</description>
</method>
<method name="shape_get_data" qualifiers="const">
<return type="Variant" />
- <argument index="0" name="shape" type="RID" />
+ <param index="0" name="shape" type="RID" />
<description>
Returns the shape data.
</description>
</method>
<method name="shape_get_type" qualifiers="const">
<return type="int" enum="PhysicsServer2D.ShapeType" />
- <argument index="0" name="shape" type="RID" />
+ <param index="0" name="shape" type="RID" />
<description>
Returns a shape's type (see [enum ShapeType]).
</description>
</method>
<method name="shape_set_data">
<return type="void" />
- <argument index="0" name="shape" type="RID" />
- <argument index="1" name="data" type="Variant" />
+ <param index="0" name="shape" type="RID" />
+ <param index="1" name="data" type="Variant" />
<description>
Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type].
</description>
@@ -813,39 +813,39 @@
</method>
<method name="space_get_direct_state">
<return type="PhysicsDirectSpaceState2D" />
- <argument index="0" name="space" type="RID" />
+ <param index="0" name="space" type="RID" />
<description>
Returns the state of a space, a [PhysicsDirectSpaceState2D]. This object can be used to make collision/intersection queries.
</description>
</method>
<method name="space_get_param" qualifiers="const">
<return type="float" />
- <argument index="0" name="space" type="RID" />
- <argument index="1" name="param" type="int" enum="PhysicsServer2D.SpaceParameter" />
+ <param index="0" name="space" type="RID" />
+ <param index="1" name="param" type="int" enum="PhysicsServer2D.SpaceParameter" />
<description>
Returns the value of a space parameter.
</description>
</method>
<method name="space_is_active" qualifiers="const">
<return type="bool" />
- <argument index="0" name="space" type="RID" />
+ <param index="0" name="space" type="RID" />
<description>
Returns whether the space is active.
</description>
</method>
<method name="space_set_active">
<return type="void" />
- <argument index="0" name="space" type="RID" />
- <argument index="1" name="active" type="bool" />
+ <param index="0" name="space" type="RID" />
+ <param index="1" name="active" type="bool" />
<description>
Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
</description>
</method>
<method name="space_set_param">
<return type="void" />
- <argument index="0" name="space" type="RID" />
- <argument index="1" name="param" type="int" enum="PhysicsServer2D.SpaceParameter" />
- <argument index="2" name="value" type="float" />
+ <param index="0" name="space" type="RID" />
+ <param index="1" name="param" type="int" enum="PhysicsServer2D.SpaceParameter" />
+ <param index="2" name="value" type="float" />
<description>
Sets the value for a space parameter. See [enum SpaceParameter] for a list of available parameters.
</description>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-03 13:12:16 +0000