SCR_CacheManagerComponent Interface Reference

Inheritance diagram for SCR_CacheManagerComponent:

Public Member Functions
override void	OnPostInit (IEntity owner)
override void	OnGameModeStart ()
	Called on every machine when game mode starts.
void	GetRandomCacheData (out notnull array< string > outLines)
Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	GetGameMode ()
void	OnGameEnd ()
	Called on all machines when the world ends.
void	OnGameStateChanged (SCR_EGameModeState state)
	Called when game mode state changes called on all machines.
void	OnGameModeEnd (SCR_GameModeEndData data)
	Called when game mode ends.
void	OnPlayerConnected (int playerId)
	Called after a player is connected.
void	OnPlayerAuditSuccess (int playerId)
	Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.
void	OnPlayerAuditFail (int playerId)
	Event is called when player connecting Session hosting current Game Mode AuditFail() call may be called under two occasions: 1) verification is required but failed (account is not valid, player is banned, internet issues) 2) player cannot be verified as authentication is not required or possible - where it may be valid behavior (server online connectivity turned off for example) Basically non-audited player cannot access persistency/ etc.
void	OnPlayerAuditTimeouted (int playerId)
	Event is called when player connected to Session was kicked and did not reconnected in time This mean that slot reservation can be canceled.
void	OnPlayerAuditRevived (int playerId)
	Event is called when player reconnected successfully back to Session after kick This mean that slot reservation need to be finished (closed).
void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).
void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.
bool	PreparePlayerEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
void	OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)
void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
bool	HandlePlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	See SCR_BaseGameMode.HandlePlayerKilled.
void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	Called after a player gets killed.
void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	Called after player gets killed in cases where the kill was handled by the game mode, supressing the default OnPlayerKilled behaviour.
void	OnPlayerDeleted (int playerId, IEntity player)
	Called after a player gets deleted.
void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
	Called when player role changes.
void	OnWorldPostProcess (World world)
	Called once loading of all entities of the world have been finished (still within the loading)
void	OnControllableSpawned (IEntity entity)
	When a controllable entity is spawned, this event is raised.
void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	When a controllable entity is destroyed, this event is raised.
void	OnControllableDeleted (IEntity entity)
	Prior to a controllable entity being DELETED, this event is raised.
void	SCR_BaseGameModeComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Static Public Member Functions
static SCR_CacheManagerComponent	GetInstance ()

Public Attributes
int	m_iAmount

Protected Member Functions
void	SpawnRandomCaches (int count)

Protected Attributes
ResourceName	m_sCachePrefab
ResourceName	m_sTerrainConfig
ref array< ref SCR_CacheLocationData >	m_aCachePool = {}
ref SCR_CacheTerrainConfig	m_TerrainConfig
ref array< string >	m_aActiveCacheHints = {}
Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Static Protected Attributes
static SCR_CacheManagerComponent	s_Instance

Member Function Documentation

GetInstance()

static SCR_CacheManagerComponent SCR_CacheManagerComponent.GetInstance ( )

static

Returns

GetRandomCacheData()

void SCR_CacheManagerComponent.GetRandomCacheData

(

out notnull array< string >

outLines

)

Parameters

[out]

outLines

OnGameModeStart()

override void SCR_CacheManagerComponent.OnGameModeStart

(

)

Called on every machine when game mode starts.

This can be immediate (if no pre-game period is set) or can happen after a certain delay, as deemed appropriate by the authority.

Implements SCR_BaseGameModeComponent.

OnPostInit()

override void SCR_CacheManagerComponent.OnPostInit

(

IEntity

owner

)

SpawnRandomCaches()

void SCR_CacheManagerComponent.SpawnRandomCaches ( int count )

protected

Member Data Documentation

m_aActiveCacheHints

ref array<string> SCR_CacheManagerComponent.m_aActiveCacheHints = {}

protected

m_aCachePool

ref array<ref SCR_CacheLocationData> SCR_CacheManagerComponent.m_aCachePool = {}

protected

m_iAmount

int SCR_CacheManagerComponent.m_iAmount

m_sCachePrefab

ResourceName SCR_CacheManagerComponent.m_sCachePrefab

protected

m_sTerrainConfig

ResourceName SCR_CacheManagerComponent.m_sTerrainConfig

protected

m_TerrainConfig

ref SCR_CacheTerrainConfig SCR_CacheManagerComponent.m_TerrainConfig

protected

s_Instance

SCR_CacheManagerComponent SCR_CacheManagerComponent.s_Instance

staticprotected

---

The documentation for this interface was generated from the following file:

• Game/Caches/SCR_CacheManagerComponent.c