OpenTTD

script_storage.hpp
Go to the documentation of this file.
1 /* $Id: script_storage.hpp 26057 2013-11-23 13:12:19Z rubidium $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #ifndef SCRIPT_STORAGE_HPP
13 #define SCRIPT_STORAGE_HPP
14
15 #include "../signs_func.h"
16 #include "../vehicle_func.h"
17 #include "../road_type.h"
18 #include "../group.h"
19 #include "../goal_type.h"
20 #include "../story_type.h"
21
22 #include "table/strings.h"
23 #include <vector>
24
28 typedef bool (ScriptModeProc)();
29
33 class ScriptStorage {
34 friend class ScriptObject;
35 private:
36 ScriptModeProc *mode;
37 class ScriptObject *mode_instance;
38 CompanyID root_company;
39 CompanyID company;
40
41 uint delay;
42 bool allow_do_command;
43
44 CommandCost costs;
45 Money last_cost;
46 uint last_error;
47 bool last_command_res;
48
49 VehicleID new_vehicle_id;
50 SignID new_sign_id;
51 GroupID new_group_id;
52 GoalID new_goal_id;
53 StoryPageID new_story_page_id;
54 StoryPageID new_story_page_element_id;
55
56 std::vector<int> callback_value;
57
58 RoadType road_type;
59 RailType rail_type;
60
61 void *event_data;
62 void *log_data;
63
64 public:
65 ScriptStorage() :
66 mode (NULL),
67 mode_instance (NULL),
68 root_company (INVALID_OWNER),
69 company (INVALID_OWNER),
70 delay (1),
71 allow_do_command (true),
72 /* costs (can't be set) */
73 last_cost (0),
74 last_error (STR_NULL),
75 last_command_res (true),
76 new_vehicle_id (0),
77 new_sign_id (0),
78 new_group_id (0),
79 new_goal_id (0),
80 new_story_page_id (0),
81 new_story_page_element_id(0),
82 /* calback_value (can't be set) */
83 road_type (INVALID_ROADTYPE),
84 rail_type (INVALID_RAILTYPE),
85 event_data (NULL),
86 log_data (NULL)
87 { }
88
89 ~ScriptStorage();
90 };
91
92 #endif /* SCRIPT_STORAGE_HPP */
ScriptStorage::event_data
void * event_data
Pointer to the event data storage.
Definition: script_storage.hpp:61
ScriptStorage::mode
ScriptModeProc * mode
The current build mode we are int.
Definition: script_storage.hpp:36
RailType
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:29
ScriptStorage::new_vehicle_id
VehicleID new_vehicle_id
The ID of the new Vehicle.
Definition: script_storage.hpp:49
GoalID
uint16 GoalID
ID of a goal.
Definition: goal_type.h:34
INVALID_ROADTYPE
flag for invalid roadtype
Definition: road_type.h:27
ScriptModeProc
bool() ScriptModeProc()
The callback function for Mode-classes.
Definition: script_storage.hpp:28
ScriptStorage::new_group_id
GroupID new_group_id
The ID of the new Group.
Definition: script_storage.hpp:51
CommandCost
Common return value for all commands.
Definition: command_type.h:25
RoadType
RoadType
The different roadtypes we support.
Definition: road_type.h:22
ScriptStorage::new_goal_id
GoalID new_goal_id
The ID of the new Goal.
Definition: script_storage.hpp:52
ScriptStorage::root_company
CompanyID root_company
The root company, the company that the script really belongs to.
Definition: script_storage.hpp:38
ScriptStorage::allow_do_command
bool allow_do_command
Is the usage of DoCommands restricted?
Definition: script_storage.hpp:42
ScriptStorage::last_command_res
bool last_command_res
The last result of the command.
Definition: script_storage.hpp:47
VehicleID
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:18
ScriptStorage::rail_type
RailType rail_type
The current railtype we build.
Definition: script_storage.hpp:59
ScriptStorage::costs
CommandCost costs
The costs the script is tracking.
Definition: script_storage.hpp:44
ScriptStorage::company
CompanyID company
The current company.
Definition: script_storage.hpp:39
ScriptStorage::delay
uint delay
The ticks of delay each DoCommand has.
Definition: script_storage.hpp:41
ScriptStorage::callback_value
std::vector< int > callback_value
The values which need to survive a callback.
Definition: script_storage.hpp:56
GroupID
uint16 GroupID
Type for all group identifiers.
Definition: group_type.h:15
ScriptStorage::new_story_page_id
StoryPageID new_story_page_id
The ID of the new StoryPage.
Definition: script_storage.hpp:53
ScriptStorage::mode_instance
class ScriptObject * mode_instance
The instance belonging to the current build mode.
Definition: script_storage.hpp:37
ScriptStorage::log_data
void * log_data
Pointer to the log data storage.
Definition: script_storage.hpp:62
ScriptStorage::road_type
RoadType road_type
The current roadtype we build.
Definition: script_storage.hpp:58
ScriptStorage::new_story_page_element_id
StoryPageID new_story_page_element_id
The ID of the new StoryPageElement.
Definition: script_storage.hpp:54
ScriptStorage::last_error
uint last_error
The last error of the command.
Definition: script_storage.hpp:46
ScriptStorage::last_cost
Money last_cost
The last cost of the command.
Definition: script_storage.hpp:45
SignID
uint16 SignID
The type of the IDs of signs.
Definition: signs_type.h:16
ScriptStorage::new_sign_id
SignID new_sign_id
The ID of the new Sign.
Definition: script_storage.hpp:50
INVALID_RAILTYPE
Flag for invalid railtype.
Definition: rail_type.h:36
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:20
ScriptStorage
The storage for each script.
Definition: script_storage.hpp:33
StoryPageID
uint16 StoryPageID
ID of a story page.
Definition: story_type.h:18
OverflowSafeInt< int64, INT64_MAX, INT64_MIN >
INVALID_OWNER
An invalid owner.
Definition: company_type.h:31