blob: 7400e7247c38410a95a204556e0409123462bd00 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/*
* This file is part of OpenTTD.
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file script_client.hpp Everything to query a network client's information */
#ifndef SCRIPT_CLIENT_HPP
#define SCRIPT_CLIENT_HPP
#include "script_text.hpp"
#include "script_date.hpp"
#include "script_company.hpp"
#include "../../network/network_type.h"
/**
* Class that handles all client related functions.
*
* @api game
*/
class ScriptClient : public ScriptObject {
public:
/** Different constants related to ClientID. */
enum ClientID : uint32 {
CLIENT_INVALID = 0, ///< Client is not part of anything
CLIENT_SERVER = 1, ///< Servers always have this ID
CLIENT_FIRST = 2, ///< The first client ID
};
/**
* Resolves the given client id to the correct index for the client.
* If the client with the given id does not exist it will
* return CLIENT_INVALID.
* @param client The client id to resolve.
* @return The resolved client id.
*/
static ClientID ResolveClientID(ClientID client);
/**
* Get the name of the given client.
* @param client The client to get the name for.
* @pre ResolveClientID(client) != CLIENT_INVALID.
* @return The name of the given client.
*/
static char *GetName(ClientID client);
/**
* Get the company in which the given client is playing.
* @param client The client to get company for.
* @pre ResolveClientID(client) != CLIENT_INVALID.
* @return The company in which client is playing or COMPANY_SPECTATOR.
*/
static ScriptCompany::CompanyID GetCompany(ClientID client);
/**
* Get the game date when the given client has joined.
* @param client The client to get joining date for.
* @pre ResolveClientID(client) != CLIENT_INVALID.
* @return The date when client has joined.
*/
static ScriptDate::Date GetJoinDate(ClientID client);
};
#endif /* SCRIPT_CLIENT_HPP */
|
