Central game state manager. More...

#include <GameContext.h>

Collaboration diagram for RoR::GameContext:

Public Member Functions
	GameContext ()

	~GameContext ()

Message queue
void	PushMessage (Message m)
	Doesn't guarantee order! Use ChainMessage() if order matters. More...

void	ChainMessage (Message m)
	Add to last pushed message's chain. More...

bool	HasMessages ()

Message	PopMessage ()

Terrain
bool	LoadTerrain (std::string const &filename_part)

void	UnloadTerrain ()

const TerrainPtr &	GetTerrain ()

Actors
ActorPtr	SpawnActor (ActorSpawnRequest &rq)

void	ModifyActor (ActorModifyRequest &rq)

void	DeleteActor (ActorPtr actor)

void	UpdateActors ()

ActorManager *	GetActorManager ()

const ActorPtr &	FetchPrevVehicleOnList ()

const ActorPtr &	FetchNextVehicleOnList ()

ActorPtr	FindActorByCollisionBox (std::string const &ev_src_instance_name, std::string const &box_name)

void	RespawnLastActor ()

void	SpawnPreselectedActor (std::string const &preset_vehicle, std::string const &preset_veh_config)
	needs `Character` to exist More...

const ActorPtr &	GetPlayerActor ()

const ActorPtr &	GetPrevPlayerActor ()

const ActorPtr &	GetActorRemotelyReceivingCommands ()

void	SetPrevPlayerActor (ActorPtr actor)

void	ChangePlayerActor (ActorPtr actor)

void	ShowLoaderGUI (int type, const Ogre::String &instance, const Ogre::String &box)

void	OnLoaderGuiCancel ()
	GUI callback. More...

void	OnLoaderGuiApply (RoR::LoaderType type, CacheEntryPtr entry, std::string sectionconfig)
	GUI callback. More...

Characters

void	CreatePlayerCharacter ()
	Terrain must be loaded. More...

Character *	GetPlayerCharacter ()

CharacterFactory *	GetCharacterFactory ()

Savegames
void	LoadScene (std::string const &filename)
	Matching terrain must be already loaded. More...

void	SaveScene (std::string const &filename)

std::string	GetQuicksaveFilename ()
	For currently loaded terrain (cvar 'sim_terrain_name') More...

std::string	ExtractSceneName (std::string const &filename)

std::string	ExtractSceneTerrain (std::string const &filename)
	Returns terrain filename. More...

void	HandleSavegameHotkeys ()

Gameplay feats (misc.)
RaceSystem &	GetRaceSystem ()

RepairMode &	GetRepairMode ()

SceneMouse &	GetSceneMouse ()

void	TeleportPlayer (float x, float z)

void	UpdateGlobalInputEvents ()

void	UpdateSimInputEvents (float dt)

void	UpdateSkyInputEvents (float dt)

void	UpdateCommonInputEvents (float dt)

void	UpdateAirplaneInputEvents (float dt)

void	UpdateBoatInputEvents (float dt)

void	UpdateTruckInputEvents (float dt)

Private Attributes
GameMsgQueue	m_msg_queue

Message *	m_msg_chain_end = nullptr

std::mutex	m_msg_mutex

TerrainPtr	m_terrain

ActorManager	m_actor_manager

ActorPtr	m_player_actor
	Actor (vehicle or machine) mounted and controlled by player. More...

ActorPtr	m_prev_player_actor
	Previous actor (vehicle or machine) mounted and controlled by player. More...

ActorPtr	m_last_spawned_actor
	Last actor spawned by user and still alive. More...

ActorPtr	m_actor_remotely_receiving_commands
	Actor close enough to import command keys. More...

CacheEntryPtr	m_last_cache_selection
	Vehicle/load. More...

CacheEntryPtr	m_last_skin_selection

CacheEntryPtr	m_last_tuneup_selection

Ogre::String	m_last_section_config

ActorSpawnRequest	m_current_selection
	Context of the loader UI. More...

CacheEntryPtr	m_dummy_cache_selection

CharacterFactory	m_character_factory

RaceSystem	m_race_system

RepairMode	m_recovery_mode
	Aka 'advanced repair' or 'interactive reset'. More...

SceneMouse	m_scene_mouse
	Mouse interaction with scene. More...

Ogre::Timer	m_timer

Ogre::Vector3	prev_pos = Ogre::Vector3::ZERO

Friends
class	AppContext

Detailed Description

Central game state manager.

RoR's gameplay is quite simple in structure, it consists of:

static terrain: static elevation map, managed by Terrain. this includes static collision objects (or intrusion detection objects), managed by TerrainObjectManager.
softbody actors: a.k.a "trucks" or "vehicles" (local or remote), managed by ActorManager. They collide with static terrain and each other. this includes 'fixes' - actors with partially fixed position.
characters: player-controlled avatars (local or remote), managed by CharacterFactory. they have simplified physics and can climb objects. For convenience and to help manage interactions, this class provides methods to manipulate these elements.

CAUTION: PushMessage() doesn't guarantee order of processing: if message handler generates additional messages, it moves the original message at the end of the queue. To illustrate:

Start with empty queue.
push A.
push B which needs A.
Process the queue.
pop A, which needs C done first. It pushes C and re-pushes A.
Queue is now BCA. B fails because A wasn't done.

Message chaining is for situations where message order must be preserved.

Start with empty queue
push A.
chain B which needs A. - it's added to A's chain: A{B}.
Process the queue.
pop A, which needs C done first. It pushes C and re-pushes A{B}.
Queue is now C, A{B}. B succeeds because A gets done first.

Definition at line 95 of file GameContext.h.

Constructor & Destructor Documentation

◆ GameContext()

GameContext::GameContext ( )

Definition at line 53 of file GameContext.cpp.

◆ ~GameContext()

GameContext::~GameContext ( )

Definition at line 58 of file GameContext.cpp.

Member Function Documentation

◆ ChainMessage()

void GameContext::ChainMessage ( Message m )

Add to last pushed message's chain.

Definition at line 73 of file GameContext.cpp.

Here is the caller graph for this function:

◆ ChangePlayerActor()

void GameContext::ChangePlayerActor ( ActorPtr actor )

Definition at line 487 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreatePlayerCharacter()

void GameContext::CreatePlayerCharacter ( )

Terrain must be loaded.

Definition at line 840 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DeleteActor()

void GameContext::DeleteActor ( ActorPtr actor )

Definition at line 438 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ExtractSceneName()

std::string GameContext::ExtractSceneName ( std::string const & filename )

Definition at line 75 of file Savegame.cpp.

Here is the call graph for this function:

◆ ExtractSceneTerrain()

std::string GameContext::ExtractSceneTerrain ( std::string const & filename )

Returns terrain filename.

Definition at line 87 of file Savegame.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FetchNextVehicleOnList()

const ActorPtr & GameContext::FetchNextVehicleOnList ( )

Definition at line 595 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FetchPrevVehicleOnList()

const ActorPtr & GameContext::FetchPrevVehicleOnList ( )

Definition at line 590 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindActorByCollisionBox()

ActorPtr GameContext::FindActorByCollisionBox	(	std::string const &	ev_src_instance_name,
		std::string const &	box_name
	)

Definition at line 605 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetActorManager()

ActorManager* RoR::GameContext::GetActorManager ( )

inline

Definition at line 127 of file GameContext.h.

Here is the caller graph for this function:

◆ GetActorRemotelyReceivingCommands()

const ActorPtr& RoR::GameContext::GetActorRemotelyReceivingCommands ( )

inline

Definition at line 137 of file GameContext.h.

Here is the caller graph for this function:

◆ GetCharacterFactory()

CharacterFactory* RoR::GameContext::GetCharacterFactory ( )

inline

Definition at line 151 of file GameContext.h.

Here is the caller graph for this function:

◆ GetPlayerActor()

const ActorPtr& RoR::GameContext::GetPlayerActor ( )

inline

Definition at line 134 of file GameContext.h.

Here is the caller graph for this function:

◆ GetPlayerCharacter()

Character * GameContext::GetPlayerCharacter ( )

Definition at line 897 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPrevPlayerActor()

const ActorPtr& RoR::GameContext::GetPrevPlayerActor ( )

inline

Definition at line 135 of file GameContext.h.

Here is the caller graph for this function:

◆ GetQuicksaveFilename()

std::string GameContext::GetQuicksaveFilename ( )

For currently loaded terrain (cvar 'sim_terrain_name')

Definition at line 56 of file Savegame.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRaceSystem()

RaceSystem& RoR::GameContext::GetRaceSystem ( )

inline

Definition at line 169 of file GameContext.h.

Here is the caller graph for this function:

◆ GetRepairMode()

RepairMode& RoR::GameContext::GetRepairMode ( )

inline

Definition at line 170 of file GameContext.h.

Here is the caller graph for this function:

◆ GetSceneMouse()

SceneMouse& RoR::GameContext::GetSceneMouse ( )

inline

Definition at line 171 of file GameContext.h.

Here is the caller graph for this function:

◆ GetTerrain()

const TerrainPtr& RoR::GameContext::GetTerrain ( )

inline

Definition at line 117 of file GameContext.h.

Here is the caller graph for this function:

◆ HandleSavegameHotkeys()

void GameContext::HandleSavegameHotkeys ( )

Definition at line 99 of file Savegame.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasMessages()

bool GameContext::HasMessages ( )

Definition at line 90 of file GameContext.cpp.

◆ LoadScene()

void GameContext::LoadScene ( std::string const & filename )

Matching terrain must be already loaded.

Definition at line 64 of file Savegame.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadTerrain()

bool GameContext::LoadTerrain ( std::string const & filename_part )

Definition at line 112 of file GameContext.cpp.

Here is the call graph for this function:

◆ ModifyActor()

void GameContext::ModifyActor ( ActorModifyRequest & rq )

Definition at line 369 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnLoaderGuiApply()

void GameContext::OnLoaderGuiApply	(	RoR::LoaderType	type,
		CacheEntryPtr	entry,
		std::string	sectionconfig
	)

GUI callback.

Definition at line 704 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnLoaderGuiCancel()

void GameContext::OnLoaderGuiCancel ( )

GUI callback.

Definition at line 688 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopMessage()

Message GameContext::PopMessage ( )

Definition at line 96 of file GameContext.cpp.

Here is the caller graph for this function:

◆ PushMessage()

void GameContext::PushMessage ( Message m )

Doesn't guarantee order! Use ChainMessage() if order matters.

Definition at line 66 of file GameContext.cpp.

Here is the caller graph for this function:

◆ RespawnLastActor()

void GameContext::RespawnLastActor ( )

Definition at line 611 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveScene()

void GameContext::SaveScene ( std::string const & filename )

Definition at line 70 of file Savegame.cpp.

Here is the caller graph for this function:

◆ SetPrevPlayerActor()

void GameContext::SetPrevPlayerActor ( ActorPtr actor )

Definition at line 835 of file GameContext.cpp.

Here is the caller graph for this function:

◆ ShowLoaderGUI()

void GameContext::ShowLoaderGUI	(	int	type,
		const Ogre::String &	instance,
		const Ogre::String &	box
	)

Definition at line 660 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SpawnActor()

ActorPtr GameContext::SpawnActor ( ActorSpawnRequest & rq )

Definition at line 193 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SpawnPreselectedActor()

void GameContext::SpawnPreselectedActor	(	std::string const &	preset_vehicle,
		std::string const &	preset_veh_config
	)

needs Character to exist

Definition at line 624 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TeleportPlayer()

void GameContext::TeleportPlayer	(	float	x,
		float	z
	)

Definition at line 905 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UnloadTerrain()

void GameContext::UnloadTerrain ( )

Definition at line 179 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateActors()

void GameContext::UpdateActors ( )

Definition at line 600 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateAirplaneInputEvents()

void GameContext::UpdateAirplaneInputEvents ( float dt )

Definition at line 1602 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateBoatInputEvents()

void GameContext::UpdateBoatInputEvents ( float dt )

Definition at line 1790 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateCommonInputEvents()

void GameContext::UpdateCommonInputEvents ( float dt )

Definition at line 1320 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateGlobalInputEvents()

void GameContext::UpdateGlobalInputEvents ( )

Definition at line 943 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateSimInputEvents()

void GameContext::UpdateSimInputEvents ( float dt )

Definition at line 1058 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateSkyInputEvents()

void GameContext::UpdateSkyInputEvents ( float dt )

Definition at line 1256 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateTruckInputEvents()

void GameContext::UpdateTruckInputEvents ( float dt )

Definition at line 1850 of file GameContext.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ AppContext

friend class AppContext

friend

Definition at line 97 of file GameContext.h.

Field Documentation

◆ m_actor_manager

ActorManager RoR::GameContext::m_actor_manager

private

Definition at line 193 of file GameContext.h.

◆ m_actor_remotely_receiving_commands

ActorPtr RoR::GameContext::m_actor_remotely_receiving_commands

private

Actor close enough to import command keys.

Definition at line 197 of file GameContext.h.

◆ m_character_factory

CharacterFactory RoR::GameContext::m_character_factory

private

Definition at line 207 of file GameContext.h.

◆ m_current_selection

ActorSpawnRequest RoR::GameContext::m_current_selection

private

Context of the loader UI.

Definition at line 203 of file GameContext.h.

◆ m_dummy_cache_selection

CacheEntryPtr RoR::GameContext::m_dummy_cache_selection

private

Definition at line 204 of file GameContext.h.

◆ m_last_cache_selection

CacheEntryPtr RoR::GameContext::m_last_cache_selection

private

Vehicle/load.

Definition at line 199 of file GameContext.h.

◆ m_last_section_config

Ogre::String RoR::GameContext::m_last_section_config

private

Definition at line 202 of file GameContext.h.

◆ m_last_skin_selection

CacheEntryPtr RoR::GameContext::m_last_skin_selection

private

Definition at line 200 of file GameContext.h.

◆ m_last_spawned_actor

ActorPtr RoR::GameContext::m_last_spawned_actor

private

Last actor spawned by user and still alive.

Definition at line 196 of file GameContext.h.

◆ m_last_tuneup_selection

CacheEntryPtr RoR::GameContext::m_last_tuneup_selection

private

Definition at line 201 of file GameContext.h.

◆ m_msg_chain_end

Message* RoR::GameContext::m_msg_chain_end = nullptr

private

Definition at line 186 of file GameContext.h.

◆ m_msg_mutex

std::mutex RoR::GameContext::m_msg_mutex

private

Definition at line 187 of file GameContext.h.

◆ m_msg_queue

GameMsgQueue RoR::GameContext::m_msg_queue

private

Definition at line 185 of file GameContext.h.

◆ m_player_actor

ActorPtr RoR::GameContext::m_player_actor

private

Actor (vehicle or machine) mounted and controlled by player.

Definition at line 194 of file GameContext.h.

◆ m_prev_player_actor

ActorPtr RoR::GameContext::m_prev_player_actor

private

Previous actor (vehicle or machine) mounted and controlled by player.

Definition at line 195 of file GameContext.h.

◆ m_race_system

RaceSystem RoR::GameContext::m_race_system

private

Definition at line 210 of file GameContext.h.

◆ m_recovery_mode

RepairMode RoR::GameContext::m_recovery_mode

private

Aka 'advanced repair' or 'interactive reset'.

Definition at line 211 of file GameContext.h.

◆ m_scene_mouse

SceneMouse RoR::GameContext::m_scene_mouse

private

Mouse interaction with scene.

Definition at line 212 of file GameContext.h.

◆ m_terrain

TerrainPtr RoR::GameContext::m_terrain

private

Definition at line 190 of file GameContext.h.

◆ m_timer

Ogre::Timer RoR::GameContext::m_timer

private

Definition at line 213 of file GameContext.h.

◆ prev_pos

Ogre::Vector3 RoR::GameContext::prev_pos = Ogre::Vector3::ZERO

private

Definition at line 214 of file GameContext.h.

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

source/main/GameContext.h
source/main/GameContext.cpp
source/main/physics/Savegame.cpp

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GameContext()

◆ ~GameContext()

Member Function Documentation

◆ ChainMessage()

◆ ChangePlayerActor()

◆ CreatePlayerCharacter()

◆ DeleteActor()

◆ ExtractSceneName()

◆ ExtractSceneTerrain()

◆ FetchNextVehicleOnList()

◆ FetchPrevVehicleOnList()

◆ FindActorByCollisionBox()

◆ GetActorManager()

◆ GetActorRemotelyReceivingCommands()

◆ GetCharacterFactory()

◆ GetPlayerActor()

◆ GetPlayerCharacter()

◆ GetPrevPlayerActor()

◆ GetQuicksaveFilename()

◆ GetRaceSystem()

◆ GetRepairMode()

◆ GetSceneMouse()

◆ GetTerrain()

◆ HandleSavegameHotkeys()

◆ HasMessages()

◆ LoadScene()

◆ LoadTerrain()

◆ ModifyActor()

◆ OnLoaderGuiApply()

◆ OnLoaderGuiCancel()

◆ PopMessage()

◆ PushMessage()

◆ RespawnLastActor()

◆ SaveScene()

◆ SetPrevPlayerActor()

◆ ShowLoaderGUI()

◆ SpawnActor()

◆ SpawnPreselectedActor()

◆ TeleportPlayer()

◆ UnloadTerrain()

◆ UpdateActors()

◆ UpdateAirplaneInputEvents()

◆ UpdateBoatInputEvents()

◆ UpdateCommonInputEvents()

◆ UpdateGlobalInputEvents()

◆ UpdateSimInputEvents()

◆ UpdateSkyInputEvents()

◆ UpdateTruckInputEvents()

Friends And Related Function Documentation

◆ AppContext

Field Documentation

◆ m_actor_manager

◆ m_actor_remotely_receiving_commands

◆ m_character_factory

◆ m_current_selection

◆ m_dummy_cache_selection

◆ m_last_cache_selection

◆ m_last_section_config

◆ m_last_skin_selection

◆ m_last_spawned_actor

◆ m_last_tuneup_selection

◆ m_msg_chain_end

◆ m_msg_mutex

◆ m_msg_queue

◆ m_player_actor

◆ m_prev_player_actor

◆ m_race_system

◆ m_recovery_mode

◆ m_scene_mouse

◆ m_terrain

◆ m_timer

◆ prev_pos