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.

FieldTypeDescription
AudioMediaThe audio file to play.

Browse messages

A browsable interface of all messages for a role.

FieldTypeDescription
AsRoleWhich 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.

FieldTypeDescription
TitleText
SectionText

Button

A button.

FieldTypeDescription
TextTextVisible label on the button.
Stylesolo

Choice

A multiple choice option. When selected by a user, the curresponding variable in the trip state will be updated.

FieldTypeDescription
TextTextVisible title for the choice.
Save to variable nameVariable name
ChoicesList
Choices โ†’ ValueText
Choices โ†’ TextText

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.

FieldTypeDescription
RouteRoute
WaypointPlace
GeofenceGeofence
DestinationText

Image

An image.

FieldTypeDescription
ImageMedia
Stylefloat-right

Message thread

All messages between two roles.

FieldTypeDescription
WithRoleWhich role to view messages with.
AsRoleWhich role to view messages as. Defaults to current player.

Number entry

A number input.

FieldTypeDescription
Submit button labelText
Placeholder textText

Room

A room for audio/video conferencing.

FieldTypeDescription
NameTextOptionally 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.
VideoBooleanSend/recieve video as well as audio.
TransmitBooleanIf true, the viewer of this panel will broadcast to other members of the room.

Text

A simple text.

FieldTypeDescription
TextMarkdown
Stylecentered or bannerChoose centered to center your text, or banner to give it a highlighted background.

Text entry

A text entry field.

FieldTypeDescription
Submit button labelText
Placeholder textText

Video

A video.

FieldTypeDescription
VideoMedia

Yes or no

A yes/no choice. When updated, the corresponding variable in the trip state will be updated.

FieldTypeDescription
TextText
Save to variable nameVariable name