Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
CharacterBody2D¶
Inherits: PhysicsBody2D < CollisionObject2D < Node2D < CanvasItem < Node < Object
A 2D physics body specialized for characters moved by script.
Description¶
CharacterBody2D is a specialized class for physics bodies that are meant to be user-controlled. They are not affected by physics at all, but they affect other physics bodies in their path. They are mainly used to provide high-level API to move objects with wall and slope detection (move_and_slide method) in addition to the general collision detection provided by PhysicsBody2D.move_and_collide. This makes it useful for highly configurable physics bodies that must move in specific ways and collide with the world, as is often the case with user-controlled characters.
For game objects that don't require complex movement or collision detection, such as moving platforms, AnimatableBody2D is simpler to configure.
Tutorials¶
Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Methods¶
void |
apply_floor_snap ( ) |
get_floor_angle ( Vector2 up_direction=Vector2(0, -1) ) const |
|
get_floor_normal ( ) const |
|
get_last_motion ( ) const |
|
get_platform_velocity ( ) const |
|
get_position_delta ( ) const |
|
get_real_velocity ( ) const |
|
get_slide_collision ( int slide_idx ) |
|
get_slide_collision_count ( ) const |
|
get_wall_normal ( ) const |
|