src/script/api/script_object.hpp

   1 /* $Id: script_object.hpp 25342 2013-06-09 12:19:09Z zuu $ */
   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
  10 /** @file script_object.hpp Main object, on which all objects depend. */
  11
  12 #ifndef SCRIPT_OBJECT_HPP
  13 #define SCRIPT_OBJECT_HPP
  14
  15 #include "../../misc/countedptr.hpp"
  16 #include "../../road_type.h"
  17 #include "../../rail_type.h"
  18
  19 #include "script_types.hpp"
  20 #include "../script_suspend.hpp"
  21
  22 /**
  23  * The callback function for Mode-classes.
  24  */
  25 typedef bool (ScriptModeProc)();
  26
  27 /**
  28  * Uper-parent object of all API classes. You should never use this class in
  29  *   your script, as it doesn't publish any public functions. It is used
  30  *   internally to have a common place to handle general things, like internal
  31  *   command processing, and command-validation checks.
  32  * @api none
  33  */
  34 class ScriptObject : public SimpleCountedObject {
  35 friend class ScriptInstance;
  36 friend class ScriptController;
  37 protected:
  38         /**
  39          * A class that handles the current active instance. By instantiating it at
  40          *  the beginning of a function with the current active instance, it remains
  41          *  active till the scope of the variable closes. It then automatically
  42          *  reverts to the active instance it was before instantiating.
  43          */
  44         class ActiveInstance {
  45         friend class ScriptObject;
  46         public:
  47                 ActiveInstance(ScriptInstance *instance);
  48                 ~ActiveInstance();
  49         private:
  50                 ScriptInstance *last_active;    ///< The active instance before we go instantiated.
  51
  52                 static ScriptInstance *active;  ///< The global current active instance.
  53         };
  54
  55 public:
  56         /**
  57          * Store the latest result of a DoCommand per company.
  58          * @param res The result of the last command.
  59          */
  60         static void SetLastCommandRes(bool res);
  61
  62         /**
  63          * Get the currently active instance.
  64          * @return The instance.
  65          */
  66         static class ScriptInstance *GetActiveInstance();
  67
  68 protected:
  69         /**
  70          * Executes a raw DoCommand for the script.
  71          */
  72         static bool DoCommand(TileIndex tile, uint32 p1, uint32 p2, uint cmd, const char *text = nullptr, Script_SuspendCallbackProc *callback = nullptr);
  73
  74         /**
  75          * Sets the DoCommand costs counter to a value.
  76          */
  77         static void SetDoCommandCosts(Money value);
  78
  79         /**
  80          * Increase the current value of the DoCommand costs counter.
  81          */
  82         static void IncreaseDoCommandCosts(Money value);
  83
  84         /**
  85          * Get the current DoCommand costs counter.
  86          */
  87         static Money GetDoCommandCosts();
  88
  89         /**
  90          * Set the DoCommand last error.
  91          */
  92         static void SetLastError(ScriptErrorType last_error);
  93
  94         /**
  95          * Get the DoCommand last error.
  96          */
  97         static ScriptErrorType GetLastError();
  98
  99         /**
 100          * Set the road type identifier.
 101          */
 102         static void SetRoadType(RoadTypeIdentifier rtid);
 103
 104         /**
 105          * Get the road type identifier.
 106          */
 107         static RoadTypeIdentifier GetRoadType();
 108
 109         /**
 110          * Set the rail type.
 111          */
 112         static void SetRailType(RailType rail_type);
 113
 114         /**
 115          * Get the rail type.
 116          */
 117         static RailType GetRailType();
 118
 119         /**
 120          * Set the current mode of your script to this proc.
 121          */
 122         static void SetDoCommandMode(ScriptModeProc *proc, ScriptObject *instance);
 123
 124         /**
 125          * Get the current mode your script is currently under.
 126          */
 127         static ScriptModeProc *GetDoCommandMode();
 128
 129         /**
 130          * Get the instance of the current mode your script is currently under.
 131          */
 132         static ScriptObject *GetDoCommandModeInstance();
 133
 134         /**
 135          * Set the delay of the DoCommand.
 136          */
 137         static void SetDoCommandDelay(uint ticks);
 138
 139         /**
 140          * Get the delay of the DoCommand.
 141          */
 142         static uint GetDoCommandDelay();
 143
 144         /**
 145          * Get the latest result of a DoCommand.
 146          */
 147         static bool GetLastCommandRes();
 148
 149         /**
 150          * Get the latest stored new_vehicle_id.
 151          */
 152         static VehicleID GetNewVehicleID();
 153
 154         /**
 155          * Get the latest stored new_sign_id.
 156          */
 157         static SignID GetNewSignID();
 158
 159         /**
 160          * Get the latest stored new_group_id.
 161          */
 162         static GroupID GetNewGroupID();
 163
 164         /**
 165          * Get the latest stored new_goal_id.
 166          */
 167         static GoalID GetNewGoalID();
 168
 169         /**
 170          * Get the latest stored new_story_page_id.
 171          */
 172         static StoryPageID GetNewStoryPageID();
 173
 174         /**
 175          * Get the latest stored new_story_page_id.
 176          */
 177         static StoryPageID GetNewStoryPageElementID();
 178
 179         /**
 180          * Store a allow_do_command per company.
 181          * @param allow The new allow.
 182          */
 183         static void SetAllowDoCommand(bool allow);
 184
 185         /**
 186          * Get the internal value of allow_do_command. This can differ
 187          * from CanSuspend() if the reason we are not allowed
 188          * to execute a DoCommand is in squirrel and not the API.
 189          * In that case use this function to restore the previous value.
 190          * @return True iff DoCommands are allowed in the current scope.
 191          */
 192         static bool GetAllowDoCommand();
 193
 194         /**
 195          * Set the current company to execute commands for or request
 196          *  information about.
 197          * @param company The new company.
 198          */
 199         static void SetCompany(CompanyID company);
 200
 201         /**
 202          * Get the current company we are executing commands for or
 203          *  requesting information about.
 204          * @return The current company.
 205          */
 206         static CompanyID GetCompany();
 207
 208         /**
 209          * Get the root company, the company that the script really
 210          *  runs under / for.
 211          * @return The root company.
 212          */
 213         static CompanyID GetRootCompany();
 214
 215         /**
 216          * Set the cost of the last command.
 217          */
 218         static void SetLastCost(Money last_cost);
 219
 220         /**
 221          * Get the cost of the last command.
 222          */
 223         static Money GetLastCost();
 224
 225         /**
 226          * Set a variable that can be used by callback functions to pass information.
 227          */
 228         static void SetCallbackVariable(int index, int value);
 229
 230         /**
 231          * Get the variable that is used by callback functions to pass information.
 232          */
 233         static int GetCallbackVariable(int index);
 234
 235         /**
 236          * Can we suspend the script at this moment?
 237          */
 238         static bool CanSuspend();
 239
 240         /**
 241          * Get the pointer to store event data in.
 242          */
 243         static void *&GetEventPointer();
 244
 245         /**
 246          * Get the pointer to store log message in.
 247          */
 248         static void *&GetLogPointer();
 249
 250         /**
 251          * Get an allocated string with all control codes stripped off.
 252          */
 253         static char *GetString(StringID string);
 254
 255 private:
 256         /**
 257          * Store a new_vehicle_id per company.
 258          * @param vehicle_id The new VehicleID.
 259          */
 260         static void SetNewVehicleID(VehicleID vehicle_id);
 261
 262         /**
 263          * Store a new_sign_id per company.
 264          * @param sign_id The new SignID.
 265          */
 266         static void SetNewSignID(SignID sign_id);
 267
 268         /**
 269          * Store a new_group_id per company.
 270          * @param group_id The new GroupID.
 271          */
 272         static void SetNewGroupID(GroupID group_id);
 273
 274         /**
 275          * Store a new_goal_id per company.
 276          * @param goal_id The new GoalID.
 277          */
 278         static void SetNewGoalID(GoalID goal_id);
 279
 280         /**
 281          * Store a new_story_page_id per company.
 282          * @param story_page_id The new StoryPageID.
 283          */
 284         static void SetNewStoryPageID(StoryPageID story_page_id);
 285
 286         /**
 287          * Store a new_story_page_id per company.
 288          * @param story_page_id The new StoryPageID.
 289          */
 290         static void SetNewStoryPageElementID(StoryPageElementID story_page_element_id);
 291 };
 292
 293 #endif /* SCRIPT_OBJECT_HPP */