SetGameScore
extends TelegramMethod
in package
Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
Source: https://core.telegram.org/bots/api#setgamescore
Tags
Table of Contents
Constants
- ApiMethod : string = 'setGameScore'
- ReturnsType : string = 'union:Message|bool'
- Subclasses override with either: - a `class-string<TelegramObject>` (e.g. Message::class) for object returns - a scalar type name ('bool', 'int', 'string') for primitive returns - 'list:<inner>' for array returns
Properties
- $bot : Bot|null
- $chatId : int|null
- $disableEditMessage : bool|null
- $force : bool|null
- $inlineMessageId : string|null
- $messageId : int|null
- $score : int
- $userId : int
Methods
- __construct() : mixed
- as_() : static
- Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).
- bindBot() : static
- Returns a clone bound to $bot. Used by hand-authored shortcut methods (Message::answer, etc.) so the chained ->emit() picks up the bot without an explicit argument.
- emit() : TReturn
- Emit this method via the bound bot (or the explicitly-passed bot).
- withBot() : static
- Returns a clone of $this with $bot rebound recursively. Walks every public property; nested `BotContextController` instances are rebound via their own `withBot`, arrays (including nested arrays of arbitrary depth — e.g.
Constants
ApiMethod
public
string
ApiMethod
= 'setGameScore'
ReturnsType
Subclasses override with either: - a `class-string<TelegramObject>` (e.g. Message::class) for object returns - a scalar type name ('bool', 'int', 'string') for primitive returns - 'list:<inner>' for array returns
public
string
ReturnsType
= 'union:Message|bool'
Stays '' on the abstract base — Phase 2 codegen sets it per concrete method.
Properties
$bot read-only
public
Bot|null
$bot
= null
$chatId read-only
public
int|null
$chatId
= null
$disableEditMessage read-only
public
bool|null
$disableEditMessage
= null
$force read-only
public
bool|null
$force
= null
$inlineMessageId read-only
public
string|null
$inlineMessageId
= null
$messageId read-only
public
int|null
$messageId
= null
$score read-only
public
int
$score
$userId read-only
public
int
$userId
Methods
__construct()
public
__construct(int $userId, int $score[, bool|null $force = null ][, bool|null $disableEditMessage = null ][, int|null $chatId = null ][, int|null $messageId = null ][, string|null $inlineMessageId = null ][, Bot|null $bot = null ]) : mixed
Parameters
- $userId : int
- $score : int
- $force : bool|null = null
- $disableEditMessage : bool|null = null
- $chatId : int|null = null
- $messageId : int|null = null
- $inlineMessageId : string|null = null
- $bot : Bot|null = null
as_()
Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).
public
as_(Bot|null $bot) : static
IMPORTANT: behaves DIFFERENTLY from upstream — upstream mutates self.bot in place and returns self. The PHP port can't mutate readonly, so this returns a clone. Callers must reassign: $msg = $msg->as($bot).
Parameters
- $bot : Bot|null
Return values
staticbindBot()
Returns a clone bound to $bot. Used by hand-authored shortcut methods (Message::answer, etc.) so the chained ->emit() picks up the bot without an explicit argument.
public
bindBot(Bot|null $bot) : static
Parameters
- $bot : Bot|null
Return values
staticemit()
Emit this method via the bound bot (or the explicitly-passed bot).
public
emit([Bot|null $bot = null ]) : TReturn
Mirrors upstream methods/base.py:81-93 (await + emit).
Parameters
- $bot : Bot|null = null
Return values
TReturnwithBot()
Returns a clone of $this with $bot rebound recursively. Walks every public property; nested `BotContextController` instances are rebound via their own `withBot`, arrays (including nested arrays of arbitrary depth — e.g.
public
withBot(Bot|null $bot) : static
list<list<KeyboardButton>>) are walked element-wise. Plain values
(scalars, DateTime, enums, InputFile etc.) pass through untouched.
Mirrors upstream pydantic model_validate(context={"bot": bot}) (aiogram
ContextController.as_/model_dump_json+model_validate).
Scope note: PHP 8.5 treats public readonly as effectively
public protected(set) readonly for clone-with — only code running with
a scope in the property's declaring class hierarchy (declaring class plus
its ancestors and descendants) can use clone($obj, ['x' => ...]) against
it. Because this method lives on BotContextController and every
TelegramObject/TelegramMethod subclass extends it, the walker's
clone($this, [...]) call legally rewrites subclass-declared readonly
slots like Message::$chat. External callers cannot use the same syntax
— they must funnel through this method.
Parameters
- $bot : Bot|null