getCollisionPoint(index:)

Other members in extension

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 shape’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 ShapeCast3D is colliding with something.

• var enabled: Bool

  If true, collisions will be reported.

• var excludeParent: Bool

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

• var margin: Double

  The collision margin for the shape. A larger margin helps detecting collisions more consistently, at the cost of precision.

• var maxResults: Int32

  The number of intersections can be limited with this parameter, to reduce the processing time.

• var shape: Shape3D?

  The Shape3D-derived shape to be used for collision queries.

• var targetPosition: Vector3

  The shape’s destination point, relative to this node’s position.

• func addException(node: CollisionObject3D?)

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

• func addExceptionRid(RID)

  Adds a collision exception so the shape does not report collisions with the specified RID.

• func clearExceptions()

  Removes all collision exceptions for this ShapeCast3D.

• func forceShapecastUpdate()

  Updates the collision information for the shape immediately, without waiting for the next _physics_process call. Use this method, for example, when the shape or its parent has changed state.

• func getClosestCollisionSafeFraction() -> Double

  The fraction from the ShapeCast3D’s origin to its targetPosition (between 0 and 1) of how far the shape can move without triggering a collision.

• func getClosestCollisionUnsafeFraction() -> Double

  The fraction from the ShapeCast3D’s origin to its targetPosition (between 0 and 1) of how far the shape must move to trigger a collision.

• func getCollider(index: Int32) -> Object?

  Returns the collided Object of one of the multiple collisions at index, or null if no object is intersecting the shape (i.e. isColliding returns false).

• func getColliderRid(index: Int32) -> RID

  Returns the RID of the collided object of one of the multiple collisions at index.

• func getColliderShape(index: Int32) -> Int32

  Returns the shape ID of the colliding shape of one of the multiple collisions at index, or 0 if no object is intersecting the shape (i.e. isColliding returns false).

• func getCollisionCount() -> Int32

  The number of collisions detected at the point of impact. Use this to iterate over multiple collisions as provided by getCollider(index:), getColliderShape(index:), getCollisionPoint(index:), and getCollisionNormal(index:) methods.

• 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(index: Int32) -> Vector3

  Returns the normal of one of the multiple collisions at index of the intersecting object.

• func isColliding() -> Bool

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

• func removeException(node: CollisionObject3D?)

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

• func removeExceptionRid(RID)

  Removes a collision exception so the shape does report collisions with the specified RID.

• func resourceChanged(resource: Resource?)

  Obsoleted. Use [signal Resource.changed] instead.

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