Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
KODI::GAME::CGameClientSubsystem Class Reference

Base class for game client subsystems. More...

#include <GameClientSubsystem.h>

Inheritance diagram for KODI::GAME::CGameClientSubsystem:
KODI::GAME::CGameClientInput

Static Public Member Functions

static GameClientSubsystems CreateSubsystems (CGameClient &gameClient, AddonInstance_Game &gameStruct, CCriticalSection &clientAccess)
 Create a struct with the allocated subsystems.
 
static void DestroySubsystems (GameClientSubsystems &subsystems)
 Deallocate subsystems.
 

Protected Member Functions

 CGameClientSubsystem (CGameClient &gameClient, AddonInstance_Game &addonStruct, CCriticalSection &clientAccess)
 
virtual ~CGameClientSubsystem ()
 
CGameClientCheevosCheevos () const
 
CGameClientInputInput () const
 
CGameClientPropertiesAddonProperties () const
 
CGameClientStreamsStreams () const
 

Protected Attributes

CGameClientm_gameClient
 
AddonInstance_Gamem_struct
 
CCriticalSection & m_clientAccess
 

Detailed Description

Base class for game client subsystems.

Constructor & Destructor Documentation

◆ CGameClientSubsystem()

CGameClientSubsystem::CGameClientSubsystem ( CGameClient & gameClient,
AddonInstance_Game & addonStruct,
CCriticalSection & clientAccess )
protected

◆ ~CGameClientSubsystem()

CGameClientSubsystem::~CGameClientSubsystem ( )
protectedvirtualdefault

Member Function Documentation

◆ AddonProperties()

CGameClientProperties & CGameClientSubsystem::AddonProperties ( ) const
protected

◆ Cheevos()

CGameClientCheevos & CGameClientSubsystem::Cheevos ( ) const
protected

◆ CreateSubsystems()

GameClientSubsystems CGameClientSubsystem::CreateSubsystems ( CGameClient & gameClient,
AddonInstance_Game & gameStruct,
CCriticalSection & clientAccess )
static

Create a struct with the allocated subsystems.

Parameters
gameClientThe owner of the subsystems
gameStructThe game client's add-on function table
clientAccessMutex guarding client function access
Returns
A fully-allocated GameClientSubsystems struct

◆ DestroySubsystems()

void CGameClientSubsystem::DestroySubsystems ( GameClientSubsystems & subsystems)
static

Deallocate subsystems.

Parameters
subsystemsThe subsystems created by CreateSubsystems()

◆ Input()

CGameClientInput & CGameClientSubsystem::Input ( ) const
protected

◆ Streams()

CGameClientStreams & CGameClientSubsystem::Streams ( ) const
protected

Member Data Documentation

◆ m_clientAccess

CCriticalSection& KODI::GAME::CGameClientSubsystem::m_clientAccess
protected

◆ m_gameClient

CGameClient& KODI::GAME::CGameClientSubsystem::m_gameClient
protected

◆ m_struct

AddonInstance_Game& KODI::GAME::CGameClientSubsystem::m_struct
protected

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