SCR_BaseGameModeComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_BaseGameModeComponentClass

Functions
SCR_BaseGameMode	GetGameMode ()
void	OnGameEnd ()
	Called on all machines when the world ends.
void	OnGameStateChanged (SCR_EGameModeState state)
void	OnGameModeStart ()
void	OnGameModeEnd (SCR_GameModeEndData data)
void	OnPlayerConnected (int playerId)
void	OnPlayerAuditSuccess (int playerId)
void	OnPlayerAuditFail (int playerId)
void	OnPlayerAuditTimeouted (int playerId)
void	OnPlayerAuditRevived (int playerId)
void	OnPlayerRegistered (int playerId)
void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
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)
void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
void	OnPlayerDeleted (int playerId, IEntity player)
void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
void	OnWorldPostProcess (World world)
void	OnControllableSpawned (IEntity entity)
void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
void	OnControllableDeleted (IEntity entity)
void	SCR_BaseGameModeComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Variables
SCR_BaseGameModeComponentClass	m_pGameMode
	The game mode entity this component is attached to.

Function Documentation

GetGameMode()

SCR_BaseGameMode GetGameMode

(

)

Returns

Returns game mode this component is attached to.

Definition at line 15 of file SCR_BaseGameModeComponent.c.

HandlePlayerKilled()

bool HandlePlayerKilled	(	int	playerId,
		IEntity	playerEntity,
		IEntity	killerEntity,
		notnull Instigator	instigator )

See SCR_BaseGameMode.HandlePlayerKilled.

Definition at line 113 of file SCR_BaseGameModeComponent.c.

OnControllableDestroyed()

void OnControllableDestroyed

(

notnull SCR_InstigatorContextData

instigatorContextData

)

When a controllable entity is destroyed, this event is raised.

Parameters

[in]

instigatorContextData

Holds the data of the victim and killer

Definition at line 163 of file SCR_XPHandlerComponent.c.

OnGameEnd()

void OnGameEnd

(

)

Called on all machines when the world ends.

Definition at line 65 of file SCR_AnalyticsDataCollectionComponent.c.

OnGameModeEnd()

void OnGameModeEnd

(

SCR_GameModeEndData

data

)

Called when game mode ends.

Parameters

[in]

data

End game data with game logic.

Definition at line 50 of file SCR_AnalyticsDataCollectionComponent.c.

OnGameModeStart()

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

Definition at line 36 of file SCR_CacheManagerComponent.c.

OnGameStateChanged()

void OnGameStateChanged

(

SCR_EGameModeState

state

)

Called when game mode state changes called on all machines.

Parameters

[in]

state

New state game mode transitioned into.

Definition at line 38 of file SCR_BaseGameModeStateComponent.c.

OnPlayerConnected()

void OnPlayerConnected

(

int

playerId

)

Called after a player is connected. Server-only.

Parameters

[in]	playerId	PlayerId of connected player.
[in]	playerId

Definition at line 33 of file SCR_LocalPlayerPenalty.c.

OnPlayerDeleted()

void OnPlayerDeleted	(	int	playerId,
		IEntity	player )

Called after a player gets deleted.

Parameters

[in]	playerId	Player ID
[in]	player	Player entity

Definition at line 303 of file SCR_PlayerSupplyAllocationComponent.c.

OnPlayerDisconnected()

void OnPlayerDisconnected	(	int	playerId,
		KickCauseCode	cause,
		int	timeout )

Called after a player is disconnected.

Parameters

[in]	playerId	PlayerId of disconnected player.
[in]	cause	Reason player disconnected
[in]	timeout	Timeout for when players are allowed to connect again. -1 means Ban without an assigned timeout

What happens when a player disconnects.

Parameters

[in]	playerID	is a unique player identifier that defines which player has disconnected.
[in]	cause
[in]	timeout

Definition at line 87 of file SCR_PlayerProfileManagerComponent.c.

OnPlayerKilled()

void OnPlayerKilled

(

notnull SCR_InstigatorContextData

instigatorContextData

)

Called after a player gets killed.

Parameters

[in]	instigatorContextData	Holds the data of the victim and killer
[in]	playerId
[in]	playerEntity
[in]	killerEntity
[in]	killer

Definition at line 1014 of file SCR_CampaignFeedbackComponent.c.

OnPlayerKilledHandled()

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. See also SCR_BaseGameMode.HandlePlayerKilled().

Parameters

[in]	playerId	PlayerId of victim player.
[in]	playerEntity	Entity of victim player if any.
[in]	killerEntity	Entity of killer instigator if any.
[in]	instigator	Instigator of the kill

OnPlayerRegistered()

void OnPlayerRegistered

(

int

playerId

)

Called on every machine after a player is registered (identity, name etc.). Always called after OnPlayerConnected.

Parameters

[in]

playerId

PlayerId of registered player.

Definition at line 934 of file SCR_VotingManagerComponent.c.

OnPlayerSpawnFinalize_S()

void OnPlayerSpawnFinalize_S	(	SCR_SpawnRequestComponent	requestComponent,
		SCR_SpawnHandlerComponent	handlerComponent,
		SCR_SpawnData	data,
		IEntity	entity )

Parameters

[in]	requestComponent
[in]	handlerComponent
[in]	data
[in]	entity

Definition at line 93 of file SCR_SpawnProtectionComponent.c.

OnSpawnPlayerEntityFailure_S()

void OnSpawnPlayerEntityFailure_S	(	SCR_SpawnRequestComponent	requestComponent,
		SCR_SpawnHandlerComponent	handlerComponent,
		IEntity	entity,
		SCR_SpawnData	data,
		SCR_ESpawnResult	reason )

Parameters

[in]	requestComponent
[in]	handlerComponent
[in]	entity
[in]	data
[in]	reason

Definition at line 100 of file SCR_SpawnProtectionComponent.c.

PreparePlayerEntity_S()

bool PreparePlayerEntity_S	(	SCR_SpawnRequestComponent	requestComponent,
		SCR_SpawnHandlerComponent	handlerComponent,
		SCR_SpawnData	data,
		IEntity	entity )

Parameters

[in]	requestComponent
[in]	handlerComponent
[in]	data
[in]	entity

Returns

Definition at line 91 of file SCR_BaseGameModeComponent.c.

SCR_BaseGameModeComponent()

void SCR_BaseGameModeComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent )

Parameters

[in]	src
[in]	ent
[in]	parent

Definition at line 171 of file SCR_BaseGameModeComponent.c.

Variable Documentation

m_pGameMode

SCR_BaseGameModeComponentClass m_pGameMode

The game mode entity this component is attached to.

Interface for game mode extending components. Must be attached to a GameMode entity.