Struct gdnative_bindings_lily::StaticBody2D

pub struct StaticBody2D { /* fields omitted */ }

core class StaticBody2D inherits PhysicsBody2D (unsafe).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

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

StaticBody2D is a reference-only type. Persistent references can only exist in the unsafe Ref<StaticBody2D> 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 Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

StaticBody2D 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 StaticBody2D

pub fn new() -> Ref<Self, 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 Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn bounce(&self) -> f64

The body’s bounciness. Values range from 0 (no bounce) to 1 (full bounciness). Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override].

pub fn constant_angular_velocity(&self) -> f64

The body’s constant angular velocity. This does not rotate the body, but affects colliding bodies, as if it were rotating.

pub fn constant_linear_velocity(&self) -> Vector2

The body’s constant linear velocity. This does not move the body, but affects colliding bodies, as if it were moving.

pub fn friction(&self) -> f64

The body’s friction. Values range from 0 (no friction) to 1 (full friction). Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override].

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

The physics material override for the body. If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one.

pub fn set_bounce(&self, bounce: f64)

The body’s bounciness. Values range from 0 (no bounce) to 1 (full bounciness). Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override].

pub fn set_constant_angular_velocity(&self, vel: f64)

The body’s constant angular velocity. This does not rotate the body, but affects colliding bodies, as if it were rotating.

pub fn set_constant_linear_velocity(&self, vel: Vector2)

The body’s constant linear velocity. This does not move the body, but affects colliding bodies, as if it were moving.

pub fn set_friction(&self, friction: f64)

The body’s friction. Values range from 0 (no friction) to 1 (full friction). Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override].

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

The physics material override for the body. If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one.

Methods from Deref<Target = PhysicsBody2D>

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

Adds a body to the list of bodies that this body can’t collide with.

pub fn get_collision_exceptions(&self) -> VariantArray

Returns an array of nodes that were added as collision exceptions for this body.

pub fn collision_layer(&self) -> i64

The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the [member collision_mask] property. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

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

Returns an individual bit on the [member collision_layer].

pub fn collision_mask(&self) -> i64

The physics layers this area scans for collisions. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

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

Returns an individual bit on the [member collision_mask].

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

Removes a body from the list of bodies that this body can’t collide with.

pub fn set_collision_layer(&self, layer: i64)

The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the [member collision_mask] property. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

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

Sets individual bits on the [member collision_layer] bitmask. Use this if you only need to change one layer’s value.

pub fn set_collision_mask(&self, mask: i64)

The physics layers this area scans for collisions. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

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

Sets individual bits on the [member collision_mask] bitmask. Use this if you only need to change one layer’s value.

Trait Implementations

impl Debug for StaticBody2D

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

Formats the value using the given formatter.

impl Deref for StaticBody2D

type Target = PhysicsBody2D

The resulting type after dereferencing.

fn deref(&self) -> &PhysicsBody2D

Dereferences the value.

impl DerefMut for StaticBody2D

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

Mutably dereferences the value.

impl GodotObject for StaticBody2D

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.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Instanciable for StaticBody2D

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

impl QueueFree for StaticBody2D

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for StaticBody2D

impl SubClass<CanvasItem> for StaticBody2D

impl SubClass<CollisionObject2D> for StaticBody2D

impl SubClass<Node> for StaticBody2D

impl SubClass<Node2D> for StaticBody2D

impl SubClass<Object> for StaticBody2D

impl SubClass<PhysicsBody2D> for StaticBody2D