Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_RandomSpawnManagerComponent Interface Reference
Inheritance diagram for SCR_RandomSpawnManagerComponent:
SCR_BaseGameModeComponent

Public Member Functions

override void OnGameModeStart ()
 Called on every machine when game mode starts.
 
bool RequestSpawnPosition (FactionKey playerFaction, array< SCR_SpawnPoint > currentWorldSpawns, out vector outPos)
 
- 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)
 

Protected Member Functions

void InitializeGrid ()
 
void WakeUpGenerator ()
 
void ProcessGenerationBatch ()
 
bool TryGenerateSinglePoint (out vector outPos)
 
bool IsDynamicallySafe (vector pos, FactionKey playerFaction, array< SCR_SpawnPoint > currentWorldSpawns)
 

Protected Attributes

int m_iCachedSpawnPointCount
 
float m_fSafeDistance
 
int m_iTargetCellDensity
 
int m_iGenerationBatchSize
 
int m_iEmergencyAttempts
 
ref array< ref SCR_SpawnPointBlacklistZone > m_aBlacklistZones
 
ref array< vector > m_aPrecalculatedSpawns = {}
 
ref array< vector > m_aSafeCells = {}
 
bool m_bIsGenerating
 
float m_fCellSize
 
float m_fHalfCellOffset
 
float m_fRayLength
 
float m_fSafeDistanceSq
 
int m_iBatchDelayMs
 
int m_iLastUsedIndex
 
TraceFlags m_TraceFlags
 
ref TraceParam m_TraceParam
 
vector m_vCylinderVectorOffset
 
vector m_vTraceOffset
 
BaseWorld m_World
 
- Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode m_pGameMode
 The game mode entity this component is attached to.
 

Static Protected Attributes

const float MAX_SURFACE_DELTA = 0.8
 
const float PLAYER_CYLINDER_HEIGHT = 2
 
const float PLAYER_CYLINDER_RADIUS = 0.5
 
const float WATER_LEVEL_THRESHOLD = 1
 
const float RAYCAST_HEIGHT_OFFSET = 10
 
const float MIN_CELL_SIZE = 10
 
const float JUMP_GOLDEN_RATIO = 0.6180339887
 

Member Function Documentation

◆ InitializeGrid()

void SCR_RandomSpawnManagerComponent.InitializeGrid ( )
protected

◆ IsDynamicallySafe()

bool SCR_RandomSpawnManagerComponent.IsDynamicallySafe ( vector pos,
FactionKey playerFaction,
array< SCR_SpawnPoint > currentWorldSpawns )
protected

◆ OnGameModeStart()

override void SCR_RandomSpawnManagerComponent.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.

◆ ProcessGenerationBatch()

void SCR_RandomSpawnManagerComponent.ProcessGenerationBatch ( )
protected

◆ RequestSpawnPosition()

bool SCR_RandomSpawnManagerComponent.RequestSpawnPosition ( FactionKey playerFaction,
array< SCR_SpawnPoint > currentWorldSpawns,
out vector outPos )
Parameters
[in]playerFaction
[in]currentWorldSpawns
[out]outPos
Returns

◆ TryGenerateSinglePoint()

bool SCR_RandomSpawnManagerComponent.TryGenerateSinglePoint ( out vector outPos)
protected

◆ WakeUpGenerator()

void SCR_RandomSpawnManagerComponent.WakeUpGenerator ( )
protected

Member Data Documentation

◆ JUMP_GOLDEN_RATIO

const float SCR_RandomSpawnManagerComponent.JUMP_GOLDEN_RATIO = 0.6180339887
staticprotected

◆ m_aBlacklistZones

ref array<ref SCR_SpawnPointBlacklistZone> SCR_RandomSpawnManagerComponent.m_aBlacklistZones
protected

◆ m_aPrecalculatedSpawns

ref array<vector> SCR_RandomSpawnManagerComponent.m_aPrecalculatedSpawns = {}
protected

◆ m_aSafeCells

ref array<vector> SCR_RandomSpawnManagerComponent.m_aSafeCells = {}
protected

◆ m_bIsGenerating

bool SCR_RandomSpawnManagerComponent.m_bIsGenerating
protected

◆ m_fCellSize

float SCR_RandomSpawnManagerComponent.m_fCellSize
protected

◆ m_fHalfCellOffset

float SCR_RandomSpawnManagerComponent.m_fHalfCellOffset
protected

◆ m_fRayLength

float SCR_RandomSpawnManagerComponent.m_fRayLength
protected

◆ m_fSafeDistance

float SCR_RandomSpawnManagerComponent.m_fSafeDistance
protected

◆ m_fSafeDistanceSq

float SCR_RandomSpawnManagerComponent.m_fSafeDistanceSq
protected

◆ m_iBatchDelayMs

int SCR_RandomSpawnManagerComponent.m_iBatchDelayMs
protected

◆ m_iCachedSpawnPointCount

int SCR_RandomSpawnManagerComponent.m_iCachedSpawnPointCount
protected

◆ m_iEmergencyAttempts

int SCR_RandomSpawnManagerComponent.m_iEmergencyAttempts
protected

◆ m_iGenerationBatchSize

int SCR_RandomSpawnManagerComponent.m_iGenerationBatchSize
protected

◆ m_iLastUsedIndex

int SCR_RandomSpawnManagerComponent.m_iLastUsedIndex
protected

◆ m_iTargetCellDensity

int SCR_RandomSpawnManagerComponent.m_iTargetCellDensity
protected

◆ m_TraceFlags

TraceFlags SCR_RandomSpawnManagerComponent.m_TraceFlags
protected

◆ m_TraceParam

ref TraceParam SCR_RandomSpawnManagerComponent.m_TraceParam
protected

◆ m_vCylinderVectorOffset

vector SCR_RandomSpawnManagerComponent.m_vCylinderVectorOffset
protected

◆ m_vTraceOffset

vector SCR_RandomSpawnManagerComponent.m_vTraceOffset
protected

◆ m_World

BaseWorld SCR_RandomSpawnManagerComponent.m_World
protected

◆ MAX_SURFACE_DELTA

const float SCR_RandomSpawnManagerComponent.MAX_SURFACE_DELTA = 0.8
staticprotected

◆ MIN_CELL_SIZE

const float SCR_RandomSpawnManagerComponent.MIN_CELL_SIZE = 10
staticprotected

◆ PLAYER_CYLINDER_HEIGHT

const float SCR_RandomSpawnManagerComponent.PLAYER_CYLINDER_HEIGHT = 2
staticprotected

◆ PLAYER_CYLINDER_RADIUS

const float SCR_RandomSpawnManagerComponent.PLAYER_CYLINDER_RADIUS = 0.5
staticprotected

◆ RAYCAST_HEIGHT_OFFSET

const float SCR_RandomSpawnManagerComponent.RAYCAST_HEIGHT_OFFSET = 10
staticprotected

◆ WATER_LEVEL_THRESHOLD

const float SCR_RandomSpawnManagerComponent.WATER_LEVEL_THRESHOLD = 1
staticprotected
The documentation for this interface was generated from the following file: