Struct gdnative::api::RigidBody2D

pub struct RigidBody2D { /* fields omitted */ }

core class RigidBody2D inherits PhysicsBody2D (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.

RigidBody2D is a reference-only type. Persistent references can only exist in the unsafe Ref<RigidBody2D> 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

RigidBody2D inherits methods from:

• PhysicsBody2D
• CollisionObject2D
• Node2D
• CanvasItem
• 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 RigidBody2D

Constants

pub const CCD_MODE_CAST_RAY: i64

pub const CCD_MODE_CAST_SHAPE: i64

pub const CCD_MODE_DISABLED: i64

pub const MODE_CHARACTER: i64

pub const MODE_KINEMATIC: i64

pub const MODE_RIGID: i64

pub const MODE_STATIC: i64

impl RigidBody2D

pub fn new() -> Ref<RigidBody2D, 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 add_central_force(&self, force: Vector2D<f32, UnknownUnit>)

pub fn add_force(
    &self,
    offset: Vector2D<f32, UnknownUnit>,
    force: Vector2D<f32, UnknownUnit>
)

pub fn add_torque(&self, torque: f64)

pub fn apply_central_impulse(&self, impulse: Vector2D<f32, UnknownUnit>)

pub fn apply_impulse(
    &self,
    offset: Vector2D<f32, UnknownUnit>,
    impulse: Vector2D<f32, UnknownUnit>
)

pub fn apply_torque_impulse(&self, torque: f64)

pub fn angular_damp(&self) -> f64

pub fn angular_velocity(&self) -> f64

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

pub fn applied_torque(&self) -> f64

pub fn bounce(&self) -> f64

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

pub fn continuous_collision_detection_mode(&self) -> CcdMode

pub fn friction(&self) -> f64

pub fn gravity_scale(&self) -> f64

pub fn inertia(&self) -> f64

pub fn linear_damp(&self) -> f64

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

pub fn mass(&self) -> f64

pub fn max_contacts_reported(&self) -> i64

pub fn mode(&self) -> Mode

pub fn physics_material_override(&self) -> Option<Ref<PhysicsMaterial, Shared>>

pub fn weight(&self) -> f64

pub fn is_able_to_sleep(&self) -> bool

pub fn is_contact_monitor_enabled(&self) -> bool

pub fn is_sleeping(&self) -> bool

pub fn is_using_custom_integrator(&self) -> bool

pub fn set_angular_damp(&self, angular_damp: f64)

pub fn set_angular_velocity(&self, angular_velocity: f64)

pub fn set_applied_force(&self, force: Vector2D<f32, UnknownUnit>)

pub fn set_applied_torque(&self, torque: f64)

pub fn set_axis_velocity(&self, axis_velocity: Vector2D<f32, UnknownUnit>)

pub fn set_bounce(&self, bounce: f64)

pub fn set_can_sleep(&self, able_to_sleep: bool)

pub fn set_contact_monitor(&self, enabled: bool)

pub fn set_continuous_collision_detection_mode(&self, mode: i64)

pub fn set_friction(&self, friction: f64)

pub fn set_gravity_scale(&self, gravity_scale: f64)

pub fn set_inertia(&self, inertia: f64)

pub fn set_linear_damp(&self, linear_damp: f64)

pub fn set_linear_velocity(&self, linear_velocity: Vector2D<f32, UnknownUnit>)

pub fn set_mass(&self, mass: f64)

pub fn set_max_contacts_reported(&self, amount: i64)

pub fn set_mode(&self, mode: i64)

pub fn set_physics_material_override(
    &self,
    physics_material_override: impl AsArg<PhysicsMaterial>
)

pub fn set_sleeping(&self, sleeping: bool)

pub fn set_use_custom_integrator(&self, enable: bool)

pub fn set_weight(&self, weight: f64)

pub fn test_motion(
    &self,
    motion: Vector2D<f32, UnknownUnit>,
    infinite_inertia: bool,
    margin: f64,
    result: impl AsArg<Physics2DTestMotionResult>
) -> bool

Methods from Deref<Target = PhysicsBody2D>

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 RigidBody2D

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

Formats the value using the given formatter.

impl Deref for RigidBody2D

type Target = PhysicsBody2D

The resulting type after dereferencing.

fn deref(&self) -> &PhysicsBody2D

Dereferences the value.

impl DerefMut for RigidBody2D

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

Mutably dereferences the value.

impl GodotObject for RigidBody2D

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 RigidBody2D

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

impl QueueFree for RigidBody2D

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for RigidBody2D

impl SubClass<CollisionObject2D> for RigidBody2D

impl SubClass<Node> for RigidBody2D

impl SubClass<Node2D> for RigidBody2D

impl SubClass<Object> for RigidBody2D

impl SubClass<PhysicsBody2D> for RigidBody2D