Actions

Every action makes a change in the state of your running trip.

Add to call

Add a player to a conference call.

FieldTypeDescription
RoleRoleThe role to add to the call.

Branch

A branch performs certain actions if an associated condition passes, and others if it does not.

FieldTypeDescription
IfConditionThe primary condition evaluated first.
Actions[Action]Actions executed if the primary condition passes.
ElseifsListA list of conditions and actions that are evaluated in order if the primary condition fails.
Elseifs โ†’ IfConditionA condition to evaluate.
Elseifs โ†’ Actions[Action]Actions to execute if the condition of this Else If field passes.
Else[Action]Actions executed if the primary condition and all Else If conditions fail.

Change role

Change the current player from one role to another.

FieldTypeDescription
ToRoleThe role to change the player to.

Focus tab

Bring up a specific tab on an interface.

FieldTypeDescription
RoleRoleThe role to apply the change to.
New valueTextThe title of the tab to focus.

Increment variable

Increment the numerical value of a value by reference.

FieldTypeDescription
NameVariable name
DeltaNumber

Initiate call

Initiate a call from Charter to a user.

FieldTypeDescription
ToRoleThe player to initiate a call to.
AsRoleThe player from whom the call originates.

Pause background audio

Pause currently playing audio.

FieldTypeDescription
RoleRoleThe role to pause the audio for.

Play background audio

Start playing audio for a certain role.

FieldTypeDescription
RoleRoleThe role to play the audio for.
AudioMediaThe audio file to play.

Play call clip

Play a call clip on an active phone call.

FieldTypeDescription
ClipCall clipThe clip to play.

Resume background audio

Resume currently paused audio.

FieldTypeDescription
RoleRoleThe role to resume the audio for.

Send audio

Send an audio message from one player to another.

FieldTypeDescription
FromRoleThe role to send the message from.
ToRoleThe role to send the message to.
AudioMediaThe content of the message to send.

Send email

Send an email from one player to another.

FieldTypeDescription
FromEmail accountInbox to send from.
ToRoleRole to send to.
SubjectTextSubject line for the email.
BodyMarkdownBody of the email.

Send image

Send an image from one player to another.

FieldTypeDescription
FromRoleThe role to send the message from.
ToRoleThe role to send the message to.
ImageMediaThe content of the message to send.

Send text

Send a text message from one player to another.

FieldTypeDescription
FromRoleThe role to send the message from.
ToRoleThe role to send the message to.
ContentTextThe content of the message to send.

Send to page

Set a role to a page.

FieldTypeDescription
RoleRoleThe role to send to a page.
PagePageThe page to send the matching players to.

Set variable

Update a variable in the trip state to either a constant number or string, or to match another variable by reference.

FieldTypeDescription
NameVariable nameThe name of the variable to set.
ToLookupThe name of a variable, the value of which we want to look up and use for the value to set. Or a specific number, true, false, or text surrounded by double quotes.

Signal cue

Signal a cue. A cue does nothing on its own, but usually will have triggers attached, which fire actions.

FieldTypeDescription
CueCueThe cue to signal.

Start scene

Start a new scene.

FieldTypeDescription
SceneSceneThe scene to start.

Stop background audio

Stop audio and reset audio state.

FieldTypeDescription
RoleRoleThe role to stop the audio for.

Wait

Wait a fixed period of time.

FieldTypeDescription
DurationDurationA duration, i.e. 1h, 30s, 4.2m

Wait before moment

Wait a fixed period of time before a scheduled moment.

FieldTypeDescription
UntilMoment
BeforeDurationA time offset, i.e. 1h, 30s, 4.2m

Wait until moment

Wait for a moment to arrive.

FieldTypeDescription
UntilMoment