Class Flags

Flags is a feature flag implementation for Excalibur. They can only be operated before Engine construction after which they are frozen and are read-only.

Flags are used to enable experimental or preview features in Excalibur.

Hierarchy

Flags

Index

Constructors

Methods

_reset disable enable freeze isEnabled show useCanvasGraphicsContext

Constructors

constructor

new Flags(): Flags
Returns Flags

Methods

`Static` _reset

_reset(): void
Internal
Resets internal flag state, not meant to be called by users. Only used for testing.

Calling this in your game is UNSUPPORTED

Returns void
- Defined in Flags.ts:35

`Static` disable

disable(flagName: string): void
Disable a specific feature flag by name. Note: can only be set before Engine constructor time
Parameters
- flagName: string
Returns void
- Defined in Flags.ts:54

`Static` enable

enable(flagName: string): void
Enable a specific feature flag by name. Note: can only be set before Engine constructor time
Parameters
- flagName: string
Returns void
- Defined in Flags.ts:43

`Static` freeze

freeze(): void
Freeze all flag modifications making them readonly

Returns void
- Defined in Flags.ts:25

`Static` isEnabled

isEnabled(flagName: string): boolean
Check if a flag is enabled. If the flag is disabled or does not exist false is returned
Parameters
- flagName: string
Returns boolean
- Defined in Flags.ts:65

`Static` show

show(): string[]
Show a list of currently known flags

Returns string[]
- Defined in Flags.ts:72

`Static` useCanvasGraphicsContext

useCanvasGraphicsContext(): void
Force excalibur to load the Canvas 2D graphics context fallback

Warning
not all features of excalibur are supported in the Canvas 2D fallback

Returns void
- Defined in Flags.ts:18