asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Small changes to KinematicBody2D docs.

Browse source
This commit is contained in:
Benjamin Larsson 2017-10-07 20:30:53 +02:00
parent 25300a324c
commit 94150b8e8e
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/classes/KinematicBody2D.xml
View file

@ -17,7 +17,7 @@
<return type="Vector2">
</return>
<description>
Returns the velocity of the floor. If the floor is not a KinematicBody2D, this will always be [code]Vector2(0,0)[/code]. Only updates when calling [method move_and_slide].
Returns the velocity of the floor. If the floor is not a KinematicBody2D, this will always be [code]Vector2(0, 0)[/code]. Only updates when calling [method move_and_slide].
</description>
</method>
<method name="get_safe_margin" qualifiers="const">
@ -86,11 +86,12 @@
<argument index="4" name="floor_max_angle" type="float" default="0.785398">
</argument>
<description>
Moves the body along a vector. [code]linear_velocity[/code] is a value in pixels per second. If the body collides with another, it will slide along the other body rather than stop immediately. If the floor the node stands on is also a KinematicBody2D, the node will follow the floor's motion. This works regardless of the method used to move the floor. You can use this to make moving or rotating platforms.
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 floor the node stands on is also a KinematicBody2D, the node will follow the floor's motion. This works regardless of the method used to move the floor. You can use this to make moving or rotating platforms.
[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[/delta] — 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]Vector2(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.
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.
[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.
[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 occured, use [method get_slide_collision].
</description>
</method>
@ -110,7 +111,7 @@
<argument index="1" name="rel_vec" type="Vector2">
</argument>
<description>
Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given [Transform2D]. Then tries to move the body along the vector [code]rel_vec[/code]. Returns true if it encounters any obstacle.
Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given [Transform2D], then tries to move the body along the vector [code]rel_vec[/code]. Returns true if a collision would occur.
</description>
</method>
</methods>