SCR_CaptureAndHoldSpawnArea.c File Reference

Go to the source code of this file.

Classes
class	SCR_CaptureAndHoldSpawnAreaClass

Functions
SCR_CaptureAndHoldSpawnAreaClass SCR_SpawnAreaClass	Attribute ("#AR-CAH-SpawnArea_LocalPlayer_Alert_Title", UIWidgets.EditBox, "The string that is shown as the main message to the local player upon entering this area as enemy faction.")] protected LocalizedString m_sLocalPlayerAlertTitle
override void	OnInit (IEntity owner)
	Initializes and registers this area into parent manager.
override void	OnFrame (IEntity owner, float timeSlice)
override event void	OnCharacterEnter (IEntity character, bool isFriendly)
	Called when a character enters this area.
event void	OnLocalPlayerEnter (IEntity character, bool isFriendly)
	Called when the local character enters this area.
override event void	OnCharacterExit (IEntity character, bool isFriendly)
	Called when a character leaves this area.
event void	OnLocalPlayerExit (IEntity character, bool isFriendly)
	Called when the local character leaves this area.
void	~SCR_CaptureAndHoldSpawnArea ()
	Unregister self from parent manager.

Variables
LocalizedString	m_sLocalPlayerAlertText
float	m_fPenaltyTime
IEntity	m_pLastLocalEntity
	Last entity stored as the "local offender" or null if none.
ref map< IEntity, float >	m_mTimeStamps
	Authority map for time spent in the trigger for individual entities (offending ones).
RplComponent	m_pRplComponent
	RplComponent attached to this are or null if none.

Function Documentation

Attribute()

SCR_CaptureAndHoldSpawnAreaClass SCR_SpawnAreaClass Attribute	(	"#AR-CAH-SpawnArea_LocalPlayer_Alert_Title"	,
		UIWidgets.	EditBox,
		"The string that is shown as the main message to the local player upon entering this area as enemy faction."	)

This area trigger detects enemies not belonging to assigned faction, and raises callbacks which allow penalizing abusive behaviour.

OnCharacterEnter()

override event void OnCharacterEnter ( IEntity character, bool isFriendly )

protected

Called when a character enters this area.

Definition at line 106 of file SCR_CaptureAndHoldSpawnArea.c.

OnCharacterExit()

override event void OnCharacterExit ( IEntity character, bool isFriendly )

protected

Called when a character leaves this area.

Definition at line 147 of file SCR_CaptureAndHoldSpawnArea.c.

OnLocalPlayerEnter()

event void OnLocalPlayerEnter ( IEntity character, bool isFriendly )

protected

Called when the local character enters this area.

Definition at line 128 of file SCR_CaptureAndHoldSpawnArea.c.

OnLocalPlayerExit()

event void OnLocalPlayerExit ( IEntity character, bool isFriendly )

protected

Called when the local character leaves this area.

Definition at line 172 of file SCR_CaptureAndHoldSpawnArea.c.

~SCR_CaptureAndHoldSpawnArea()

void ~SCR_CaptureAndHoldSpawnArea ( )

protected

Unregister self from parent manager.

Definition at line 187 of file SCR_CaptureAndHoldSpawnArea.c.

Variable Documentation

m_fPenaltyTime

float m_fPenaltyTime

protected

Definition at line 17 of file SCR_CaptureAndHoldSpawnArea.c.

m_mTimeStamps

ref map<IEntity, float> m_mTimeStamps

protected

Authority map for time spent in the trigger for individual entities (offending ones).

Definition at line 23 of file SCR_CaptureAndHoldSpawnArea.c.

m_pLastLocalEntity

IEntity m_pLastLocalEntity

protected

Last entity stored as the "local offender" or null if none.

Definition at line 20 of file SCR_CaptureAndHoldSpawnArea.c.

m_pRplComponent

RplComponent m_pRplComponent

protected

RplComponent attached to this are or null if none.

Definition at line 26 of file SCR_CaptureAndHoldSpawnArea.c.

m_sLocalPlayerAlertText

LocalizedString m_sLocalPlayerAlertText

protected

Definition at line 14 of file SCR_CaptureAndHoldSpawnArea.c.