OverlapEnterEventArgs
ClassArgs used for ColliderComponent.onOverlapEnter, which is triggered when the collider begins overlapping another object.
- Available on all platforms
Args used for ColliderComponent.onOverlapEnter, which is triggered when the collider begins overlapping another object. Typically used for volume triggers
Index
Properties
Methods
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
currentOverlapCount
readonlycurrentOverlapCount:number
Number of objects currently overlapping.
currentOverlaps
readonlycurrentOverlaps:Overlap[]
Array of all current overlaps.
overlap
readonlyoverlap:Overlap
Structure containing information about the current overlap.
Methods
getTypeName()
staticgetTypeName():TypeName<OverlapEnterEventArgs>
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<OverlapEnterEventArgs>
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean