JSDoc: Class: Group

Constructor

new Group(id, period)

Create a new Group.

Parameters:

Name	Type	Description
`id`	String	The id of this group.
`period`	Period	The period this group belongs to.

Source:

Group.js, line 10

Members

allPlayersCreated :boolean

whether or not all players in this group have been created yet.

Type:

boolean

Default Value:

false

Source:

Group.js, line 42

id :String

this group's id

Type:

String

Source:

Group.js, line 22

outputHide :array

'outputHide' fields are not included in output.

Type:

array

Default Value:

[]

Source:

Group.js, line 49

outputHideAuto :Array.<String>

'outputHideAuto' fields are not included in output.

Type:

Array.<String>

Source:

Group.js, line 55

period :Period

Each Group belongs to a single Period.

Type:

Period

Source:

Group.js, line 28

players :array

a list of the players in this group.

Type:

array

Default Value:

[]

Source:

Group.js, line 35

stageIndex :number

Type:

number

Default Value:

Source:

Group.js, line 67

tables :array

Type:

array

Default Value:

[]

Source:

Group.js, line 61

Methods

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

Loads the group from a given set of data.

CALLED FROM:

Session#load

Parameters:

Name	Type	Description
`json`	type	The JSON data describing the group.
`session`	type	The session to which the group belongs.

Source:

Group.js, line 91

Returns:

The group.

Type: Group

app() → {App}

Returns the app this group is in.

Source:

Group.js, line 371

Returns:

The app.

Type: App

emit(msgTitle, msgData)

Emit the given message to subscriber's of this group.

Parameters:

Name	Type	Description
`msgTitle`	type	The title of the message.
`msgData`	type	The data of the message.

Source:

Group.js, line 328

emitUpdate() → {type}

emitUpdate - description

Source:

Group.js, line 309

Returns:

description

Type: type

isFinished() → {type}

isFinished - description

Source:

Group.js, line 228

Returns:

description

Type: type

old() → {type}

old - description

Source:

Group.js, line 188

Returns:

description

Type: type

playerByParticipantId(id) → {type}

Find the player with the given participant ID.

Parameters:

Name	Type	Description
`id`	String	the given id.

Source:

Group.js, line 126

Returns:

the player where player.participant.id == id.

Type: type

playersExcept(player) → {type}

playersExcept - description

Parameters:

Name	Type	Description
`player`	type	description

Source:

Group.js, line 198

Returns:

description

Type: type

playerWithParticipant(participant) → {type}

playerWithParticipant - description

Parameters:

Name	Type	Description
`participant`	type	description

Source:

Group.js, line 141

Returns:

description

Type: type

roomId() → {type}

roomId - description

Source:

Group.js, line 346

Returns:

description

Type: type

save()

save - description

Source:

Group.js, line 454

session()

session - description

Source:

Group.js, line 337

Returns:

Session The session that this group belongs to.

shell() → {type}

shellLocal - description

Source:

Group.js, line 431

Returns:

description

Type: type

shellWithChildren() → {type}

shellAll - description

Source:

Group.js, line 390

Returns:

description

Type: type

shellWithParent() → {type}

shell - description

Source:

Group.js, line 265

Returns:

description

Type: type

stage()

Returns the stage that this group is currently in.

Source:

Group.js, line 77

sum(field)

Returns the sum of "field" over all players in the group.

Parameters:

Name	Type	Description
`field`	String

Source:

Group.js, line 318