ProfectusInterface: LayerOptions
game/layers.LayerOptions
An object that configures a Layer. Even moreso than features, the developer is expected to include extra properties in this object. All Persistent refs must be included somewhere within the layer object.
Properties
classes
• Optional classes: Computable<Record<string, boolean>>
An object of classes that should be applied to the display.
Defined in
profectus/src/game/layers.tsx:116
color
• Optional color: Computable<string>
The color of the layer, used to theme the entire layer's display.
Defined in
profectus/src/game/layers.tsx:109
display
• display: Computable<CoercableComponent>
The layout of this layer's features. When the layer is open in tabs, this is the content that is display.
Defined in
profectus/src/game/layers.tsx:114
forceHideGoBack
• Optional forceHideGoBack: Computable<boolean>
Whether or not to force the go back button to be hidden. If true, go back will be hidden regardless of data/projInfo.allowGoBack.
Defined in
profectus/src/game/layers.tsx:133
minWidth
• Optional minWidth: Computable<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:139
minimizable
• Optional minimizable: Computable<boolean>
Whether or not the layer can be minimized. Defaults to true.
Defined in
profectus/src/game/layers.tsx:128
name
• Optional name: Computable<string>
The name of the layer, used on minimized tabs. Defaults to id.
Defined in
profectus/src/game/layers.tsx:123
style
• Optional style: Computable<StyleValue>
Styles that should be applied to the display.