ScriptStorage Class Reference

The storage for each script. More...

#include <script_storage.hpp>

Private Attributes
ScriptModeProc *	mode = nullptr
	The current build mode we are int.
class ScriptObject *	mode_instance = nullptr
	The instance belonging to the current build mode.
ScriptAsyncModeProc *	async_mode = nullptr
	The current command async mode we are in.
class ScriptObject *	async_mode_instance = nullptr
	The instance belonging to the current command async mode.
CompanyID	root_company = INVALID_OWNER
	The root company, the company that the script really belongs to.
CompanyID	company = INVALID_OWNER
	The current company.
uint	delay = 1
	The ticks of delay each DoCommand has.
bool	allow_do_command = true
	Is the usage of DoCommands restricted?
CommandCost	costs
	The costs the script is tracking.
Money	last_cost = 0
	The last cost of the command.
ScriptErrorType	last_error {}
	The last error of the command.
bool	last_command_res = true
	The last result of the command.
CommandDataBuffer	last_data
	The last data passed to a command.
Commands	last_cmd = CMD_END
	The last cmd passed to a command.
CommandDataBuffer	last_cmd_ret
	The extra data returned by the last command.
std::vector< int >	callback_value
	The values which need to survive a callback.
RoadType	road_type = INVALID_ROADTYPE
	The current roadtype we build.
RailType	rail_type = INVALID_RAILTYPE
	The current railtype we build.
ScriptEventQueue	event_queue
	Event queue for this script.
ScriptLogTypes::LogData	log_data
	Log data storage.

Friends
class	ScriptObject

Detailed Description

The storage for each script.

It keeps track of important information.

Definition at line 45 of file script_storage.hpp.

Friends And Related Symbol Documentation

ScriptObject

friend class ScriptObject

friend

Definition at line 46 of file script_storage.hpp.

Field Documentation

allow_do_command

bool ScriptStorage::allow_do_command = true

private

Is the usage of DoCommands restricted?

Definition at line 56 of file script_storage.hpp.

async_mode

ScriptAsyncModeProc* ScriptStorage::async_mode = nullptr

private

The current command async mode we are in.

Definition at line 50 of file script_storage.hpp.

async_mode_instance

class ScriptObject* ScriptStorage::async_mode_instance = nullptr

private

The instance belonging to the current command async mode.

Definition at line 51 of file script_storage.hpp.

callback_value

std::vector<int> ScriptStorage::callback_value

private

The values which need to survive a callback.

Definition at line 67 of file script_storage.hpp.

company

CompanyID ScriptStorage::company = INVALID_OWNER

private

The current company.

Definition at line 53 of file script_storage.hpp.

costs

CommandCost ScriptStorage::costs

private

The costs the script is tracking.

Definition at line 58 of file script_storage.hpp.

delay

uint ScriptStorage::delay = 1

private

The ticks of delay each DoCommand has.

Definition at line 55 of file script_storage.hpp.

event_queue

ScriptEventQueue ScriptStorage::event_queue

private

Event queue for this script.

Definition at line 72 of file script_storage.hpp.

last_cmd

Commands ScriptStorage::last_cmd = CMD_END

private

The last cmd passed to a command.

Definition at line 64 of file script_storage.hpp.

last_cmd_ret

CommandDataBuffer ScriptStorage::last_cmd_ret

private

The extra data returned by the last command.

Definition at line 65 of file script_storage.hpp.

last_command_res

bool ScriptStorage::last_command_res = true

private

The last result of the command.

Definition at line 61 of file script_storage.hpp.

last_cost

Money ScriptStorage::last_cost = 0

private

The last cost of the command.

Definition at line 59 of file script_storage.hpp.

last_data

CommandDataBuffer ScriptStorage::last_data

private

The last data passed to a command.

Definition at line 63 of file script_storage.hpp.

last_error

ScriptErrorType ScriptStorage::last_error {}

private

The last error of the command.

Definition at line 60 of file script_storage.hpp.

log_data

ScriptLogTypes::LogData ScriptStorage::log_data

private

Log data storage.

Definition at line 73 of file script_storage.hpp.

mode

ScriptModeProc* ScriptStorage::mode = nullptr

private

The current build mode we are int.

Definition at line 48 of file script_storage.hpp.

mode_instance

class ScriptObject* ScriptStorage::mode_instance = nullptr

private

The instance belonging to the current build mode.

Definition at line 49 of file script_storage.hpp.

rail_type

RailType ScriptStorage::rail_type = INVALID_RAILTYPE

private

The current railtype we build.

Definition at line 70 of file script_storage.hpp.

road_type

RoadType ScriptStorage::road_type = INVALID_ROADTYPE

private

The current roadtype we build.

Definition at line 69 of file script_storage.hpp.

root_company

CompanyID ScriptStorage::root_company = INVALID_OWNER

private

The root company, the company that the script really belongs to.

Definition at line 52 of file script_storage.hpp.

---

The documentation for this class was generated from the following files:

• src/script/script_storage.hpp
• src/script/script_instance.cpp