- object: Object - Object to receive the event handler.
- component: String - Selection name (must exist in the Geometry LOD, and must not be in the notation "Component ##")
- code: String - Code that should be executed, when the event occurs. The code is passed data in the
_this variable, which contains: [object with event handler, component name, object it collided with, collision enter / exit]
- repeat: Boolean - Repeats the event call during the duration of the collision.
repeat is set to true, then the supplied code is executed each frame, while there is a collision with the component. When the collision with a component ends, the code is called with parameter 4 set to false, to indicate there is no longer any more collision with the component, and parameter 3 is null.
repeat is set to false, then the code is only executed upon entering the collision, and on exiting the collision. This is the recommend method of using
addCollisionEventHandler for a component, considering that the script does not need to constantly monitor the collision between two objects. When a collision occurs for the first time, parameter 4 passed to the
_this array is set to true, to indicate collision entrance. When the collisions stops, parameter 4 passed to
_this is false, and parameter 3 is Variables - Null, to indicate there is no longer a collision with the component.