SCR_SpawnProtectionComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_SpawnProtectionComponentClass

Functions
SCR_SpawnProtectionComponentClass SCR_BaseGameModeComponentClass	Attribute (defvalue:"0.1", desc:"How long should be player protected?")
override void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
override void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
override void	OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)
void	OnPlayerAmmoChangeCallback (BaseWeaponComponent currentWeapon, BaseMuzzleComponent currentMuzzle, BaseMagazineComponent magazine, int ammoCount, bool isChambered)
void	DisablePlayerProtection (IEntity playerEntity)

Function Documentation

Attribute()

SCR_SpawnProtectionComponentClass SCR_BaseGameModeComponentClass Attribute	(	defvalue:"0.1"	,
		desc:"How long should be player protected?"	)

Definition at line 1 of file SCR_SpawnProtectionComponent.c.

DisablePlayerProtection()

void DisablePlayerProtection ( IEntity playerEntity )

protected

Definition at line 132 of file SCR_SpawnProtectionComponent.c.

OnPlayerAmmoChangeCallback()

void OnPlayerAmmoChangeCallback ( BaseWeaponComponent currentWeapon, BaseMuzzleComponent currentMuzzle, BaseMagazineComponent magazine, int ammoCount, bool isChambered )

protected

Callback to be used by eventHandler in PreparePlayerEntity_S.

Parameters

[in]	currentWeapon
[in]	currentMuzzle
[in]	magazine
[in]	ammoCount
[in]	isChambered

Definition at line 115 of file SCR_SpawnProtectionComponent.c.

OnPlayerDisconnected()

override 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 79 of file SCR_SpawnProtectionComponent.c.

OnPlayerSpawnFinalize_S()

override 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()

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