Runtime information about a game script like a pointer to the squirrel vm and the current state. More...

#include <game_instance.hpp>

Inheritance diagram for GameInstance:

Public Member Functions
void	Initialize (class GameInfo *info)
	Initialize the script and prepare it for its first run.

int	GetSetting (const std::string &name) override
	Get the value of a setting of the current instance.

ScriptInfo *	FindLibrary (const std::string &library, int version) override
	Find a library.

Public Member Functions inherited from ScriptInstance
	ScriptInstance (const char *APIName)
	Create a new script.

void	Initialize (const std::string &main_script, const std::string &instance_name, CompanyID company)
	Initialize the script and prepare it for its first run.

void	Continue ()
	A script in multiplayer waits for the server to handle its DoCommand.

void	GameLoop ()
	Run the GameLoop of a script.

void	CollectGarbage ()
	Let the VM collect any garbage.

class ScriptStorage *	GetStorage ()
	Get the storage of this script.

ScriptLogTypes::LogData &	GetLogData ()
	Get the log pointer of this script.

class ScriptController *	GetController ()
	Get the controller attached to the instance.

bool	IsDead () const
	Return the "this script died" value.

bool	IsAlive () const
	Return whether the script is alive.

void	Save ()
	Call the script Save function and save all data in the savegame.

void	LoadOnStack (ScriptData *data)
	Store loaded data on the stack.

void	Pause ()
	Suspends the script for the current tick and then pause the execution of script.

bool	IsPaused ()
	Checks if the script is paused.

void	Unpause ()
	Resume execution of the script.

SQInteger	GetOpsTillSuspend ()
	Get the number of operations the script can execute before being suspended.

bool	DoCommandCallback (const CommandCost &result, const CommandDataBuffer &data, CommandDataBuffer result_data, Commands cmd)
	DoCommand callback function for all commands executed by scripts.

void	InsertEvent (class ScriptEvent *event)
	Insert an event for this script.

bool	IsSleeping ()
	Check if the instance is sleeping, which either happened because the script executed a DoCommand, executed this.Sleep() or it has been paused.

size_t	GetAllocatedMemory () const

bool	InShutdown () const
	Indicate whether this instance is currently being destroyed.

void	ReleaseSQObject (HSQOBJECT *obj)
	Decrease the ref count of a squirrel object.

Private Member Functions
void	RegisterAPI () override
	Register all API functions to the VM.

void	Died () override
	Tell the script it died.

CommandCallbackData *	GetDoCommandCallback () override
	Get the callback handling DoCommands in case of networking.

void	LoadDummyScript () override
	Load the dummy script.

Additional Inherited Members
Public Types inherited from ScriptInstance
typedef std::variant< SQInteger, std::string, SQBool, SQSaveLoadType >	ScriptDataVariant

typedef std::list< ScriptDataVariant >	ScriptData

Static Public Member Functions inherited from ScriptInstance
static void	DoCommandReturn (ScriptInstance *instance)
	Return a true/false reply for a DoCommand.

static void	DoCommandReturnVehicleID (ScriptInstance *instance)
	Return a VehicleID reply for a DoCommand.

static void	DoCommandReturnSignID (ScriptInstance *instance)
	Return a SignID reply for a DoCommand.

static void	DoCommandReturnGroupID (ScriptInstance *instance)
	Return a GroupID reply for a DoCommand.

static void	DoCommandReturnGoalID (ScriptInstance *instance)
	Return a GoalID reply for a DoCommand.

static void	DoCommandReturnStoryPageID (ScriptInstance *instance)
	Return a StoryPageID reply for a DoCommand.

static void	DoCommandReturnStoryPageElementID (ScriptInstance *instance)
	Return a StoryPageElementID reply for a DoCommand.

static void	DoCommandReturnLeagueTableID (ScriptInstance *instance)
	Return a LeagueTableID reply for a DoCommand.

static void	DoCommandReturnLeagueTableElementID (ScriptInstance *instance)
	Return a LeagueTableElementID reply for a DoCommand.

static void	SaveEmpty ()
	Don't save any data in the savegame.

static ScriptData *	Load (int version)
	Load data from a savegame.

static void	LoadEmpty ()
	Load and discard data from a savegame.

Protected Member Functions inherited from ScriptInstance
bool	LoadCompatibilityScripts (const std::string &api_version, Subdirectory dir)
	Load squirrel scripts to emulate an older API.

Protected Attributes inherited from ScriptInstance
class Squirrel *	engine
	A wrapper around the squirrel vm.

std::string	versionAPI
	Current API used by this script.

Detailed Description

Runtime information about a game script like a pointer to the squirrel vm and the current state.

Definition at line 16 of file game_instance.hpp.

Constructor & Destructor Documentation

◆ GameInstance()

GameInstance::GameInstance ( )

Definition at line 30 of file game_instance.cpp.

Member Function Documentation

◆ Died()

void GameInstance::Died ( )

overrideprivatevirtual

Tell the script it died.

Reimplemented from ScriptInstance.

Definition at line 66 of file game_instance.cpp.

References _switch_mode, ScriptInstance::Died(), Game::GetInfo(), ScriptInfo::GetURL(), INVALID_STRING_ID, OWNER_DEITY, ShowErrorMessage(), ShowScriptDebugWindow(), and WL_WARNING.

Referenced by RegisterAPI().

◆ FindLibrary()

ScriptInfo * GameInstance::FindLibrary	(	const std::string &	library,
		int	version
	)

overridevirtual

Find a library.

Parameters

library	The library name to find.
version	The version the library should have.

Returns: The library if found, nullptr otherwise.

Implements ScriptInstance.

Definition at line 61 of file game_instance.cpp.

References Game::FindLibrary().

◆ GetDoCommandCallback()

CommandCallbackData * GameInstance::GetDoCommandCallback ( )

overrideprivatevirtual

Get the callback handling DoCommands in case of networking.

Implements ScriptInstance.

Definition at line 100 of file game_instance.cpp.

◆ GetSetting()

int GameInstance::GetSetting ( const std::string & name )

overridevirtual

Get the value of a setting of the current instance.

Parameters

name	The name of the setting.

Returns: the value for the setting, or -1 if the setting is not known.

Implements ScriptInstance.

Definition at line 56 of file game_instance.cpp.

References GameConfig::GetConfig(), and ScriptConfig::GetSetting().

◆ Initialize()

void GameInstance::Initialize ( class GameInfo * info )

Initialize the script and prepare it for its first run.

Parameters

info	The GameInfo to start.

Definition at line 34 of file game_instance.cpp.

References ScriptInstance::engine, GameInfo::GetAPIVersion(), ScriptInfo::GetInstanceName(), ScriptInfo::GetMainScript(), ScriptInstance::Initialize(), OWNER_DEITY, and ScriptInstance::versionAPI.

Referenced by Game::StartNew().

◆ LoadDummyScript()

void GameInstance::LoadDummyScript ( )

inlineoverrideprivatevirtual

Load the dummy script.

Implements ScriptInstance.

Definition at line 33 of file game_instance.hpp.

◆ RegisterAPI()

void GameInstance::RegisterAPI ( )

overrideprivatevirtual

Register all API functions to the VM.

Reimplemented from ScriptInstance.

Definition at line 44 of file game_instance.cpp.

References Died(), ScriptInstance::engine, GAME_DIR, ScriptInstance::LoadCompatibilityScripts(), ScriptInstance::RegisterAPI(), RegisterGameTranslation(), and ScriptInstance::versionAPI.

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

src/game/game_instance.hpp
src/game/game_instance.cpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GameInstance()

Member Function Documentation

◆ Died()

◆ FindLibrary()

◆ GetDoCommandCallback()

◆ GetSetting()

◆ Initialize()

◆ LoadDummyScript()

◆ RegisterAPI()