Rename the argument tag to param in XML documentation
This commit is contained in:
Yuri Sizov
@@ -13,7 +13,7 @@
|
||||
<methods>
|
||||
<method name="add_constant_central_force">
|
||||
<return type="void" />
|
||||
<argument index="0" name="force" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<param index="0" name="force" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<description>
|
||||
Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]constant_force = Vector3(0, 0, 0)[/code].
|
||||
This is equivalent to using [method add_constant_force] at the body's center of mass.
|
||||
@@ -21,8 +21,8 @@
|
||||
</method>
|
||||
<method name="add_constant_force">
|
||||
<return type="void" />
|
||||
<argument index="0" name="force" type="Vector3" />
|
||||
<argument index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<param index="0" name="force" type="Vector3" />
|
||||
<param index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<description>
|
||||
Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]constant_force = Vector3(0, 0, 0)[/code].
|
||||
[code]position[/code] is the offset from the body origin in global coordinates.
|
||||
@@ -30,14 +30,14 @@
|
||||
</method>
|
||||
<method name="add_constant_torque">
|
||||
<return type="void" />
|
||||
<argument index="0" name="torque" type="Vector3" />
|
||||
<param index="0" name="torque" type="Vector3" />
|
||||
<description>
|
||||
Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]constant_torque = Vector3(0, 0, 0)[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="apply_central_force">
|
||||
<return type="void" />
|
||||
<argument index="0" name="force" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<param index="0" name="force" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<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 apply_force] at the body's center of mass.
|
||||
@@ -45,7 +45,7 @@
|
||||
</method>
|
||||
<method name="apply_central_impulse">
|
||||
<return type="void" />
|
||||
<argument index="0" name="impulse" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<param index="0" name="impulse" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<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).
|
||||
@@ -54,8 +54,8 @@
|
||||
</method>
|
||||
<method name="apply_force">
|
||||
<return type="void" />
|
||||
<argument index="0" name="force" type="Vector3" />
|
||||
<argument index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<param index="0" name="force" type="Vector3" />
|
||||
<param index="1" name="position" type="Vector3" default="Vector3(0, 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.
|
||||
@@ -63,8 +63,8 @@
|
||||
</method>
|
||||
<method name="apply_impulse">
|
||||
<return type="void" />
|
||||
<argument index="0" name="impulse" type="Vector3" />
|
||||
<argument index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<param index="0" name="impulse" type="Vector3" />
|
||||
<param index="1" name="position" type="Vector3" default="Vector3(0, 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).
|
||||
@@ -73,14 +73,14 @@
|
||||
</method>
|
||||
<method name="apply_torque">
|
||||
<return type="void" />
|
||||
<argument index="0" name="torque" type="Vector3" />
|
||||
<param index="0" name="torque" type="Vector3" />
|
||||
<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="apply_torque_impulse">
|
||||
<return type="void" />
|
||||
<argument index="0" name="impulse" type="Vector3" />
|
||||
<param index="0" name="impulse" type="Vector3" />
|
||||
<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).
|
||||
@@ -102,42 +102,42 @@
|
||||
</method>
|
||||
<method name="get_contact_collider" qualifiers="const">
|
||||
<return type="RID" />
|
||||
<argument index="0" name="contact_idx" type="int" />
|
||||
<param index="0" name="contact_idx" type="int" />
|
||||
<description>
|
||||
Returns the collider's [RID].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_contact_collider_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="contact_idx" type="int" />
|
||||
<param index="0" name="contact_idx" type="int" />
|
||||
<description>
|
||||
Returns the collider's object id.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_contact_collider_object" qualifiers="const">
|
||||
<return type="Object" />
|
||||
<argument index="0" name="contact_idx" type="int" />
|
||||
<param index="0" name="contact_idx" type="int" />
|
||||
<description>
|
||||
Returns the collider object.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_contact_collider_position" qualifiers="const">
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="contact_idx" type="int" />
|
||||
<param index="0" name="contact_idx" type="int" />
|
||||
<description>
|
||||
Returns the contact position in the collider.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_contact_collider_shape" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="contact_idx" type="int" />
|
||||
<param index="0" name="contact_idx" type="int" />
|
||||
<description>
|
||||
Returns the collider's shape index.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_contact_collider_velocity_at_position" qualifiers="const">
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="contact_idx" type="int" />
|
||||
<param index="0" name="contact_idx" type="int" />
|
||||
<description>
|
||||
Returns the linear velocity vector at the collider's contact point.
|
||||
</description>
|
||||
@@ -151,28 +151,28 @@
|
||||
</method>
|
||||
<method name="get_contact_impulse" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="contact_idx" type="int" />
|
||||
<param index="0" name="contact_idx" type="int" />
|
||||
<description>
|
||||
Impulse created by the contact. Only implemented for Bullet physics.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_contact_local_normal" qualifiers="const">
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="contact_idx" type="int" />
|
||||
<param index="0" name="contact_idx" type="int" />
|
||||
<description>
|
||||
Returns the local normal at the contact point.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_contact_local_position" qualifiers="const">
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="contact_idx" type="int" />
|
||||
<param index="0" name="contact_idx" type="int" />
|
||||
<description>
|
||||
Returns the local position of the contact point.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_contact_local_shape" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="contact_idx" type="int" />
|
||||
<param index="0" name="contact_idx" type="int" />
|
||||
<description>
|
||||
Returns the local shape index of the collision.
|
||||
</description>
|
||||
@@ -185,7 +185,7 @@
|
||||
</method>
|
||||
<method name="get_velocity_at_local_position" qualifiers="const">
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="local_position" type="Vector3" />
|
||||
<param index="0" name="local_position" type="Vector3" />
|
||||
<description>
|
||||
Returns the body's velocity at the given relative position, including both translation and rotation.
|
||||
</description>
|
||||
@@ -198,7 +198,7 @@
|
||||
</method>
|
||||
<method name="set_constant_force">
|
||||
<return type="void" />
|
||||
<argument index="0" name="force" type="Vector3" />
|
||||
<param index="0" name="force" type="Vector3" />
|
||||
<description>
|
||||
Sets the body's total constant positional forces applied during each physics update.
|
||||
See [method add_constant_force] and [method add_constant_central_force].
|
||||
@@ -206,7 +206,7 @@
|
||||
</method>
|
||||
<method name="set_constant_torque">
|
||||
<return type="void" />
|
||||
<argument index="0" name="torque" type="Vector3" />
|
||||
<param index="0" name="torque" type="Vector3" />
|
||||
<description>
|
||||
Sets the body's total constant rotational forces applied during each physics update.
|
||||
See [method add_constant_torque].
|
||||
|
||||
Reference in New Issue
Block a user