Module systems_collision
Registers colliders and dispatches touch and overlap callbacks.
Info:
- Author: Sharper Dev
Functions
| CollisionSystem.registerCollider (layer, boxCollider) | Adds a collider to a collision layer, creating the layer if needed. |
| CollisionSystem.unregisterCollider (layer, boxCollider) | Removes a collider from its registered collision layer. |
| CollisionSystem.setLayerActive (layer, active) | Enables or disables collision processing for a layer. |
| CollisionSystem.processCollisions () | Processes touch input and collider pairs in active layers. |
Local Functions
| processTouch (boxCollider) | Checks touch state for one enabled collider. |
| ignoresMetaLayer (boxCollider, metaLayer) | Checks whether a collider ignores the given meta layer. |
| processColliders (boxCollider1, boxCollider2) | Tests a collider pair and dispatches enter, stay, or exit callbacks. |
Functions
- CollisionSystem.registerCollider (layer, boxCollider)
-
Adds a collider to a collision layer, creating the layer if needed.
Parameters:
- layer number Collision layer used to group colliders.
- boxCollider table Collider to register.
Usage:
CollisionSystem.registerCollider(1, collider)
- CollisionSystem.unregisterCollider (layer, boxCollider)
-
Removes a collider from its registered collision layer.
Parameters:
- layer number Layer the collider was registered in.
- boxCollider table Collider to remove.
Usage:
CollisionSystem.unregisterCollider(1, collider)
- CollisionSystem.setLayerActive (layer, active)
-
Enables or disables collision processing for a layer.
Parameters:
- layer number Collision layer to update.
- active boolean Whether the layer should be processed.
Usage:
CollisionSystem.setLayerActive(1, false)
- CollisionSystem.processCollisions ()
- Processes touch input and collider pairs in active layers. Called automatically once per frame by the runtime.
Local Functions
- processTouch (boxCollider)
-
Checks touch state for one enabled collider.
Parameters:
- boxCollider table Collider to process.
- ignoresMetaLayer (boxCollider, metaLayer)
-
Checks whether a collider ignores the given meta layer.
Parameters:
- boxCollider table Collider whose ignore list is checked.
- metaLayer number Meta layer to look up.
Returns:
-
boolean
- processColliders (boxCollider1, boxCollider2)
-
Tests a collider pair and dispatches enter, stay, or exit callbacks.
The pair is skipped only when both colliders ignore the other's meta layer.
Parameters:
- boxCollider1 table First collider.
- boxCollider2 table Second collider.