SCR_TaskSolverManagerComponent Interface Reference

Inheritance diagram for SCR_TaskSolverManagerComponent:

Public Member Functions
SCR_TaskSolverBase	CreateSolver (TypeName solverType)
	Creates, configures, and registers a new solver.
void	StartSolverTask (SCR_TaskSolverBase solver, SCR_Task task, SCR_TaskSolverContext context)
	Starts and injects task/context into the given solver.
void	RemoveSolver (notnull SCR_TaskSolverBase solver)
	Removes and cleans up a solver.
void	Update (float timeSlice)
	Updates all solvers.
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	OnGameModeStart ()
	Called on every machine when game mode starts.
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)

Protected Member Functions
bool	IsMaster ()
void	OnResupplyTaskSolverStateChanged (int solverId, SCR_EResupplyTaskSolverState resupplyTaskSolverState)
void	RpcDo_SetResupplyTaskSolverState (int solverId, SCR_EResupplyTaskSolverState resupplyTaskSolverState)
SCR_TaskSolverBase	Find (int solverId)
SCR_TaskSolverBase	Find (notnull SCR_Task task)
	Finds a solver associated with a task (linear search).
void	SetSolverEntry (SCR_TaskSolverBase solver)
	Configures the solver with entries/config as needed.
override void	OnPostInit (IEntity owner)
override void	OnDelete (IEntity owner)
	Cleans up all solvers on delete.

Protected Attributes
ref SCR_TaskSolverConfig	m_TaskSolverConfig
ref array< ref SCR_TaskSolverBase >	m_aActiveSolvers = {}
RplComponent	m_RplComponent
Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Static Protected Attributes
static int	s_iMaxSolverId = -1

Member Function Documentation

CreateSolver()

SCR_TaskSolverBase SCR_TaskSolverManagerComponent.CreateSolver

(

TypeName

solverType

)

Creates, configures, and registers a new solver.

Parameters

[in]

solverType

The solver typename.

Returns

The created solver or null if failed.

Find() [1/2]

SCR_TaskSolverBase SCR_TaskSolverManagerComponent.Find ( int solverId )

protected

Find() [2/2]

SCR_TaskSolverBase SCR_TaskSolverManagerComponent.Find ( notnull SCR_Task task )

protected

Finds a solver associated with a task (linear search).

Parameters

[in]

task

The task to search for.

Returns

The solver or null if not found.

IsMaster()

bool SCR_TaskSolverManagerComponent.IsMaster ( )

protected

OnDelete()

override void SCR_TaskSolverManagerComponent.OnDelete ( IEntity owner )

protected

Cleans up all solvers on delete.

OnPostInit()

override void SCR_TaskSolverManagerComponent.OnPostInit ( IEntity owner )

protected

OnResupplyTaskSolverStateChanged()

void SCR_TaskSolverManagerComponent.OnResupplyTaskSolverStateChanged ( int solverId, SCR_EResupplyTaskSolverState resupplyTaskSolverState )

protected

RemoveSolver()

void SCR_TaskSolverManagerComponent.RemoveSolver

(

notnull SCR_TaskSolverBase

solver

)

Removes and cleans up a solver.

Parameters

[in]

solver

The solver to remove.

RpcDo_SetResupplyTaskSolverState()

void SCR_TaskSolverManagerComponent.RpcDo_SetResupplyTaskSolverState ( int solverId, SCR_EResupplyTaskSolverState resupplyTaskSolverState )

protected

SetSolverEntry()

void SCR_TaskSolverManagerComponent.SetSolverEntry ( SCR_TaskSolverBase solver )

protected

Configures the solver with entries/config as needed.

StartSolverTask()

void SCR_TaskSolverManagerComponent.StartSolverTask	(	SCR_TaskSolverBase	solver,
		SCR_Task	task,
		SCR_TaskSolverContext	context )

Starts and injects task/context into the given solver.

Parameters

[in]	solver	The solver to initialize and start.
[in]	task	The task to inject.
[in]	context	The context.

Update()

void SCR_TaskSolverManagerComponent.Update

(

float

timeSlice

)

Updates all solvers.

Member Data Documentation

m_aActiveSolvers

ref array<ref SCR_TaskSolverBase> SCR_TaskSolverManagerComponent.m_aActiveSolvers = {}

protected

m_RplComponent

RplComponent SCR_TaskSolverManagerComponent.m_RplComponent

protected

m_TaskSolverConfig

ref SCR_TaskSolverConfig SCR_TaskSolverManagerComponent.m_TaskSolverConfig

protected

s_iMaxSolverId

int SCR_TaskSolverManagerComponent.s_iMaxSolverId = -1

staticprotected

---

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

• Game/TaskSolver/SCR_TaskSolverManagerComponent.c