Class PhysicsLayers

Physics collision layer matrix.

Index

Methods

add contains get remove rename set

Methods

add

add(name): boolean
Creates a physics collision layer and adds it to the matrix.
Parameters
- name: string
  The unique name for the layer.
Returns boolean
Whether the layer was successfully created.

contains

contains(name): boolean
Finds a physics collision layer with the specified name.
Parameters
- name: string
  The layer name.
Returns boolean
Whether a layer with the specified name was found.

get

get(first, second): boolean
Whether collisions should be detected between the two physics collision layers.
Parameters
- first: string
  The first layer.
- second: string
  The second layer.
Returns boolean
True if collisions should be detected, false otherwise.

remove

remove(name): boolean
Removes the physics collision layer with the specified name.
Parameters
- name: string
  The layer name.
Returns boolean
Whether the layer was removed.

rename

rename(oldName, newName): boolean
Renames a physics collision layer.
Parameters
- oldName: string
  The current name for the layer to rename.
- newName: string
  The new name for the layer.
Returns boolean
Whether the layer was renamed.

set

set(first, second, value): void
Whether collisions should be detected between the two physics collision layers.
Parameters
- first: string
  The first layer.
- second: string
  The second layer.
- value: boolean
  True if collisions should be detected, false otherwise.
Returns void

Generated using TypeDoc