Lens Scripting API
    Preparing search index...

    Creates a spherical sensor volume to track overlaps with other colliders.

    This component actively maintains a list of objects within its radius and can be queried to find the closest point on those objects.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    api: Record<string, any>

    Generic object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.

    debugModeEnabled: boolean = false

    Display debug rendering for the proximity sensor.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    name: string
    radius: number = 1.0

    The radius of the spherical sensor in cemtimeters.

    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string
    updatePriority: number

    Methods

    • Returns a list of all colliders currently inside the large detection volume.

      Returns ColliderComponent[]

      An array of the overlapping ColliderComponents.

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns void

    • Updates the radius at runtime and automatically recalculates the larger detection radius needed for the buffer.

      Parameters

      • newRadius: number

        The new inner radius for the effect.

      Returns void