Class Question`Abstract`

Hierarchy (View Summary)

Question
- MultipleChoiceQuestion
- PlayerPicksQuestion

Index

Constructors

`Protected`constructor

new Question(
    song: {
        artist: string;
        audioURL: string;
        cover: string | null;
        hrefURL: string;
        name: string;
    },
): Question
Constructs a question asking which is the correct song.
Parameters
- song: {
      artist: string;
      audioURL: string;
      cover: string | null;
      hrefURL: string;
      name: string;
  }
  The correct song for this question.
  - artist: string
    The name of the song artist.
  - audioURL: string
    A URL to the audio file of the song. Currently only audio previews from Apple Music and SoundCloud are allowed.
  - cover: string | null
    Cover URL of the song.
  - hrefURL: string
    The URL users will be redirected to when clicking.
  - name: string
    The name of the song.
Returns Question
- Defined in src/server/game/Question.ts:23

Properties

`Readonly`song

song: {
    artist: string;
    audioURL: string;
    cover: string | null;
    hrefURL: string;
    name: string;
}

The correct song for this question.

Type Declaration

artist: string
The name of the song artist.
audioURL: string
A URL to the audio file of the song. Currently only audio previews from Apple Music and SoundCloud are allowed.
cover: string | null
Cover URL of the song.
hrefURL: string
The URL users will be redirected to when clicking.
name: string
The name of the song.

startPos

startPos: number = ...

The random/user-defined audio start position index (0-2) for this question.

See

RoomConfigMessageSchema.audioStartPosition

Methods

`Protected`baseToStorage

baseToStorage(): PersistedAbstractQuestion
Protected
Serializes only this base class to a PersistedAbstractGame object.

Returns PersistedAbstractQuestion
- Defined in src/server/game/Question.ts:35

`Abstract`getQuestionMessage

getQuestionMessage(gamePhase: GamePhase): QuestionMessage
Returns the round message for the current phase.
Parameters
- gamePhase: GamePhase
  the current game phase
Returns QuestionMessage
- Defined in src/server/game/Question.ts:29

`Abstract`toStorage

toStorage(): PersistedQuestion
Serializes this game to a PersistedGame object.

Returns PersistedQuestion
- Defined in src/server/game/Question.ts:45

Class Question`Abstract`

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

`Protected`constructor

Parameters

artist: string

audioURL: string

cover: string | null

hrefURL: string

name: string

Returns Question

Properties

`Readonly`song

Type Declaration

artist: string

audioURL: string

cover: string | null

hrefURL: string

name: string

startPos

See

Methods

`Protected`baseToStorage

Returns PersistedAbstractQuestion

`Abstract`getQuestionMessage

Parameters

Returns QuestionMessage

`Abstract`toStorage

Returns PersistedQuestion

Settings

On This Page

Class QuestionAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

artist: string

audioURL: string

cover: string | null

hrefURL: string

name: string

Returns Question

Properties

Readonlysong

Type Declaration

artist: string

audioURL: string

cover: string | null

hrefURL: string

name: string

startPos

See

Methods

ProtectedbaseToStorage

Returns PersistedAbstractQuestion

AbstractgetQuestionMessage

Parameters

Returns QuestionMessage

AbstracttoStorage

Returns PersistedQuestion

Settings

On This Page

Class Question`Abstract`

`Protected`constructor

`Readonly`song

`Protected`baseToStorage

`Abstract`getQuestionMessage

`Abstract`toStorage