.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/CharacterBody3D.xml. .. _class_CharacterBody3D: CharacterBody3D =============== **Inherits:** :ref:`PhysicsBody3D` **<** :ref:`CollisionObject3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`bool` | :ref:`floor_block_on_wall` | ``true`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`bool` | :ref:`floor_constant_speed` | ``false`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`floor_max_angle` | ``0.785398`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`floor_snap_length` | ``0.1`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`bool` | :ref:`floor_stop_on_slope` | ``true`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`int` | :ref:`max_slides` | ``6`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`MotionMode` | :ref:`motion_mode` | ``0`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`int` | :ref:`platform_floor_layers` | ``4294967295`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`PlatformOnLeave` | :ref:`platform_on_leave` | ``0`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`int` | :ref:`platform_wall_layers` | ``0`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`safe_margin` | ``0.001`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`bool` | :ref:`slide_on_ceiling` | ``true`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`Vector3` | :ref:`up_direction` | ``Vector3(0, 1, 0)`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`Vector3` | :ref:`velocity` | ``Vector3(0, 0, 0)`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`wall_min_slide_angle` | ``0.261799`` | +--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_floor_snap` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_floor_angle` **(** :ref:`Vector3` up_direction=Vector3(0, 1, 0) **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_floor_normal` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_last_motion` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`KinematicCollision3D` | :ref:`get_last_slide_collision` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_platform_angular_velocity` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_platform_velocity` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_position_delta` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_real_velocity` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`KinematicCollision3D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_slide_collision_count` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_wall_normal` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_on_ceiling` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_on_ceiling_only` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_on_floor` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_on_floor_only` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_on_wall` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_on_wall_only` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`move_and_slide` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_CharacterBody3D_MotionMode: .. rst-class:: classref-enumeration enum **MotionMode**: .. _class_CharacterBody3D_constant_MOTION_MODE_GROUNDED: .. rst-class:: classref-enumeration-constant :ref:`MotionMode` **MOTION_MODE_GROUNDED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_CharacterBody3D_constant_MOTION_MODE_FLOATING: .. rst-class:: classref-enumeration-constant :ref:`MotionMode` **MOTION_MODE_FLOATING** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_CharacterBody3D_PlatformOnLeave: .. rst-class:: classref-enumeration enum **PlatformOnLeave**: .. _class_CharacterBody3D_constant_PLATFORM_ON_LEAVE_ADD_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`PlatformOnLeave` **PLATFORM_ON_LEAVE_ADD_VELOCITY** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_CharacterBody3D_constant_PLATFORM_ON_LEAVE_ADD_UPWARD_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`PlatformOnLeave` **PLATFORM_ON_LEAVE_ADD_UPWARD_VELOCITY** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_CharacterBody3D_constant_PLATFORM_ON_LEAVE_DO_NOTHING: .. rst-class:: classref-enumeration-constant :ref:`PlatformOnLeave` **PLATFORM_ON_LEAVE_DO_NOTHING** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_CharacterBody3D_property_floor_block_on_wall: .. rst-class:: classref-property :ref:`bool` **floor_block_on_wall** = ``true`` .. rst-class:: classref-property-setget - void **set_floor_block_on_wall_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_floor_block_on_wall_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_floor_constant_speed: .. rst-class:: classref-property :ref:`bool` **floor_constant_speed** = ``false`` .. rst-class:: classref-property-setget - void **set_floor_constant_speed_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_floor_constant_speed_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_floor_max_angle: .. rst-class:: classref-property :ref:`float` **floor_max_angle** = ``0.785398`` .. rst-class:: classref-property-setget - void **set_floor_max_angle** **(** :ref:`float` value **)** - :ref:`float` **get_floor_max_angle** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_floor_snap_length: .. rst-class:: classref-property :ref:`float` **floor_snap_length** = ``0.1`` .. rst-class:: classref-property-setget - void **set_floor_snap_length** **(** :ref:`float` value **)** - :ref:`float` **get_floor_snap_length** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_floor_stop_on_slope: .. rst-class:: classref-property :ref:`bool` **floor_stop_on_slope** = ``true`` .. rst-class:: classref-property-setget - void **set_floor_stop_on_slope_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_floor_stop_on_slope_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_max_slides: .. rst-class:: classref-property :ref:`int` **max_slides** = ``6`` .. rst-class:: classref-property-setget - void **set_max_slides** **(** :ref:`int` value **)** - :ref:`int` **get_max_slides** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_motion_mode: .. rst-class:: classref-property :ref:`MotionMode` **motion_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_motion_mode** **(** :ref:`MotionMode` value **)** - :ref:`MotionMode` **get_motion_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_platform_floor_layers: .. rst-class:: classref-property :ref:`int` **platform_floor_layers** = ``4294967295`` .. rst-class:: classref-property-setget - void **set_platform_floor_layers** **(** :ref:`int` value **)** - :ref:`int` **get_platform_floor_layers** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_platform_on_leave: .. rst-class:: classref-property :ref:`PlatformOnLeave` **platform_on_leave** = ``0`` .. rst-class:: classref-property-setget - void **set_platform_on_leave** **(** :ref:`PlatformOnLeave` value **)** - :ref:`PlatformOnLeave` **get_platform_on_leave** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_platform_wall_layers: .. rst-class:: classref-property :ref:`int` **platform_wall_layers** = ``0`` .. rst-class:: classref-property-setget - void **set_platform_wall_layers** **(** :ref:`int` value **)** - :ref:`int` **get_platform_wall_layers** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_safe_margin: .. rst-class:: classref-property :ref:`float` **safe_margin** = ``0.001`` .. rst-class:: classref-property-setget - void **set_safe_margin** **(** :ref:`float` value **)** - :ref:`float` **get_safe_margin** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_slide_on_ceiling: .. rst-class:: classref-property :ref:`bool` **slide_on_ceiling** = ``true`` .. rst-class:: classref-property-setget - void **set_slide_on_ceiling_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_slide_on_ceiling_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_up_direction: .. rst-class:: classref-property :ref:`Vector3` **up_direction** = ``Vector3(0, 1, 0)`` .. rst-class:: classref-property-setget - void **set_up_direction** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_up_direction** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_velocity: .. rst-class:: classref-property :ref:`Vector3` **velocity** = ``Vector3(0, 0, 0)`` .. rst-class:: classref-property-setget - void **set_velocity** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_velocity** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_property_wall_min_slide_angle: .. rst-class:: classref-property :ref:`float` **wall_min_slide_angle** = ``0.261799`` .. rst-class:: classref-property-setget - void **set_wall_min_slide_angle** **(** :ref:`float` value **)** - :ref:`float` **get_wall_min_slide_angle** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_CharacterBody3D_method_apply_floor_snap: .. rst-class:: classref-method void **apply_floor_snap** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_get_floor_angle: .. rst-class:: classref-method :ref:`float` **get_floor_angle** **(** :ref:`Vector3` up_direction=Vector3(0, 1, 0) **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_get_floor_normal: .. rst-class:: classref-method :ref:`Vector3` **get_floor_normal** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_get_last_motion: .. rst-class:: classref-method :ref:`Vector3` **get_last_motion** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_get_last_slide_collision: .. rst-class:: classref-method :ref:`KinematicCollision3D` **get_last_slide_collision** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_get_platform_angular_velocity: .. rst-class:: classref-method :ref:`Vector3` **get_platform_angular_velocity** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_get_platform_velocity: .. rst-class:: classref-method :ref:`Vector3` **get_platform_velocity** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_get_position_delta: .. rst-class:: classref-method :ref:`Vector3` **get_position_delta** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_get_real_velocity: .. rst-class:: classref-method :ref:`Vector3` **get_real_velocity** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_get_slide_collision: .. rst-class:: classref-method :ref:`KinematicCollision3D` **get_slide_collision** **(** :ref:`int` slide_idx **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_get_slide_collision_count: .. rst-class:: classref-method :ref:`int` **get_slide_collision_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_get_wall_normal: .. rst-class:: classref-method :ref:`Vector3` **get_wall_normal** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_is_on_ceiling: .. rst-class:: classref-method :ref:`bool` **is_on_ceiling** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_is_on_ceiling_only: .. rst-class:: classref-method :ref:`bool` **is_on_ceiling_only** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_is_on_floor: .. rst-class:: classref-method :ref:`bool` **is_on_floor** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_is_on_floor_only: .. rst-class:: classref-method :ref:`bool` **is_on_floor_only** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_is_on_wall: .. rst-class:: classref-method :ref:`bool` **is_on_wall** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_is_on_wall_only: .. rst-class:: classref-method :ref:`bool` **is_on_wall_only** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CharacterBody3D_method_move_and_slide: .. rst-class:: classref-method :ref:`bool` **move_and_slide** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`