tgbot-cpp
Loading...
Searching...
No Matches
TgBot::SetGameScoreArgs Struct Reference

Arguments for Api::setGameScore. More...

#include <Types.h>

Public Attributes

std::int64_t userId { }
 User identifier.
std::int32_t score { }
 New score, must be non-negative.
bool force = false
 Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters.
bool disableEditMessage = false
 Pass True if the game message should not be automatically edited to include the current scoreboard.
std::variant< std::int64_t, std::string > chatId = { }
 Required if inline_message_id is not specified. Unique identifier for the target chat.
std::int32_t messageId = 0
 Required if inline_message_id is not specified. Identifier of the sent message.
std::string inlineMessageId = ""
 Required if chat_id and message_id are not specified. Identifier of the inline message.

Detailed Description

Arguments for Api::setGameScore.

Definition at line 20567 of file Types.h.

Member Data Documentation

◆ chatId

std::variant<std::int64_t, std::string> TgBot::SetGameScoreArgs::chatId = { }

Required if inline_message_id is not specified. Unique identifier for the target chat.

Definition at line 20594 of file Types.h.

◆ disableEditMessage

bool TgBot::SetGameScoreArgs::disableEditMessage = false

Pass True if the game message should not be automatically edited to include the current scoreboard.

Definition at line 20588 of file Types.h.

◆ force

bool TgBot::SetGameScoreArgs::force = false

Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters.

Definition at line 20582 of file Types.h.

◆ inlineMessageId

std::string TgBot::SetGameScoreArgs::inlineMessageId = ""

Required if chat_id and message_id are not specified. Identifier of the inline message.

Definition at line 20606 of file Types.h.

◆ messageId

std::int32_t TgBot::SetGameScoreArgs::messageId = 0

Required if inline_message_id is not specified. Identifier of the sent message.

Definition at line 20600 of file Types.h.

◆ score

std::int32_t TgBot::SetGameScoreArgs::score { }

New score, must be non-negative.

Definition at line 20576 of file Types.h.

◆ userId

std::int64_t TgBot::SetGameScoreArgs::userId { }

User identifier.

Definition at line 20571 of file Types.h.


The documentation for this struct was generated from the following file: