Profectus / game/layers / LayerOptions
Interface: LayerOptions ​
An object that configures a Layer. Even moreso than features, the developer is expected to include extra properties in this object. All game/persistence.Persistent refs must be included somewhere within the layer object.
Properties ​
classes? ​
optional
classes:MaybeRefOrGetter
<Record
<string
,boolean
>>
An object of classes that should be applied to the display.
Defined in ​
profectus/src/game/layers.tsx:113
color? ​
optional
color:MaybeRefOrGetter
<string
>
The color of the layer, used to theme the entire layer's display.
Defined in ​
profectus/src/game/layers.tsx:106
display ​
display:
MaybeGetter
<Renderable
>
The layout of this layer's features. When the layer is open in game/player.Player.tabs, this is the content that is displayed.
Defined in ​
profectus/src/game/layers.tsx:111
forceHideGoBack? ​
optional
forceHideGoBack:MaybeRefOrGetter
<boolean
>
Whether or not to force the go back button to be hidden. If true, go back will be hidden regardless of allowGoBack value in the project settings.
Defined in ​
profectus/src/game/layers.tsx:135
minimizable? ​
optional
minimizable:MaybeRefOrGetter
<boolean
>
Whether or not the layer can be minimized. Defaults to true.
Defined in ​
profectus/src/game/layers.tsx:125
minimizedDisplay? ​
optional
minimizedDisplay:MaybeGetter
<Renderable
>
The layout of this layer's features. When the layer is open in game/player.Player.tabs, but the tab is Layer.minimized this is the content that is displayed.
Defined in ​
profectus/src/game/layers.tsx:130
minWidth? ​
optional
minWidth:MaybeRefOrGetter
<string
|number
>
A CSS min-width value that is applied to the layer. Can be a number, in which case the unit is assumed to be px. Defaults to 600px.
Defined in ​
profectus/src/game/layers.tsx:141
name? ​
optional
name:MaybeRefOrGetter
<string
>
The name of the layer, used on minimized tabs. Defaults to BaseLayer.id.
Defined in ​
profectus/src/game/layers.tsx:120
style? ​
optional
style:MaybeRefOrGetter
<CSSProperties
>
Styles that should be applied to the display.