Struct gdnative::prelude::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 a reference-only type. Persistent references can only exist in the unsafe Ref<KinematicBody> form.

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 Ptr::free, or Ptr::queue_free if it is a Node.

Class hierarchy

KinematicBody inherits methods from:

• PhysicsBody
• CollisionObject
• Spatial
• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl KinematicBody

pub fn new() -> Ref<KinematicBody, Unique>

Creates a new instance of this object.

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 Ptr::free, or preferably Ptr::queue_free if it is a Node.

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

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

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

pub fn safe_margin(&self) -> f64

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

pub fn get_slide_count(&self) -> i64

pub fn is_on_ceiling(&self) -> bool

pub fn is_on_floor(&self) -> bool

pub fn is_on_wall(&self) -> bool

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

pub fn move_and_slide(
    &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 fn move_and_slide_with_snap(
    &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 fn set_axis_lock(&self, axis: i64, lock: bool)

pub fn set_safe_margin(&self, pixels: f64)

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

Methods from Deref<Target = PhysicsBody>

pub fn add_collision_exception_with(&self, body: impl AsArg<Node>)

pub fn get_collision_exceptions(&self) -> VariantArray<Shared>

pub fn collision_layer(&self) -> i64

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

pub fn collision_mask(&self) -> i64

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

pub fn remove_collision_exception_with(&self, body: impl AsArg<Node>)

pub fn set_collision_layer(&self, layer: i64)

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

pub fn set_collision_mask(&self, mask: i64)

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

Trait Implementations

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 GodotObject for KinematicBody

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for KinematicBody

fn construct() -> Ref<KinematicBody, Unique>

impl QueueFree for KinematicBody

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CollisionObject> for KinematicBody

impl SubClass<Node> for KinematicBody

impl SubClass<Object> for KinematicBody

impl SubClass<PhysicsBody> for KinematicBody

impl SubClass<Spatial> for KinematicBody