SCR_FreeSpawnRequestComponent Interface Reference

Inheritance diagram for SCR_FreeSpawnRequestComponent:

Public Member Functions
override TypeName	GetHandlerType ()
override TypeName	GetDataType ()
override bool	DoCanRequestRespawn (SCR_SpawnData data)
	Request is first handled on the sending side (player or authority depending on context).
Public Member Functions inherited from SCR_SpawnRequestComponent
PlayerController	GetPlayerController ()
int	GetPlayerId ()
SCR_SpawnHandlerComponent	GetHandlerComponent ()
TypeName	GetHandlerType ()
TypeName	GetDataType ()
sealed bool	CanRequestRespawn (SCR_SpawnData data)
	Sends an ask request to the authority to find out whether spawn with provided data is valid.
sealed bool	RequestRespawn (SCR_SpawnData data)
	Requests respawn with provided data.
bool	IsPreloading ()
void	StartSpawnPreload (vector position)
void	~SCR_SpawnRequestComponent ()

Protected Member Functions
override bool	DoRequestRespawn (SCR_SpawnData data)
	Requests respawn with provided data.
Protected Member Functions inherited from SCR_SpawnRequestComponent
SCR_RespawnComponent	GetRespawnComponent ()
SCR_SpawnLockComponent	GetLock ()
bool	IsOwner ()
bool	IsProxy ()
override void	OnPostInit (IEntity owner)
	Initialises the component by finding necessary dependencies.
bool	DoCanRequestRespawn (SCR_SpawnData data)
	Request is first handled on the sending side (player or authority depending on context).
void	ProcessCanRequest_S (SCR_SpawnData data)
	Authority call to dispatch provided data to corresponding SCR_SpawnHandlerComponent.
void	SendCanResponse_S (SCR_ESpawnResult response, SCR_SpawnData data)
	Authority: Sends a response from the server to the owner about current can-respawn request.
void	Rpc_SendCanResponse_O (SCR_ESpawnResult response)
	Owner: Processes received response about current spawn process from the authority, dispatches events.
bool	DoRequestRespawn (SCR_SpawnData data)
	Request is first handled on the sending side (player or authority depending on context).
void	ProcessRequest_S (SCR_SpawnData data)
	Authority call to dispatch provided data to corresponding SCR_SpawnHandlerComponent.
void	OnFinalizeBegin_S (SCR_SpawnHandlerComponent handler, SCR_SpawnData data, IEntity spawnedEntity)
	Authority callback when finalisation of spawn has began.
void	AwaitFinalization_S (SCR_SpawnHandlerComponent handler, SCR_SpawnData data, IEntity spawnedEntity)
	Authority callback to await finalisation.
bool	CanFinalize_S (SCR_SpawnHandlerComponent handler, SCR_SpawnData data, IEntity spawnedEntity)
void	FinalizeRequest_S (SCR_SpawnHandlerComponent handler, SCR_SpawnData data, IEntity spawnedEntity)
	Authority call to finalise respawn, after ProcessRequest_S (AwaitFinalization_S respectively) has finished.
void	SendResponse_S (SCR_ESpawnResult response, SCR_SpawnData data)
	Authority: Sends a response from the server to the owner about current respawn request.
void	SendFinalizationBegin_S ()
	Send a notification from the authority that the finalisation has started.
void	Rpc_OnFinalizationBegin_O ()
void	NotifyPreloadStarted_S ()
void	Rpc_NotifyPreloadStarted_S ()
void	NotifyPreloadFinished_S ()
void	Rpc_NotifyPreloadFinished_S ()
void	Rpc_StartPreload_O (vector position)
void	Rpc_SendResponse_O (SCR_ESpawnResult response)
	Owner: Processes received response about current spawn process from the authority, dispatches events.
SCR_ChimeraAIAgent	FindAIAgent (IEntity entity)
	Tries to find AI agent for provided entity.

Member Function Documentation

DoCanRequestRespawn()

override bool SCR_FreeSpawnRequestComponent.DoCanRequestRespawn

(

SCR_SpawnData

data

)

Request is first handled on the sending side (player or authority depending on context).

This method can return false and will immediately raise a SCR_ESpawnResult.BAD_REQUEST response.

Returns

true in case request was sucessfully dispatched, false otherwise.

Implements SCR_SpawnRequestComponent.

DoRequestRespawn()

override bool SCR_FreeSpawnRequestComponent.DoRequestRespawn ( SCR_SpawnData  data )

protected

Requests respawn with provided data.

Parameters

[in]

data

Returns

true in case success was successfuly dispatched, false otherwise. Note that such request can still be denied by the authority!

Implements SCR_SpawnRequestComponent.

GetDataType()

override TypeName SCR_FreeSpawnRequestComponent.GetDataType

(

)

Returns

the type of TData this TRequestComponent is linked to. Each request sent through a TRequestComponent accepts and handles a TData payload.

Implements SCR_SpawnRequestComponent.

GetHandlerType()

override TypeName SCR_FreeSpawnRequestComponent.GetHandlerType

(

)

Returns

the type of THandlerComponent component this TRequestComponent is linked to. Each request sent through a TRequestComponent is always processed via a THandlerComponent.

Implements SCR_SpawnRequestComponent.

---

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

• Game/Respawn/RequestHandling/Implementation/FreeSpawn/SCR_FreeSpawnRequestComponent.c