Module: game/layers

Interfaces

Type aliases

GenericLayer

Ƭ GenericLayer: Replace<Layer<LayerOptions>, { minWidth: ProcessedComputable<number> ; minimizable: ProcessedComputable<boolean> ; name: ProcessedComputable<string> }>

Defined in

profectus/src/game/layers.tsx:84


Layer

Ƭ Layer<T>: Replace<T & BaseLayer, { classes: GetComputableType<T["classes"]> ; color: GetComputableType<T["color"]> ; display: GetComputableType<T["display"]> ; forceHideGoBack: GetComputableType<T["forceHideGoBack"]> ; links: GetComputableType<T["links"]> ; minWidth: GetComputableTypeWithDefault<T["minWidth"], 600> ; minimizable: GetComputableTypeWithDefault<T["minimizable"], true> ; name: GetComputableTypeWithDefault<T["name"], T["id"]> ; style: GetComputableType<T["style"]> }>

Type parameters

NameType
Textends LayerOptions

Defined in

profectus/src/game/layers.tsx:69

Variables

layers

Const layers: Record<string, Readonly<GenericLayer> | undefined> = {}

Defined in

profectus/src/game/layers.tsx:35

Functions

addLayer

addLayer(layer, player): void

Parameters

NameType
layerGenericLayer
playerObject
player.layers?Record<string, Record<string, unknown>>

Returns

void

Defined in

profectus/src/game/layers.tsx:116


createLayer

createLayer<T>(optionsFunc): Layer<T>

Type parameters

NameType
Textends LayerOptions

Parameters

NameType
optionsFunc() => T

Returns

Layer<T>

Defined in

profectus/src/game/layers.tsx:93


getLayer

getLayer<T>(layerID): T

Type parameters

NameType
Textends GenericLayer

Parameters

NameType
layerIDstring

Returns

T

Defined in

profectus/src/game/layers.tsx:139


reloadLayer

reloadLayer(layer): void

Parameters

NameType
layerGenericLayer

Returns

void

Defined in

profectus/src/game/layers.tsx:150


removeLayer

removeLayer(layer): void

Parameters

NameType
layerGenericLayer

Returns

void

Defined in

profectus/src/game/layers.tsx:143


setupLayerModal

setupLayerModal(layer): Object

Parameters

NameType
layerGenericLayer

Returns

Object

NameType
modalJSXFunction
openModalVoidFunction

Defined in

profectus/src/game/layers.tsx:157