Class default<OVERLAY, PARAMS>`Abstract`

Type Parameters

OVERLAY extends IOverlayInfo = IOverlayInfo
PARAMS extends any[] = []

Hierarchy

default
- default

Index

Constructors

Properties

Accessors

Methods

addOrUpdate clear generateOverlayInfo getDefaultAlpha hide show updateOverlayAlpha

Constructors

constructor

new default<OVERLAY, PARAMS>(hideByDefault?: boolean): default<OVERLAY, PARAMS>
Type Parameters
- OVERLAY extends IOverlayInfo = IOverlayInfo
- PARAMS extends any[] = []
Parameters
- hideByDefault: boolean = false
Returns default<OVERLAY, PARAMS>
- Defined in src/game/renderer/overlay/GenericOverlay.ts:23

Properties

`Protected` alpha

alpha: number

`Protected` `Readonly` overlay

overlay: Map<default, OVERLAY> = ...

Accessors

isHidden

get isHidden(): boolean
Returns boolean
- Defined in src/game/renderer/overlay/GenericOverlay.ts:27

Methods

addOrUpdate

addOrUpdate(tile: default, ...params: PARAMS): void
Parameters
- tile: default
- Rest ...params: PARAMS
Returns void
- Defined in src/game/renderer/overlay/GenericOverlay.ts:43

clear

clear(): void
Returns void
- Defined in src/game/renderer/overlay/GenericOverlay.ts:85

`Protected` `Abstract` generateOverlayInfo

generateOverlayInfo(tile: default, ...params: PARAMS): undefined | OVERLAY
Parameters
- tile: default
- Rest ...params: PARAMS
Returns undefined | OVERLAY
- Defined in src/game/renderer/overlay/GenericOverlay.ts:78

getDefaultAlpha

getDefaultAlpha(): number
Returns number
- Defined in src/game/renderer/overlay/GenericOverlay.ts:31

hide

hide(): void
Returns void
- Defined in src/game/renderer/overlay/GenericOverlay.ts:39

show

show(): void
Returns void
- Defined in src/game/renderer/overlay/GenericOverlay.ts:35

`Protected` updateOverlayAlpha

updateOverlayAlpha(tile: default, overlay: OVERLAY, alpha: number): undefined | OVERLAY
Parameters
- tile: default
- overlay: OVERLAY
- alpha: number
Returns undefined | OVERLAY
- Defined in src/game/renderer/overlay/GenericOverlay.ts:80

Generated using TypeDoc