diff options
Diffstat (limited to 'doc/classes/KinematicBody.xml')
| -rw-r--r-- | doc/classes/KinematicBody.xml | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index 2c22ae4f93..5553602db2 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicBody" inherits="PhysicsBody" category="Core" version="3.0-stable"> +<class name="KinematicBody" inherits="PhysicsBody" category="Core" version="3.1"> <brief_description> Kinematic body 3D node. </brief_description> @@ -63,6 +63,8 @@ </return> <argument index="0" name="rel_vec" type="Vector3"> </argument> + <argument index="1" name="infinite_inertia" type="bool" default="true"> + </argument> <description> Moves the body along the vector [code]rel_vec[/code]. The body will stop if it collides. Returns a [KinematicCollision], which contains information about the collision. </description> @@ -74,18 +76,20 @@ </argument> <argument index="1" name="floor_normal" type="Vector3" default="Vector3( 0, 0, 0 )"> </argument> - <argument index="2" name="slope_stop_min_velocity" type="float" default="0.05"> + <argument index="2" name="infinite_inertia" type="bool" default="true"> + </argument> + <argument index="3" name="slope_stop_min_velocity" type="float" default="0.05"> </argument> - <argument index="3" name="max_slides" type="int" default="4"> + <argument index="4" name="max_slides" type="int" default="4"> </argument> - <argument index="4" name="floor_max_angle" type="float" default="0.785398"> + <argument index="5" name="floor_max_angle" type="float" default="0.785398"> </argument> <description> Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [code]KinematicBody[/code] or [RigidBody], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. [code]linear_velocity[/code] is a value in pixels per second. Unlike in for example [method move_and_collide], you should [i]not[/i] multiply it with [code]delta[/code] — this is done by the method. [code]floor_normal[/code] is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of [code]Vector3(0, 0, 0)[/code], everything is considered a wall. This is useful for topdown games. If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. - If the body collides, it will change direction a maximum of [code]max_bounces[/code] times before it stops. + If the body collides, it will change direction a maximum of [code]max_slides[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use [method get_slide_collision]. </description> @@ -97,6 +101,8 @@ </argument> <argument index="1" name="rel_vec" type="Vector3"> </argument> + <argument index="2" name="infinite_inertia" type="bool"> + </argument> <description> Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given [Transform], then tries to move the body along the vector [code]rel_vec[/code]. Returns [code]true[/code] if a collision would occur. </description> |