Panels
A panel is the core component for user experience in Charter. Each page is comprised of as many panels as you like.
Audio
An audio clip that can be played at will.
Field | Type | Description |
---|---|---|
Audio | Media | The audio file to play. |
Browse messages
A browsable interface of all messages for a role.
Field | Type | Description |
---|---|---|
As | Role | Which role to view messages as. Defaults to current player. |
Browse subpages
An index page of subpages. The user can browse through all visible subpages matching a given section.
Field | Type | Description |
---|---|---|
Title | Text | |
Section | Text |
Button
A button.
Field | Type | Description |
---|---|---|
Text | Text | Visible label on the button. |
Style | solo |
Choice
A multiple choice option. When selected by a user, the curresponding variable in the trip state will be updated.
Field | Type | Description |
---|---|---|
Text | Text | Visible title for the choice. |
Save to variable name | Variable name | |
Choices | List | |
Choices โ Value | Text | |
Choices โ Text | Text |
Current page
The current page for this player. Should only be used as part of an interface.
Directions
Displays live directions for the given route.
Field | Type | Description |
---|---|---|
Route | Route | |
Waypoint | Place | |
Geofence | Geofence | |
Destination | Text |
Image
An image.
Field | Type | Description |
---|---|---|
Image | Media | |
Style | float-right |
Message thread
All messages between two roles.
Field | Type | Description |
---|---|---|
With | Role | Which role to view messages with. |
As | Role | Which role to view messages as. Defaults to current player. |
Number entry
A number input.
Field | Type | Description |
---|---|---|
Submit button label | Text | |
Placeholder text | Text |
Room
A room for audio/video conferencing.
Field | Type | Description |
---|---|---|
Name | Text | Optionally specify a name for your room to differentiate it from other rooms. If no name is supplied, a room will be shared for each run of your experience. |
Video | Boolean | Send/recieve video as well as audio. |
Transmit | Boolean | If true, the viewer of this panel will broadcast to other members of the room. |
Text
A simple text.
Field | Type | Description |
---|---|---|
Text | Markdown | |
Style | centered or banner | Choose centered to center your text, or banner to give it a highlighted background. |
Text entry
A text entry field.
Field | Type | Description |
---|---|---|
Submit button label | Text | |
Placeholder text | Text |
Video
A video.
Field | Type | Description |
---|---|---|
Video | Media |
Yes or no
A yes/no choice. When updated, the corresponding variable in the trip state will be updated.
Field | Type | Description |
---|---|---|
Text | Text | |
Save to variable name | Variable name |