OpenTTD Source: src/script/script_storage.hpp Source File

OpenTTD Source 15.0-beta1

script_storage.hpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10#ifndef SCRIPT_STORAGE_HPP
11#define SCRIPT_STORAGE_HPP
12
13#include "../signs_func.h"
14#include "../vehicle_func.h"
15#include "../road_type.h"
16#include "../group.h"
17#include "../goal_type.h"
18#include "../story_type.h"
19
20#include "script_log_types.hpp"
21
22#include "table/strings.h"
23
27 typedef bool (ScriptModeProc)();
28
32 typedef bool (ScriptAsyncModeProc)();
33
37 class ScriptStorage {
38friend class ScriptObject;
39private:
40 ScriptModeProc *mode;
41 class ScriptObject *mode_instance;
42 ScriptAsyncModeProc *async_mode;
43 class ScriptObject *async_mode_instance;
44 CompanyID root_company;
45 CompanyID company;
46
47 uint delay;
48 bool allow_do_command;
49
50 CommandCost costs;
51 Money last_cost;
52 uint last_error;
53 bool last_command_res;
54
55 CommandDataBuffer last_data;
56 Commands last_cmd;
57 CommandDataBuffer last_cmd_ret;
58
59 std::vector<int> callback_value;
60
61 RoadType road_type;
62 RailType rail_type;
63
64 void *event_data;
65 ScriptLogTypes::LogData log_data;
66
67public:
68 ScriptStorage() :
69 mode (nullptr),
70 mode_instance (nullptr),
71 async_mode (nullptr),
72 async_mode_instance (nullptr),
73 root_company (INVALID_OWNER),
74 company (INVALID_OWNER),
75 delay (1),
76 allow_do_command (true),
77 /* costs (can't be set) */
78 last_cost (0),
79 last_error (STR_NULL),
80 last_command_res (true),
81 last_cmd (CMD_END),
82 /* calback_value (can't be set) */
83 road_type (INVALID_ROADTYPE),
84 rail_type (INVALID_RAILTYPE),
85 event_data (nullptr)
86 { }
87
88 ~ScriptStorage();
89};
90
91#endif /* SCRIPT_STORAGE_HPP */
CommandCost
Common return value for all commands.
Definition command_type.h:23
OverflowSafeInt< int64_t >
ScriptStorage
The storage for each script.
Definition script_storage.hpp:37
ScriptStorage::log_data
ScriptLogTypes::LogData log_data
Log data storage.
Definition script_storage.hpp:65
ScriptStorage::last_cmd_ret
CommandDataBuffer last_cmd_ret
The extra data returned by the last command.
Definition script_storage.hpp:57
ScriptStorage::event_data
void * event_data
Pointer to the event data storage.
Definition script_storage.hpp:64
ScriptStorage::rail_type
RailType rail_type
The current railtype we build.
Definition script_storage.hpp:62
ScriptStorage::root_company
CompanyID root_company
The root company, the company that the script really belongs to.
Definition script_storage.hpp:44
ScriptStorage::delay
uint delay
The ticks of delay each DoCommand has.
Definition script_storage.hpp:47
ScriptStorage::async_mode_instance
class ScriptObject * async_mode_instance
The instance belonging to the current command async mode.
Definition script_storage.hpp:43
ScriptStorage::last_data
CommandDataBuffer last_data
The last data passed to a command.
Definition script_storage.hpp:55
ScriptStorage::callback_value
std::vector< int > callback_value
The values which need to survive a callback.
Definition script_storage.hpp:59
ScriptStorage::last_cost
Money last_cost
The last cost of the command.
Definition script_storage.hpp:51
ScriptStorage::allow_do_command
bool allow_do_command
Is the usage of DoCommands restricted?
Definition script_storage.hpp:48
ScriptStorage::async_mode
ScriptAsyncModeProc * async_mode
The current command async mode we are in.
Definition script_storage.hpp:42
ScriptStorage::mode_instance
class ScriptObject * mode_instance
The instance belonging to the current build mode.
Definition script_storage.hpp:41
ScriptStorage::road_type
RoadType road_type
The current roadtype we build.
Definition script_storage.hpp:61
ScriptStorage::costs
CommandCost costs
The costs the script is tracking.
Definition script_storage.hpp:50
ScriptStorage::mode
ScriptModeProc * mode
The current build mode we are int.
Definition script_storage.hpp:40
ScriptStorage::last_command_res
bool last_command_res
The last result of the command.
Definition script_storage.hpp:53
ScriptStorage::last_cmd
Commands last_cmd
The last cmd passed to a command.
Definition script_storage.hpp:56
ScriptStorage::company
CompanyID company
The current company.
Definition script_storage.hpp:45
ScriptStorage::last_error
uint last_error
The last error of the command.
Definition script_storage.hpp:52
CommandDataBuffer
std::vector< uint8_t > CommandDataBuffer
Storage buffer for serialized command data.
Definition command_type.h:470
Commands
Commands
List of commands.
Definition command_type.h:187
CMD_END
@ CMD_END
Must ALWAYS be on the end of this list!! (period)
Definition command_type.h:366
Owner
Owner
Enum for all companies/owners.
Definition company_type.h:18
INVALID_OWNER
@ INVALID_OWNER
An invalid owner.
Definition company_type.h:29
RailType
RailType
Enumeration for all possible railtypes.
Definition rail_type.h:27
INVALID_RAILTYPE
@ INVALID_RAILTYPE
Flag for invalid railtype.
Definition rail_type.h:34
RoadType
RoadType
The different roadtypes we support.
Definition road_type.h:25
INVALID_ROADTYPE
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition road_type.h:30
ScriptAsyncModeProc
bool() ScriptAsyncModeProc()
The callback function for Async Mode-classes.
Definition script_storage.hpp:32
ScriptModeProc
bool() ScriptModeProc()
The callback function for Mode-classes.
Definition script_storage.hpp:27