Class PlayerVoteState<RoomType>

Represents a player's voting state.

Type parameters

RoomType: Hostable

Hierarchy

PlayerVoteState

Index

Constructors

constructor

Accessors

Properties

Constructors

constructor

new PlayerVoteState<RoomType>(room: RoomType, playerId: number, votedForId: number): PlayerVoteState<RoomType>

- Defined in core/lib/misc/PlayerVoteState.ts:14
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- playerId: number
- votedForId: number
Returns PlayerVoteState<RoomType>

Accessors

didMissVote

get didMissVote(): boolean

- Defined in core/lib/misc/PlayerVoteState.ts:37
Whether this player didn't vote by the end of the meeting.

Returns boolean

didSkip

get didSkip(): boolean

- Defined in core/lib/misc/PlayerVoteState.ts:44
Whether this player skipped voting.

Returns boolean

hasVoted

get hasVoted(): boolean

- Defined in core/lib/misc/PlayerVoteState.ts:51
Whether this player has either voted for a player or voted to skip.

Returns boolean

isDead

get isDead(): boolean

- Defined in core/lib/misc/PlayerVoteState.ts:30
Whether the player that this state represents is dead.

Returns boolean

player

get player(): undefined | PlayerData<RoomType>

- Defined in core/lib/misc/PlayerVoteState.ts:23
The player that this vote state is for.

Returns undefined | PlayerData<RoomType>

votedFor

get votedFor(): undefined | PlayerData<RoomType>

- Defined in core/lib/misc/PlayerVoteState.ts:59
The player that this player voted for, if any.

Returns undefined | PlayerData<RoomType>

Properties

playerId

playerId: number

Readonly room

room: RoomType

votedForId

votedForId: number

Generated using TypeDoc