blob: 81612031dc6f76ec364885b115275c86c5f45104 (
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
|
/*
* 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_viewport.hpp Everything to manipulate the user's viewport. */
#ifndef SCRIPT_VIEWPORT_HPP
#define SCRIPT_VIEWPORT_HPP
#include "script_object.hpp"
#include "script_client.hpp"
#include "script_company.hpp"
/**
* Class that manipulates the user's viewport.
* @api game
*/
class ScriptViewport : public ScriptObject {
public:
/**
* Scroll the viewport to the given tile, where the tile will be in the
* center of the screen.
* @param tile The tile to put in the center of the screen.
* @pre ! ScriptGame::IsMultiplayer().
* @pre ScriptMap::IsValidTile(tile).
*/
static void ScrollTo(TileIndex tile);
/**
* Scroll the viewport of all players to the given tile,
* where the tile will be in the center of the screen.
* @param tile The tile to put in the center of the screen.
* @pre ScriptObject::GetCompany() == OWNER_DEITY
* @pre ScriptMap::IsValidTile(tile)
*/
static bool ScrollEveryoneTo(TileIndex tile);
/**
* Scroll the viewports of all players in the company to the given tile,
* where the tile will be in the center of the screen.
* @param company The company which players to scroll the viewport of.
* @param tile The tile to put in the center of the screen.
* @pre ScriptObject::GetCompany() == OWNER_DEITY
* @pre ScriptMap::IsValidTile(tile)
* @pre ResolveCompanyID(company) != COMPANY_INVALID
*/
static bool ScrollCompanyClientsTo(ScriptCompany::CompanyID company, TileIndex tile);
/**
* Scroll the viewport of the client to the given tile,
* where the tile will be in the center of the screen.
* @param client The client to scroll the viewport of.
* @param tile The tile to put in the center of the screen.
* @pre ScriptGame::IsMultiplayer()
* @pre ScriptObject::GetCompany() == OWNER_DEITY
* @pre ScriptMap::IsValidTile(tile)
* @pre ResolveClientID(client) != CLIENT_INVALID
*/
static bool ScrollClientTo(ScriptClient::ClientID client, TileIndex tile);
};
#endif /* SCRIPT_ADMIN_HPP */
|
