Skip to main content

Collapsible

This view allows you to collapse other views under it. This is known as an accordion in web development. It is very useful to avoid cluttering the UI with details the player might not always be interested in seeing.

JSON Format

{
"type": "collapsible",
"id": ...,
"type": ...,
"margin_left": ...,
"margin_right": ...,
"margin_top": ...,
"margin_bottom": ...,
"is_visible": ...,
"validation_message": ...,
"title": ...,
"subtitle": ...,
"subviews": ...,
"start_expanded": ...
}

Fields

FieldTypeRequiredDescription
idStringA unique identifier for the view. You can use it to reference view values in stat formulas by doing $view.view_id (where view_id is the id that was assigned to this view by you in the system definition)
typeRPGViewTypeThe type of this view. Note that these are all in camelCase.
margin_leftdoubleOptional. How much margin to add to the left of this view.
margin_rightdoubleOptional. How much margin to add to the right of this view.
margin_topdoubleOptional. How much margin to add to the top of this view.
margin_bottomdoubleOptional. How much margin to add to the bottom of this view.
is_visibleStatFormulaComponentOptional. A formula to specify if the view should be visible or not. Must return a bool.
validation_messageStatFormulaComponentOptional. If this view is an input, you can define this formula to return a message when the input value is invalid. If the input is valid, you should return null. Otherwise, make the formula return the string that should be shown to the user.
titleStatFormulaComponentA stat formula for the title of the collapsible. It usually is a section name, like "Spells" or "Features".
subtitleStatFormulaComponentOptional. Analogous to the title property.
subviewsList<RPGView>A list of views that should be displayed inside the collapsible and, hence, could be shown or hidden depending on the collapsible's state. This list will display the views vertically, one after the other.
start_expandedboolOptional. Defaults to false. Whether the collapsible should start expanded or not.