Skip to main content

OverlapExitEventArgs

Class

Args used for ColliderComponent.onOverlapExit, which is triggered when the collider stops overlapping another object.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Args used for ColliderComponent.onOverlapExit, which is triggered when the collider stops overlapping another object. Typically used for volume triggers.

Index

Example

// When the collider stops overlapping another collider, print information about the overlap

// @input Physics.ColliderComponent collider

script.collider.onOverlapExit.add(function (e) {
var overlap = e.overlap;
print("OverlapExit(" + overlap.id + "): Overlap with: " + overlap.collider.getSceneObject().name);
});

Extends

Properties

currentOverlapCount

readonly currentOverlapCount: number

Number of objects currently overlapping.


currentOverlaps

readonly currentOverlaps: Overlap[]

Array of all current overlaps.


overlap

readonly overlap: Overlap

Structure containing information about the current overlap.

Methods

getTypeName()

static getTypeName(): TypeName<OverlapExitEventArgs>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<OverlapExitEventArgs>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

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

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame