Class default<OVERLAY>`Abstract`

Type Parameters

OVERLAY extends IOverlayInfo = IOverlayInfo

Hierarchy

default<OVERLAY>
- default

Index

Constructors

Properties

Accessors

isHidden maxVector minVector

Methods

addOrUpdate clear deregister generateOverlayInfo getDefaultAlpha hide invalidate onChangeZOrIsland onLoadOnIsland onPostFieldOfView onPreMoveToIsland onReset onTickEnd refresh register show updateOverlayAlpha

Constructors

constructor

new default<OVERLAY>(hideByDefault?: boolean): default<OVERLAY>
Type Parameters
- OVERLAY extends IOverlayInfo = IOverlayInfo
Parameters
- hideByDefault: boolean = false
Returns default<OVERLAY>
Inherited from default.constructor
- 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
Inherited from GenericOverlay.isHidden
- Defined in src/game/renderer/overlay/GenericOverlay.ts:27

maxVector

get maxVector(): default
Returns default
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:30

minVector

get minVector(): default
Returns default
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:26

Methods

addOrUpdate

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

clear

clear(): void
Returns void
Overrides default.clear
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:93

deregister

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

`Protected` `Abstract` generateOverlayInfo

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

getDefaultAlpha

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

hide

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

`Protected` invalidate

invalidate(tile: default, invalidateRange?: number): void
Parameters
- tile: default
- invalidateRange: number = 0
Returns void
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:89

`Protected` onChangeZOrIsland

onChangeZOrIsland(): void
Returns void
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:64

`Protected` onLoadOnIsland

onLoadOnIsland(): void
Returns void
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:55

`Protected` onPostFieldOfView

onPostFieldOfView(): void
Returns void
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:59

`Protected` onPreMoveToIsland

onPreMoveToIsland(): void
Returns void
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:49

`Protected` onReset

onReset(): void
Returns void
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:44

`Protected` onTickEnd

onTickEnd(): void
Returns void
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:70

refresh

refresh(): void
Returns void
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:98

register

register(): void
Returns void
- Defined in src/game/renderer/overlay/UniversalOverlay.ts:34

show

show(): void
Returns void
Inherited from default.show
- 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
Inherited from default.updateOverlayAlpha
- Defined in src/game/renderer/overlay/GenericOverlay.ts:80

Generated using TypeDoc