Class PhysicsLayers

Physics collision layer matrix.

Remarks

Used to specify which layers can interact with each other through collisions.

Index

Accessors

Methods

add contains get remove rename set

Accessors

layers

get layers(): readonly string[]
The list of physics collision layers.

Returns readonly string[]

Methods

add

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

contains

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

get

get(first: string, second: string): 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(layerName: string): boolean
Removes the physics collision layer with the specified name.
Parameters
- layerName: string
  The layer name.
Returns boolean
Whether the layer was removed.

rename

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

set

set(first: string, second: string, value: boolean): 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