OpenTTD Source  20241108-master-g80f628063a
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 
38 friend class ScriptObject;
39 private:
41  class ScriptObject *mode_instance;
43  class ScriptObject *async_mode_instance;
46 
47  uint delay;
49 
52  uint last_error;
54 
58 
59  std::vector<int> callback_value;
60 
63 
64  void *event_data;
65  ScriptLogTypes::LogData log_data;
66 
67 public:
68  ScriptStorage() :
69  mode (nullptr),
70  mode_instance (nullptr),
71  async_mode (nullptr),
72  async_mode_instance (nullptr),
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) */
85  event_data (nullptr)
86  { }
87 
88  ~ScriptStorage();
89 };
90 
91 #endif /* SCRIPT_STORAGE_HPP */
Common return value for all commands.
Definition: command_type.h:23
The storage for each script.
ScriptLogTypes::LogData log_data
Log data storage.
CommandDataBuffer last_cmd_ret
The extra data returned by the last command.
void * event_data
Pointer to the event data storage.
RailType rail_type
The current railtype we build.
CompanyID root_company
The root company, the company that the script really belongs to.
uint delay
The ticks of delay each DoCommand has.
class ScriptObject * async_mode_instance
The instance belonging to the current command async mode.
CommandDataBuffer last_data
The last data passed to a command.
std::vector< int > callback_value
The values which need to survive a callback.
Money last_cost
The last cost of the command.
bool allow_do_command
Is the usage of DoCommands restricted?
ScriptAsyncModeProc * async_mode
The current command async mode we are in.
class ScriptObject * mode_instance
The instance belonging to the current build mode.
RoadType road_type
The current roadtype we build.
CommandCost costs
The costs the script is tracking.
ScriptModeProc * mode
The current build mode we are int.
bool last_command_res
The last result of the command.
Commands last_cmd
The last cmd passed to a command.
CompanyID company
The current company.
uint last_error
The last error of the command.
std::vector< uint8_t > CommandDataBuffer
Storage buffer for serialized command data.
Definition: command_type.h:470
Commands
List of commands.
Definition: command_type.h:187
@ CMD_END
Must ALWAYS be on the end of this list!! (period)
Definition: command_type.h:366
Owner
Enum for all companies/owners.
Definition: company_type.h:18
@ INVALID_OWNER
An invalid owner.
Definition: company_type.h:29
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:27
@ INVALID_RAILTYPE
Flag for invalid railtype.
Definition: rail_type.h:34
RoadType
The different roadtypes we support.
Definition: road_type.h:25
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition: road_type.h:30
bool() ScriptAsyncModeProc()
The callback function for Async Mode-classes.
bool() ScriptModeProc()
The callback function for Mode-classes.