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 
34 friend class ScriptObject;
35 private:
37  class ScriptObject *mode_instance;
40 
41  uint delay;
43 
46  uint last_error;
48 
55 
56  std::vector<int> callback_value;
57 
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 */
void * event_data
Pointer to the event data storage.
ScriptModeProc * mode
The current build mode we are int.
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:29
VehicleID new_vehicle_id
The ID of the new Vehicle.
uint16 GoalID
ID of a goal.
Definition: goal_type.h:34
flag for invalid roadtype
Definition: road_type.h:27
bool() ScriptModeProc()
The callback function for Mode-classes.
GroupID new_group_id
The ID of the new Group.
Common return value for all commands.
Definition: command_type.h:25
RoadType
The different roadtypes we support.
Definition: road_type.h:22
GoalID new_goal_id
The ID of the new Goal.
CompanyID root_company
The root company, the company that the script really belongs to.
bool allow_do_command
Is the usage of DoCommands restricted?
bool last_command_res
The last result of the command.
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:18
RailType rail_type
The current railtype we build.
CommandCost costs
The costs the script is tracking.
CompanyID company
The current company.
uint delay
The ticks of delay each DoCommand has.
std::vector< int > callback_value
The values which need to survive a callback.
uint16 GroupID
Type for all group identifiers.
Definition: group_type.h:15
StoryPageID new_story_page_id
The ID of the new StoryPage.
class ScriptObject * mode_instance
The instance belonging to the current build mode.
void * log_data
Pointer to the log data storage.
RoadType road_type
The current roadtype we build.
StoryPageID new_story_page_element_id
The ID of the new StoryPageElement.
uint last_error
The last error of the command.
Money last_cost
The last cost of the command.
uint16 SignID
The type of the IDs of signs.
Definition: signs_type.h:16
SignID new_sign_id
The ID of the new Sign.
Flag for invalid railtype.
Definition: rail_type.h:36
Owner
Enum for all companies/owners.
Definition: company_type.h:20
The storage for each script.
uint16 StoryPageID
ID of a story page.
Definition: story_type.h:18
An invalid owner.
Definition: company_type.h:31