MadelineProtoDocs/docs/API_docs/methods/messages.setGameScore.md

61 lines
2.2 KiB
Markdown
Raw Normal View History

2019-06-24 15:45:02 +02:00
---
title: messages.setGameScore
2019-12-27 17:48:04 +01:00
description: Use this method to set the score of the specified user in a game sent as a normal message (bots only).
2019-06-24 15:45:02 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/messages_setGameScore.html
2019-06-24 15:45:02 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: messages.setGameScore
2019-06-24 15:45:02 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
2019-12-27 17:48:04 +01:00
Use this method to set the score of the specified user in a game sent as a normal message (bots only).
2019-06-24 15:45:02 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|edit\_message|[Bool](../types/Bool.md) | Set this flag if the game message should be automatically edited to include the current scoreboard | Optional|
|force|[Bool](../types/Bool.md) | Set this flag if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters | Optional|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Unique identifier of target chat | Optional|
|id|[int](../types/int.md) | Identifier of the sent message | Yes|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User identifier | Optional|
|score|[int](../types/int.md) | New score | Yes|
2019-06-24 15:45:02 +02:00
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **YES**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$Updates = $MadelineProto->messages->setGameScore(['edit_message' => Bool, 'force' => Bool, 'peer' => InputPeer, 'id' => int, 'user_id' => InputUser, 'score' => int, ]);
```
Or, if you're into Lua:
```lua
Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, })
```
2019-09-02 17:41:28 +02:00
### Errors
2019-06-24 15:45:02 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|MESSAGE_ID_INVALID|The provided message id is invalid|
|400|PEER_ID_INVALID|The provided peer id is invalid|
|400|USER_BOT_REQUIRED|This method can only be called by a bot|
2019-06-24 15:45:02 +02:00