ShyyTAUI/src/lib/taDocs/3-client-setTournamentShowQualifierButton.md

1.7 KiB

The taClient.setTournamentShowQualifierButton() method

This documents the taClient.setTournamentShowQualifierButton() method.

info
Async: This is a method you would want to use await with

This method has input parameters. The function could easily be defined as:

async function setTournamentShowQualifierButton(tournamentId: string, show: boolean): Promise<Response> {
    // backend logic
}

Parameters:

  • tournamentId (string): The GUID of the tournament
  • show (boolean): Whether to show the qualifier button in the tournament menu

General usage:

const response: Response = taClient.setTournamentShowQualifierButton(tournamentGuid, true);

If you have not yet, please read Client -> Introduction to the Client

Standard Response:

{
    details: {
        setTournamentShowQualifierButton: Response_SetTournamentShowQualifierButton,
        oneofKind: 'setTournamentShowQualifierButton'
    },
    respondingToPacketId: 'packet-guid-uuidv4',
    type: Response_ResponseType
}
info
Note: When enabled, players will see a qualifier button in the tournament menu within the game. When disabled, the qualifier button is hidden.