Skip to main content

Overlap

Class

Exposes state generated for ColliderComponent overlap events.

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

Since Lens Scripting v164

Index

Example

// When the collider begins to overlap another collider, print information about the overlap

// @input Physics.ColliderComponent collider

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

Extends

Properties

collider

readonly collider: ColliderComponent

The collider which is overlapping.

Since

Lens Scripting Version 164


id

readonly id: number

ID of the overlap, unique for this overlap.

Since

Lens Scripting Version 164

Methods

getTypeName()

static getTypeName(): TypeName<Overlap>

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<Overlap>

Since

Lens Scripting Version 164

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

See also