Struct gdnative_bindings_lily::ray_cast_2d::RayCast2D

pub struct RayCast2D { /* fields omitted */ }

core class RayCast2D inherits Node2D (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.

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

RayCast2D inherits methods from:

• 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 RayCast2D

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 add_exception(&self, node: impl AsArg<Object>)

Adds a collision exception so the ray does not report collisions with the specified node.

pub fn add_exception_rid(&self, rid: Rid)

Adds a collision exception so the ray does not report collisions with the specified [RID].

pub fn clear_exceptions(&self)

Removes all collision exceptions for this ray.

pub fn force_raycast_update(&self)

Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next _physics_process call, for example if the ray or its parent has changed state. Note: enabled is not required for this to work.

pub fn cast_to(&self) -> Vector2

The ray’s destination point, relative to the RayCast’s position.

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

Returns the first object that the ray intersects, or null if no object is intersecting the ray (i.e. [method is_colliding] returns false).

pub fn get_collider_shape(&self) -> i64

Returns the shape ID of the first object that the ray intersects, or 0 if no object is intersecting the ray (i.e. [method is_colliding] returns false).

pub fn collision_mask(&self) -> i64

The ray’s collision mask. Only objects in at least one collision layer enabled in the mask will be detected. 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 collision mask.

pub fn get_collision_normal(&self) -> Vector2

Returns the normal of the intersecting object’s shape at the collision point.

pub fn get_collision_point(&self) -> Vector2

Returns the collision point at which the ray intersects the closest object. Note: this point is in the global coordinate system.

pub fn exclude_parent_body(&self) -> bool

If true, the parent node will be excluded from collision detection.

pub fn is_collide_with_areas_enabled(&self) -> bool

If true, collision with Area2Ds will be reported.

pub fn is_collide_with_bodies_enabled(&self) -> bool

If true, collision with PhysicsBody2Ds will be reported.

pub fn is_colliding(&self) -> bool

Returns whether any object is intersecting with the ray’s vector (considering the vector length).

pub fn is_enabled(&self) -> bool

If true, collisions will be reported.

pub fn remove_exception(&self, node: impl AsArg<Object>)

Removes a collision exception so the ray does report collisions with the specified node.

pub fn remove_exception_rid(&self, rid: Rid)

Removes a collision exception so the ray does report collisions with the specified [RID].

pub fn set_cast_to(&self, local_point: Vector2)

The ray’s destination point, relative to the RayCast’s position.

pub fn set_collide_with_areas(&self, enable: bool)

If true, collision with Area2Ds will be reported.

pub fn set_collide_with_bodies(&self, enable: bool)

If true, collision with PhysicsBody2Ds will be reported.

pub fn set_collision_mask(&self, mask: i64)

The ray’s collision mask. Only objects in at least one collision layer enabled in the mask will be detected. 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 or clears individual bits on the collision mask. This makes selecting the areas scanned easier.

pub fn set_enabled(&self, enabled: bool)

If true, collisions will be reported.

pub fn set_exclude_parent_body(&self, mask: bool)

If true, the parent node will be excluded from collision detection.

Methods from Deref<Target = Node2D>

pub fn apply_scale(&self, ratio: Vector2)

Multiplies the current scale by the ratio vector.

pub fn get_angle_to(&self, point: Vector2) -> f64

Returns the angle between the node and the point in radians.

pub fn global_position(&self) -> Vector2

Global position.

pub fn global_rotation(&self) -> f64

Global rotation in radians.

pub fn global_rotation_degrees(&self) -> f64

Global rotation in degrees.

pub fn global_scale(&self) -> Vector2

Global scale.

pub fn position(&self) -> Vector2

Position, relative to the node’s parent.

pub fn get_relative_transform_to_parent(
    &self,
    parent: impl AsArg<Node>
) -> Transform2D

Returns the Transform2D relative to this node’s parent.

pub fn rotation(&self) -> f64

Rotation in radians, relative to the node’s parent.

pub fn rotation_degrees(&self) -> f64

Rotation in degrees, relative to the node’s parent.

pub fn scale(&self) -> Vector2

The node’s scale. Unscaled value: (1, 1).

pub fn z_index(&self) -> i64

Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.

pub fn global_translate(&self, offset: Vector2)

Adds the offset vector to the node’s global position.

pub fn is_z_relative(&self) -> bool

If true, the node’s Z index is relative to its parent’s Z index. If this node’s Z index is 2 and its parent’s effective Z index is 3, then this node’s effective Z index will be 2 + 3 = 5.

pub fn look_at(&self, point: Vector2)

Rotates the node so it points towards the point, which is expected to use global coordinates.

pub fn move_local_x(&self, delta: f64, scaled: bool)

Applies a local translation on the node’s X axis based on the [method Node._process]’s delta. If scaled is false, normalizes the movement.

Default Arguments

• scaled - false

pub fn move_local_y(&self, delta: f64, scaled: bool)

Applies a local translation on the node’s Y axis based on the [method Node._process]’s delta. If scaled is false, normalizes the movement.

Default Arguments

• scaled - false

pub fn rotate(&self, radians: f64)

Applies a rotation to the node, in radians, starting from its current rotation.

pub fn set_global_position(&self, position: Vector2)

Global position.

pub fn set_global_rotation(&self, radians: f64)

Global rotation in radians.

pub fn set_global_rotation_degrees(&self, degrees: f64)

Global rotation in degrees.

pub fn set_global_scale(&self, scale: Vector2)

Global scale.

pub fn set_global_transform(&self, xform: Transform2D)

Global Transform2D.

pub fn set_position(&self, position: Vector2)

Position, relative to the node’s parent.

pub fn set_rotation(&self, radians: f64)

Rotation in radians, relative to the node’s parent.

pub fn set_rotation_degrees(&self, degrees: f64)

Rotation in degrees, relative to the node’s parent.

pub fn set_scale(&self, scale: Vector2)

The node’s scale. Unscaled value: (1, 1).

pub fn set_transform(&self, xform: Transform2D)

Local Transform2D.

pub fn set_z_as_relative(&self, enable: bool)

If true, the node’s Z index is relative to its parent’s Z index. If this node’s Z index is 2 and its parent’s effective Z index is 3, then this node’s effective Z index will be 2 + 3 = 5.

pub fn set_z_index(&self, z_index: i64)

Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.

pub fn to_global(&self, local_point: Vector2) -> Vector2

Transforms the provided local position into a position in global coordinate space. The input is expected to be local relative to the Node2D it is called on. e.g. Applying this method to the positions of child nodes will correctly transform their positions into the global coordinate space, but applying it to a node’s own position will give an incorrect result, as it will incorporate the node’s own transformation into its global position.

pub fn to_local(&self, global_point: Vector2) -> Vector2

Transforms the provided global position into a position in local coordinate space. The output will be local relative to the Node2D it is called on. e.g. It is appropriate for determining the positions of child nodes, but it is not appropriate for determining its own position relative to its parent.

pub fn translate(&self, offset: Vector2)

Translates the node by the given offset in local coordinates.

Trait Implementations

impl Debug for RayCast2D

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

Formats the value using the given formatter.

impl Deref for RayCast2D

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Node2D

Dereferences the value.

impl DerefMut for RayCast2D

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

Mutably dereferences the value.

impl GodotObject for RayCast2D

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 RayCast2D

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

impl QueueFree for RayCast2D

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for RayCast2D

impl SubClass<CanvasItem> for RayCast2D

impl SubClass<Node> for RayCast2D

impl SubClass<Node2D> for RayCast2D

impl SubClass<Object> for RayCast2D