JSDoc: Class: Player

Constructor

new Player()

Source:

Player.js, line 10

Members

group :Group

This player's group.

Type:

Group

Source:

Player.js, line 24

id :String

The player's ID.

Type:

String

Source:

Player.js, line 30

idInGroup :Number

Type:

Number

Source:

Player.js, line 35

participant :Participant

This player's participant.

Type:

Participant

Source:

Player.js, line 18

points :number

Type:

number

Default Value:

Source:

Player.js, line 41

stage :Stage

Type:

Stage

Default Value:

null

Source:

Player.js, line 69

stageIndex :number

Type:

number

Default Value:

Source:

Player.js, line 63

status :string

The current status of this player.

'ready': the player is ready to play their current stage, but is waiting (for their fellow group members).
'playing': the player is playing their current stage.
'done': the player is done playing their current stage, waiting to call 'Stage.playerEnd(player)'.
'finished': player is ready to move to next stage.

See Session Flow tutorial for more details.

Type:

string

Default Value:

'ready'

Source:

Player.js, line 57

Methods

addClient(client)

addClient - description

Parameters:

Name	Type	Description
`client`	type	description

Source:

Player.js, line 268

app()

app - description

Source:

Player.js, line 293

Returns:

App The app that this player is a member of.

appIndex() → {type}

appIndex - description

Source:

Player.js, line 202

Returns:

description

Type: type

atLeastFinishedStage()

Is the player at least finished the given stage of the given period?

Return false if any of the following are true:

the player is in a previous app.
the player is in the same app, but a previous period.
the player is in the same period, but a previous stage.
the player is in the same stage, but is still 'playing'.

Otherwise return true.

CALLED FROM:

Stage#playerCanGroupProceedToNextStage.

Source:

Player.js, line 622

compId() → {type}

compId - description

Source:

Player.js, line 277

Returns:

description

Type: type

emit(name, dta)

emit - description

Parameters:

Name	Type	Description
`name`	type	description
`dta`	type	description

Source:

Player.js, line 360

emitUpdate() → {type}

emitUpdate - description

Source:

Player.js, line 466

Returns:

description

Type: type

endStage(endGroupopt, moveopt)

Parameters:

Name	Type	Attributes	Default	Description
`endGroup`	boolean	<optional>	true	Then try to end the stage for the group too.
`move`	boolean	<optional>	true	Then move on to the next stage. The group ending a stage that waits for everyone (see Group#endStage) moves its players itself, after groupEnd.

Source:

Player.js, line 793

endStageIfStill()

Ends stage for this player if they are still playing it (see timeUp).

Source:

Player.js, line 780

inAllPeriods()

This participant's players in this app's periods, from the first to this one.

Source:

Player.js, line 329

inPeriod()

This participant's player in period n (from 1) of this app, or null if there is none yet.

Source:

Player.js, line 323

inPreviousPeriods()

This participant's players in this app's periods before this one, first first.

Source:

Player.js, line 341

isFinished() → {type}

isFinished - description

Source:

Player.js, line 498

Returns:

description

Type: type

isFinishedStage()

Whether this player has finished stage, of their current period: played it (done or
finished), or gone past it. (Players skip stages on their own, so the group's current
stage, which isFinished goes by, may be past theirs.)

Source:

Player.js, line 552

isReady() → {type}

isReady - description

Source:

Player.js, line 567

Returns:

description

Type: type

matchesPlayer(plyrShell) → {boolean}

matchesPlayer - description

Parameters:

Name	Type	Description
`plyrShell`	type	description

Source:

Player.js, line 303

Returns:

whether or not the inputted player matches this one.

Type: boolean

nextStage()

The next stage for this player.

Source:

Player.js, line 227

old() → {type}

old - description

Source:

Player.js, line 318

Returns:

description

Type: type

otherPlayersInGroup() → {type}

otherPlayersInGroup - description

Source:

Player.js, line 259

Returns:

description

Type: type

period() → {type}

period - description

Source:

Player.js, line 220

Returns:

description

Type: type

periodIndex() → {type}

periodIndex - description

Source:

Player.js, line 211

Returns:

description

Type: type

roomId() → {type}

roomId - description

Source:

Player.js, line 184

Returns:

description

Type: type

save()

save - description

Source:

Player.js, line 590

sendUpdate(channel)

sendUpdate - description

Parameters:

Name	Type	Description
`channel`	type	description

Source:

Player.js, line 481

session() → {type}

session - description

Source:

Player.js, line 350

Returns:

description

Type: type

shell() → {type}

this - description

Source:

Player.js, line 377

Returns:

description

Type: type

shellWithChildren() → {type}

CALLED FROM

Participant#shellAll

Source:

Player.js, line 432

Returns:

description

Type: type

startTimer()

Starts this player's own timer for stage, if it has one (see Stage#clientDuration).

Source:

Player.js, line 718

timeUp()

This player's time for stage is up: marks them timed out, and unless the stage stays
open (Stage#endOnTimeout), asks their page to submit what it has and, if it has not
within stage.timeoutGrace seconds (or the player has no page), ends the stage for them.

Source:

Player.js, line 745

(static) load(json, session) → {type}

Parameters:

Name	Type	Description
`json`	type	description
`session`	type	description

Source:

Player.js, line 660

Returns:

description

Type: type