Resources

Resources are the primary objects in your script.

Behavior

A fires when a defined event occurs. Once fired, it will apply a set of actions, which change the trip state.

Field	Type	Description
Scene	Scene
Trigger	Event
Actions	[Action]

Call clip

A snippet of audio that can be played as part of phone calls.

Field	Type	Description
Scene	Scene	The scene at which this clip will be played.
Transcript	Text	The text transcript used to generate audio via speech-to-text. Only required if there is not a media path.
Voice	alice, man or woman	The voice used to generate audio via speech-to-text. Only required if there is not a media path.
Audio	Media	The audio clip to play.
Answer expected	Boolean	Is an answer expected for this clip?
Answer hints	[Text]	List of suggestions for decoding the voice of the answer.

• The Clip field of the Play call clip action is a Call clip.
• The Clip field of the Call clip answered event is a Call clip.

Cue

A signal that can be fired by button presses or other game actions. In and of itself, a cue does nothing, but most commonly it will be used to fire triggers that launch other game actions.

Field	Type	Description
Scene	Scene	The scene during which this cue may be signaled. If this scene is not active, the cue will not be signaled.

• The Cue field of the Signal cue action is a Cue.
• The Cue field of the Cue signaled event is a Cue.

Email account

An email account that you have access to. (This requires some custom setup.)

Field	Type	Description
Role	Role	Role this account belongs to.
Address	charter@firstperson.travel	Email address to send from. Currently must be charter@firstperson.travel.

• The From field of the Send email action is a Email account.

Geofence

A circular region around a waypoint. It can be used to trigger events when players enter or leave a region, or when messages are sent from within that region.

Field	Type	Description
Center	Place	Center of the geofence.
Distance	Number	Distance in meters around the center that is counted as within the geofence.

• The Geofence field of the Geofence entered event is a Geofence.
• The Geofence field of the Geofence exited event is a Geofence.

Interface

A combination of panels that create a user interface for a tablet, phone, or device.

Field	Type	Description
Entryway	Boolean	If set to true, new participants can enter your experience via a webform into this interface.
Performer	Boolean	If set to true, performers can access this interface from the performer page.
Tabs	List	A list of tabs. If there is only one tab visible, the tabs bar will not be displayed.
Tabs → Title	Text	The title of this tab.
Tabs → Visible if	Condition	An optional test to determine if the tab is visible or not.
Tabs → Panels	[Panel]	List of user interface panels.
Background color	Color	Color to use for the background of your interface.
Header color	Color	Color to use for the navigation elements of your interface: the header and tabs.
Active color	Color	Color to use for active areas like the selected tab.
Primary color	Color	Color to use for primary actions like buttons.
Font family	Arvo, BioRhyme, Courier Prime, Crimson, Inconsolata, Inter, Lora, Montserrat, Playfair, Raleway, Roboto, Source Sans or Work Sans	The font family to use for text in your interface.
Custom css	Text	Supply any custom styles to be inserted into your interface.

Moment

A time at which things happen over the trip. The specific schedule is determined by a variant.

• The Until field of the Wait before moment action is a Moment.
• The Until field of the Wait until moment action is a Moment.
• The Moment field of the Moment occurred event is a Moment.

Page

A user interface that can be displayed to a player when the corresponding scene and state is active.

Field	Type	Description
Scene	Scene	The scene during which this page is active. If this scene is not the current scene, the page may still be displayed, but no user action may be taken.
Interface	Interface	The interface that this page is a part of.
Headline	Text	A high-level directive for the player, that will be displayed in large font at the top of the interface.
Panels	[Panel]	List of user interface panels.

• The Page field of the Send to page action is a Page.

Phone line

A phone number by which one player can contact another via text or phone calls.

Field	Type	Description
For	Role	The role who will be sending or receiving messages through this phone line.
Counterpart	Role	The role that is being messaged with.
Impersonating	Role	In cases where you want a participant to impersonate a different role, this is the role that is being impersonated. Otherwise this can be left blank.
Entryway	Boolean	If this value is true, the phone line will be assigned a universal number. New players can text this number to start a new trip.

Place

A place used by the trip. Each place can have multiple locations that can be set for each trip. For instance, a "lunch" place can have two locations, each a different restaurant.

Field	Type	Description
Locations	List	A list of locations that this place could refer to.
Locations → Location	Location	The address of the location.

Role

A participant in the experience. This participant can be a player, an actor, or a scripted automaton.

Field	Type	Description
Interface	Interface
Max users	Integer	The maximum number of users who may be a part of this trip as this role. This can be used to support groups of more than one player and device, all sharing the same trip state.
Role variable names	[Variable name]	(Advanced) Indicates a list of special variables that can be supplied for each user account that may play this role. This could be used to specify a custom image for each actor, or custom text associated with a certain role.

• The Role field of the Play background audio action is a Role.
• The Role field of the Pause background audio action is a Role.
• The Role field of the Resume background audio action is a Role.
• The Role field of the Stop background audio action is a Role.
• The Role field of the Add to call action is a Role.
• The To field of the Initiate call action is a Role.
• The To field of the Send email action is a Role.
• The From field of the Send text action is a Role.
• The From field of the Send image action is a Role.
• The From field of the Send audio action is a Role.
• The Role field of the Focus tab action is a Role.
• The Role field of the Send to page action is a Role.
• The To field of the Change role action is a Role.
• The From field of the Call answered event is a Role.
• The From field of the Call received event is a Role.
• The Role field of the Call ended event is a Role.
• The Role field of the Geofence entered event is a Role.
• The Role field of the Geofence exited event is a Role.
• The From field of the Text received event is a Role.
• The From field of the Image received event is a Role.
• The From field of the Audio received event is a Role.

Route

A path between one waypoint and another, including walking/driving directions. If one of the waypoints has multiple options, then multiple paths will be fetched.

Field	Type	Description
From	Place	The starting waypoint.
To	Place	The ending waypoint
Method	driving, walking or cycling	The method of transit for directions.
Waypoints	[Coords]	An optional list of coordinates through through which the route must pass.

Scene

A temporal unit of experience. Usually only one scene is active at a time.

Field	Type	Description
Always active	Boolean	Enable if this scene is always active. Otherwise, the triggers in this scene will only fire if it is the current scene of the trip.

• The Scene field of the Start scene action is a Scene.

Subpage

A page that can be displayed in a list inside a Content Browse page.

Field	Type	Description
Interface	Interface	The parent interface in which this subpage is displayed.
Section	Text	A string indicating which a grouping for this subpage. The the "Browse Subpages" panel will show all visible subpages grouped by section.
Visible if	Condition	An optional test to determine if the panel is visible or not.
Panels	[Panel]	Content of the subpage.

Variant

A variation in trip values, including timing, values, and waypoint options.

Field	Type	Description
Default	Boolean	If default is set to true, all new trips will have these defaults set.
Variant group	Text	You can group variants if you want to allow only one of a set to be selected. For instance, if you have a basic and deluxe variant, give both variants a group name of "package", and only one can be selected at a time.
Variable defaults	Variable name to Value
Customization defaults	Variable name to Value
Moment schedule	Moment to Time