LimitCameraBoundsStrategy

Prevent a camera from going beyond the given camera dimensions.

Implements

• CameraStrategy<BoundingBox>

Index

Constructors

• constructor

Properties

• boundSizeChecked
• target

Methods

• action

Constructors

constructor

• new LimitCameraBoundsStrategy(target: BoundingBox): LimitCameraBoundsStrategy

• Parameters

  • target: BoundingBox

  Returns LimitCameraBoundsStrategy

Properties

boundSizeChecked

boundSizeChecked: boolean = false

Useful for limiting the camera to a TileMap's dimensions, or a specific area inside the map.

Note that this strategy does not perform any movement by itself. It only sets the camera position to within the given bounds when the camera has gone beyond them. Thus, it is a good idea to combine it with other camera strategies and set this strategy as the last one.

Make sure that the camera bounds are at least as large as the viewport size.

@param

The bounding box to limit the camera to

publictarget

target: BoundingBox

Implementation of CameraStrategy.target

Target of the camera strategy that will be passed to the action

Methods

publicaction

• action(target: BoundingBox, cam: Camera, _eng: Engine<any>, elapsedMs: number): Vector

• Implementation of CameraStrategy.action

  Camera strategies perform an action to calculate a new focus returned out of the strategy

  ---

  Parameters

  • target: BoundingBox

    The target object to apply this camera strategy (if any)

  • cam: Camera

    The current camera implementation in excalibur running the game

  • _eng: Engine<any>

    The current engine running the game

  • elapsedMs: number

    The elapsed time in milliseconds since the last frame

  Returns Vector