Class: Stage

Stage()

A stage of an App.

Constructor

new Stage()

Source:

Members

activeScreen

Default Value:
  • null
Source:

app :App

the app of this stage.

Type:
Source:

clientDuration :number

How long clients have before stage is auto-submitted (from client, not from server).
if <= 0, then no client timeout for this stage.

Type:
  • number
Default Value:
  • 0
Source:

duration :number

timeout duration in seconds
if <= 0, then no timeout for this stage.

Type:
  • number
Default Value:
  • 0
Source:

html

Default Value:
  • null
Source:

htmlFile

Default Value:
  • null
Source:

id :String

The identifier of this stage.

Type:
  • String
Source:

name :Name

for display only, should be unique.

Type:
  • Name
Source:

onPlaySendPlayer :boolean

when starting stage for a player, send 'player' object or not.
fields determined by player.outputFields.

Type:
  • boolean
Default Value:
  • true
Source:

outputHide :Array

'outputHide' fields are not included in output.

Type:
  • Array
Default Value:
  • []
Source:

outputHideAuto :Array.<String>

'outputHideAuto' fields are not included in output.

Type:
  • Array.<String>
Source:

repetitions :number

The number of times to repeat child stages.

Type:
  • number
Default Value:
  • 1
Source:

stages :Array

Child stages. If length > 0, then ...

Type:
  • Array
Default Value:
  • []
Source:

updateObject :string

how far up the tree should be sent on update. More data comes at cost of higher latency.
possible values: 'player', 'group'

Type:
  • string
Default Value:
  • 'player'
Source:

useAppActiveScreen :boolean

Type:
  • boolean
Default Value:
  • true
Source:

useAppWaitingScreen :boolean

Type:
  • boolean
Default Value:
  • true
Source:

useIdAsHTMLFileName :boolean

Type:
  • boolean
Default Value:
  • true
Source:

waitOnTimerEnd :boolean

Wait for all players to finish stage on their own (true), or end anyway (false).

Type:
  • boolean
Default Value:
  • true
Source:

waitToEnd :boolean

Wait for all players in group to be 'finished' or 'done' before calling Stage.groupEnd(group) and Stage.playerStart(player) are called.

Type:
  • boolean
Default Value:
  • true
Source:

waitToStart :boolean

Wait for all players in group to be 'ready' before calling Stage.groupStart(group) and Stage.playerStart(player) are called.

Type:
  • boolean
Default Value:
  • true
Source:

wrapPlayingScreenInFormTag

Wrap stage playing screens in a

tag or not.

Source:

Methods

canPlayerParticipate(player) → {type}

Can the given player participate in this stage?

Parameters:
Name Type Description
player type

description
Source:
Returns:

description

Type
type

groupEnd(group) → {type}

Overwrite in app.jtt.

Parameters:
Name Type Description
group type

description
Source:
Returns:

description

Type
type

groupStart()

Called before the first player plays this stage.
Overwrite in app.jtt

Source:

indexInApp() → {type}

indexInApp - description

Source:
Returns:

description

Type
type

playerEnd(player)

End this stage for the given player.
Overwrite in app.jtt.

Parameters:
Name Type Description
player type

description
Source:

playerStart()

Called when this player plays this stage.
Overwrite in app.jtt.

Source:

save() → {type}

CALLED FROM:

Source:
Returns:

description

Type
type

session() → {type}

session - description

Source:
Returns:

description

Type
type

shell() → {type}

CALLED FROM:

Source:
Returns:

description

Type
type

shellWithParent() → {type}

shellWithParent - description

Source:
Returns:

description

Type
type