Class MultipleChoiceQuestion

constructor

• new MultipleChoiceQuestion(
      song: {
          artist: string;
          audioURL: string;
          cover: string | null;
          hrefURL: string;
          name: string;
      },
      possibleDistractions:
          | {
              artist: string;
              audioURL: string;
              cover: string
              | null;
              hrefURL: string;
              name: string;
          }[]
          | null,
      distractionsPreferSameArtist: boolean | null,
  ): MultipleChoiceQuestion

  Constructs a mulitple choice 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.

  • possibleDistractions:
        | {
            artist: string;
            audioURL: string;
            cover: string
            | null;
            hrefURL: string;
            name: string;
        }[]
        | null

    all possible songs that could be used for distractions

    • {
          artist: string;
          audioURL: string;
          cover: string | null;
          hrefURL: string;
          name: string;
      }[]

      • 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.

    • null
  • distractionsPreferSameArtist: boolean | null

    whether to prefer searching for distractions by the same artist as the searched song

  Returns MultipleChoiceQuestion

answers

ReadonlydistractionsPreferSameArtist

getCorrectAnswer

• getCorrectAnswer(): number

  Returns the correct answer index.

  Returns number

getQuestionMessage

• getQuestionMessage(
      gamePhase: GamePhase,
  ): {
      answerOptions: string[];
      correctAnswerIndex?: number;
      questionType: "multiple_choice";
      startPos: number;
  }

  Returns the round message for the current phase.

  Parameters

  • gamePhase: GamePhase

    the current game phase

  Returns {
      answerOptions: string[];
      correctAnswerIndex?: number;
      questionType: "multiple_choice";
      startPos: number;
  }

  • answerOptions: string[]

    The current 4 question answer options.

  • OptionalcorrectAnswerIndex?: number

    The index of the correct answer, if answer is shown.

  • questionType: "multiple_choice"

  • startPos: number

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

    See

    RoomConfigMessageSchema.audioStartPosition

getSongNames

• getSongNames(): string[]

  Extracts song names from the questions array.

  Returns string[]

  An array of song names for the answer options.

toStorage

• toStorage(): PersistedMultipleChoiceQuestion

  Serializes this game to a PersistedGame object.

  Returns PersistedMultipleChoiceQuestion

StaticfromStorage

• fromStorage(
      persistedQuestion: PersistedMultipleChoiceQuestion,
  ): MultipleChoiceQuestion

  Parameters

  • persistedQuestion: PersistedMultipleChoiceQuestion

  Returns MultipleChoiceQuestion