Struct gdnative::KinematicBody

pub struct KinematicBody { /* fields omitted */ }

core class KinematicBody inherits PhysicsBody (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

KinematicBody is an unsafe pointer, and all of its methods are unsafe.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using KinematicBody::free.

Class hierarchy

KinematicBody inherits methods from:

• PhysicsBody
• CollisionObject
• Spatial
• Node
• Object

Methods

impl KinematicBody

pub fn new() -> KinematicBody

Constructor.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed. Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using KinematicBody::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn get_axis_lock(&self, axis: i64) -> bool

pub unsafe fn get_floor_normal(&self) -> Vector3D<f32, UnknownUnit>

pub unsafe fn get_floor_velocity(&self) -> Vector3D<f32, UnknownUnit>

pub unsafe fn get_safe_margin(&self) -> f64

pub unsafe fn get_slide_collision(
    &mut self,
    slide_idx: i64
) -> Option<KinematicCollision>

pub unsafe fn get_slide_count(&self) -> i64

pub unsafe fn is_on_ceiling(&self) -> bool

pub unsafe fn is_on_floor(&self) -> bool

pub unsafe fn is_on_wall(&self) -> bool

pub unsafe fn move_and_collide(
    &mut self,
    rel_vec: Vector3D<f32, UnknownUnit>,
    infinite_inertia: bool,
    exclude_raycast_shapes: bool,
    test_only: bool
) -> Option<KinematicCollision>

pub unsafe fn move_and_slide(
    &mut self,
    linear_velocity: Vector3D<f32, UnknownUnit>,
    up_direction: Vector3D<f32, UnknownUnit>,
    stop_on_slope: bool,
    max_slides: i64,
    floor_max_angle: f64,
    infinite_inertia: bool
) -> Vector3D<f32, UnknownUnit>

pub unsafe fn move_and_slide_with_snap(
    &mut self,
    linear_velocity: Vector3D<f32, UnknownUnit>,
    snap: Vector3D<f32, UnknownUnit>,
    up_direction: Vector3D<f32, UnknownUnit>,
    stop_on_slope: bool,
    max_slides: i64,
    floor_max_angle: f64,
    infinite_inertia: bool
) -> Vector3D<f32, UnknownUnit>

pub unsafe fn set_axis_lock(&mut self, axis: i64, lock: bool)

pub unsafe fn set_safe_margin(&mut self, pixels: f64)

pub unsafe fn test_move(
    &mut self,
    from: Transform,
    rel_vec: Vector3D<f32, UnknownUnit>,
    infinite_inertia: bool
) -> bool

pub unsafe fn to_physics_body(&self) -> PhysicsBody

Up-cast.

pub unsafe fn to_collision_object(&self) -> CollisionObject

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = PhysicsBody>

pub unsafe fn _get_layers(&self) -> i64

pub unsafe fn _set_layers(&mut self, mask: i64)

pub unsafe fn add_collision_exception_with(&mut self, body: Option<Node>)

pub unsafe fn get_collision_exceptions(&mut self) -> VariantArray

pub unsafe fn get_collision_layer(&self) -> i64

pub unsafe fn get_collision_layer_bit(&self, bit: i64) -> bool

pub unsafe fn get_collision_mask(&self) -> i64

pub unsafe fn get_collision_mask_bit(&self, bit: i64) -> bool

pub unsafe fn remove_collision_exception_with(&mut self, body: Option<Node>)

pub unsafe fn set_collision_layer(&mut self, layer: i64)

pub unsafe fn set_collision_layer_bit(&mut self, bit: i64, value: bool)

pub unsafe fn set_collision_mask(&mut self, mask: i64)

pub unsafe fn set_collision_mask_bit(&mut self, bit: i64, value: bool)

pub unsafe fn to_collision_object(&self) -> CollisionObject

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for KinematicBody

fn clone(&self) -> KinematicBody

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for KinematicBody

impl Debug for KinematicBody

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for KinematicBody

type Target = PhysicsBody

The resulting type after dereferencing.

fn deref(&self) -> &PhysicsBody

Dereferences the value.

impl DerefMut for KinematicBody

fn deref_mut(&mut self) -> &mut PhysicsBody

Mutably dereferences the value.

impl Free for KinematicBody

unsafe fn godot_free(self)

impl FromVariant for KinematicBody

fn from_variant(variant: &Variant) -> Result<KinematicBody, FromVariantError>

impl GodotObject for KinematicBody

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> KinematicBody

unsafe fn from_return_position_sys(obj: *mut c_void) -> KinematicBody

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for KinematicBody

fn construct() -> KinematicBody

impl QueueFree for KinematicBody

unsafe fn godot_queue_free(&mut self)

impl ToVariant for KinematicBody

fn to_variant(&self) -> Variant