Interface Filter

Intersection filter settings. Unifies settings for world probes and collider overlap tests. See also: ColliderComponent, Physics.

Example

// Given an object with a BodyComponent
// If the object intersects with the ray described
// by rayStart and rayEnd, 
// AND the object is Dynamic (not Static or Intangible)
// print a message

var rayStart = new vec3(0.0, -100.0, 0.0);
var rayEnd = new vec3(0.0, 100.0, 0.0);

// Create a probe to raycast through all worlds.
var globalProbe = Physics.createGlobalProbe();

// Set filter settings on it.
probe.filter.includeStatic = false;
probe.filter.includeDynamic = true;
probe.filter.includeIntangible = false;

globalProbe.rayCast(rayStart, rayEnd, function (hit) {
    if (hit) {
        print("Raycast hit: " + hit.collider.getSceneObject().name);
    }
});
Copy

// 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);
});
Copy