Class: InWorld

Members

checkWorldBounds : boolean

If this is set to true the Game Object checks if it is within the World bounds each frame.

When it is no longer intersecting the world bounds it dispatches the onOutOfBounds event.

If it was previously out of bounds but is now intersecting the world bounds again it dispatches the onEnterBounds event.

It also optionally kills the Game Object if outOfBoundsKill is true.

When checkWorldBounds is enabled it forces the Game Object to calculate its full bounds every frame.

This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required, or you have tested performance and find it acceptable.

Type:

• boolean

Source:

src/gameobjects/components/InWorld.js line 103

<readonly> inWorld : boolean

Checks if the Game Objects bounds are within, or intersect at any point with the Game World bounds.

Type:

• boolean

Source:

src/gameobjects/components/InWorld.js line 134

outOfBoundsKill : boolean

If this and the checkWorldBounds property are both set to true then the kill method is called as soon as inWorld returns false.

Type:

• boolean

Source:

src/gameobjects/components/InWorld.js line 111

outOfCameraBoundsKill : boolean

If this and the autoCull property are both set to true, then the kill method is called as soon as the Game Object leaves the camera bounds.

Type:

• boolean

Source:

src/gameobjects/components/InWorld.js line 120

Methods

<static> preUpdate()

The InWorld component preUpdate handler. Called automatically by the Game Object.

Source:

src/gameobjects/components/InWorld.js line 22