Struct gdnative::api::KinematicCollision2D

pub struct KinematicCollision2D { /* fields omitted */ }

core class KinematicCollision2D inherits Reference (reference counted).

Official documentation

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

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

KinematicCollision2D inherits methods from:

• Reference
• 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 KinematicCollision2D

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

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn collider(&self) -> Option<Ref<Object, Shared>>

The colliding body.

pub fn collider_id(&self) -> i64

The colliding body's unique instance ID. See [method Object.get_instance_id].

pub fn collider_metadata(&self) -> Variant

The colliding body's metadata. See [Object].

pub fn collider_shape(&self) -> Option<Ref<Object, Shared>>

The colliding body's shape.

pub fn collider_shape_index(&self) -> i64

The colliding shape's index. See [CollisionObject2D].

pub fn collider_velocity(&self) -> Vector2D<f32, UnknownUnit>

The colliding object's velocity.

pub fn local_shape(&self) -> Option<Ref<Object, Shared>>

The moving object's colliding shape.

pub fn normal(&self) -> Vector2D<f32, UnknownUnit>

The colliding body's shape's normal at the point of collision.

pub fn position(&self) -> Vector2D<f32, UnknownUnit>

The point of collision, in global coordinates.

pub fn remainder(&self) -> Vector2D<f32, UnknownUnit>

The moving object's remaining movement vector.

pub fn travel(&self) -> Vector2D<f32, UnknownUnit>

The distance the moving object traveled before collision.

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing.
				Returns whether the initialization was successful.

Trait Implementations

impl Debug for KinematicCollision2D

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

Formats the value using the given formatter.

impl Deref for KinematicCollision2D

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for KinematicCollision2D

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

Mutably dereferences the value.

impl GodotObject for KinematicCollision2D

type RefKind = RefCounted

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 KinematicCollision2D

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

impl SubClass<Object> for KinematicCollision2D

impl SubClass<Reference> for KinematicCollision2D