Lens Scripting API

    Class Filter

    Script interface for applying collision filtering to colliders and ray/shape-casts.

    // Create a new filter and adjust its settings.
    var filter = Physics.Filter.create();
    filter.skipLayers = LayerSet.fromNumber(101);
    filter.onlyColliders = [script.myCollider1, script.myCollider2];

    // Assign the filter as default for the root world so it affects all colliders.
    var settings = Physics.getRootWorldSettings();
    settings.defaultFilter = filter;

    // Perform a ray cast using the filter.
    var probe = Physics.createGlobalProbe();
    probe.filter = filter;
    probe.rayCast(new vec3(0, 100, 0), new vec3(0, -100, 0), function (hit) {
       print(hit);
    });

    // Use the filter for collider overlap test.
    script.myCollider3.overlapFilter = filter;
    script.myCollider3.onOverlapEnter.add(function (e) {
        print("OverlapEnter(" + e.overlap.id + "): " + e.overlap.collider);
    });

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    includeDynamic includeIntangible includeStatic onlyColliders onlyLayers skipColliders skipLayers

    Methods

    create getTypeName isOfType isSame

    Constructors

    Properties

    includeDynamic: boolean

    Include dynamic objects in intersection tests.

    includeIntangible: boolean

    Include intangible objects in intersection tests.

    includeStatic: boolean

    Include static objects in intersection tests.

    onlyColliders: ColliderComponent[]

    If non-empty, only perform collision with these colliders. In other words: the set of colliders to include when performing collision tests, excluding all others. If empty, this setting is disabled (effectively including all colliders, minus skipColliders).

    onlyLayers: LayerSet

    If non-empty, only perform collision with colliders in these layers. In other words: the set of layers to include when performing collision tests, excluding all others. If empty, this setting is disabled (effectively including all layers, minus skipLayers).

    skipColliders: ColliderComponent[]

    Skip collision with these colliders. In other words: the set of colliders to exclude when performing collision tests. This takes precedence over onlyColliders, so a collider that is in both is skipped.

    skipLayers: LayerSet

    Skip collision with colliders in these layers. In other words: the set of layers to exclude when performing collision tests. This takes precedence over onlyLayers, so a layer that is in both is skipped.

    Methods

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

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR