CollisionStayEventArgs
ClassArgs used for ColliderComponent.onCollisionStay, which is triggered every frame while a collision continues.
- Available on all platforms
Index
Properties
Methods
Example
// Add a callback for onCollisionStay on this collider
// @input Physics.ColliderComponent collider
script.collider.onCollisionStay.add(function(eventArgs) {
var collision = eventArgs.collision;
print("CollisionEnter(" + collision.id + "): contacts=" + collision.contactCount + " ---> " + collision.collider.getSceneObject().name);
});
Extends
Properties
collision
readonlycollision:Collision
Structure containing information about the current collision.
Methods
getTypeName()
staticgetTypeName():TypeName<CollisionStayEventArgs>
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<CollisionStayEventArgs>
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