Open Classmigueldeicaza.swiftgodot 0.45.0SwiftGodot

RayCast3D

A ray in 3D space, used to find the first CollisionObject3D it intersects.

class RayCast3D

Mangled symbol

s10SwiftGodot9RayCast3DCWhat are these?

FNV24: [96G06]

A raycast represents a ray from its origin to its targetPosition that finds the closest CollisionObject3D along its path, if it intersects any. This is useful for a lot of things, such as

RayCast3D can ignore some objects by adding them to an exception list, by making its detection reporting ignore Area3Ds (collideWithAreas) or PhysicsBody3Ds (collideWithBodies), or by configuring physics layers.

RayCast3D calculates intersection every physics frame, and it holds the result until the next physics frame. For an immediate raycast, or if you want to configure a RayCast3D multiple times within the same physics frame, use forceRaycastUpdate.

To sweep over a region of 3D space, you can approximate the region with multiple RayCast3Ds or use ShapeCast3D.

Superclasses

class Node3D
Most basic 3D game object, parent of all 3D-related nodes.

Citizens in SwiftGodot

Conformances

protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a Hasher to produce an integer hash value.
protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.
protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Type members

class var godotClassName: StringName

Instance members

var collideWithAreas: Bool
If true, collisions with Area3Ds will be reported.
var collideWithBodies: Bool
If true, collisions with PhysicsBody3Ds will be reported.
var collisionMask: UInt32
The ray’s collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See Collision layers and masks in the documentation for more information.
var debugShapeCustomColor: Color
The custom color to use to draw the shape in the editor and at run-time if Visible Collision Shapes is enabled in the Debug menu. This color will be highlighted at run-time if the RayCast3D is colliding with something.
var debugShapeThickness: Int32
If set to 1, a line is used as the debug shape. Otherwise, a truncated pyramid is drawn to represent the RayCast3D. Requires Visible Collision Shapes to be enabled in the Debug menu for the debug shape to be visible at run-time.
var enabled: Bool
If true, collisions will be reported.
var excludeParent: Bool
If true, collisions will be ignored for this RayCast3D’s immediate parent.
var hitBackFaces: Bool
If true, the ray will hit back faces with concave polygon shapes with back face enabled or heightmap shapes.
var hitFromInside: Bool
If true, the ray will detect a hit when starting inside shapes. In this case the collision normal will be Vector3(0, 0, 0). Does not affect shapes with no volume like concave polygon or heightmap.
var targetPosition: Vector3
The ray’s destination point, relative to the RayCast’s position.
func addException(node: CollisionObject3D?)
Adds a collision exception so the ray does not report collisions with the specified CollisionObject3D node.
func addExceptionRid(RID)
Adds a collision exception so the ray does not report collisions with the specified RID.
func clearExceptions()
Removes all collision exceptions for this ray.
func forceRaycastUpdate()
Updates the collision information for the ray immediately, without waiting for the next _physics_process call. Use this method, for example, when the ray or its parent has changed state.
func getCollider() -> Object?
Returns the first object that the ray intersects, or null if no object is intersecting the ray (i.e. isColliding returns false).
func getColliderRid() -> RID
Returns the RID of the first object that the ray intersects, or an empty RID if no object is intersecting the ray (i.e. isColliding returns false).
func getColliderShape() -> Int32
Returns the shape ID of the first object that the ray intersects, or 0 if no object is intersecting the ray (i.e. isColliding returns false).
func getCollisionFaceIndex() -> Int32
Returns the collision object’s face index at the collision point, or -1 if the shape intersecting the ray is not a ConcavePolygonShape3D.
func getCollisionMaskValue(layerNumber: Int32) -> Bool
Returns whether or not the specified layer of the collisionMask is enabled, given a layerNumber between 1 and 32.
func getCollisionNormal() -> Vector3
Returns the normal of the intersecting object’s shape at the collision point, or Vector3(0, 0, 0) if the ray starts inside the shape and hitFromInside is true.
func getCollisionPoint() -> Vector3
Returns the collision point at which the ray intersects the closest object.
func isColliding() -> Bool
Returns whether any object is intersecting with the ray’s vector (considering the vector length).
func removeException(node: CollisionObject3D?)
Removes a collision exception so the ray does report collisions with the specified CollisionObject3D node.
func removeExceptionRid(RID)
Removes a collision exception so the ray does report collisions with the specified RID.
func setCollisionMaskValue(layerNumber: Int32, value: Bool)
Based on value, enables or disables the specified layer in the collisionMask, given a layerNumber between 1 and 32.