SCR_FiringRangeManager Interface Reference

Inheritance diagram for SCR_FiringRangeManager:

Public Member Functions
void	ClearPlayerScore (int playerID)
void	CountPlayerScore (int scoringPlayer, int scorePoints)
void	SetPlayerScoreMax (int playerID, float maxScore)
void	UpdateScoreboardData ()
int	GetHighScoreInfo (array< SCR_PlayerScoreInfoFiringRange > infos)
bool	ScoreChanged ()
bool	ScoreMaxChanged ()
bool	NameChanged ()
bool	PlayerCountChangedInArea ()
override void	EOnFrame (IEntity owner, float timeSlice)
override void	OnActivate (IEntity ent)
	callback - activation - occurs when and entity which fulfills the filter definitions enters the Trigger
override void	OnDeactivate (IEntity ent)
	callback - deactivation - occurs when and entity which was activated (OnActivate) leaves the Trigger
bool	IsProxy ()
	Return if is proxy or not.
void	GenerateRows ()
override void	EOnInit (IEntity owner)
void	RegisterFiringRangeController (IEntity firingLineController)
	Register all firing range controllers into one array This is happening at the beginning of scenario.
void	RemoveAssignedPlayerFromFireline (int playerID)
	Remove assigned firing line and targets from player if he is killed or if he disconects.
int	GetPlayerID (IEntity ent)
	Get player ID.
void	RegisterPlayerInArea (int playerID)
	Add the player into the array of players in firing range area.
void	RemovePlayerFromArea (int playerID)
	Remove the player from the array of players in firing range area.
bool	IsPlayerInFiringRangeArea (int playerID)
	Return true if the ID is in the list of players in firing range area. If not, returns false.
SCR_FiringRangeManager	GetInstance ()
	Get manager instance.
Widget	GetRootWidget ()
	Get m_wRoot widget.
string	GetPlayerName (IEntity ent)
	Get player name.
void	SpawnCommunicationPrefab (int playerID)
void	AddIndicator (vector localCoordOfHit, vector localVectorOfHit, IEntity pOwnerEntity)
void	RemoveIndicators (RplId controllerReplicationId)
void	ControllerLight (notnull IEntity firingRangeController, ControllerLightType light, bool mode)
void	SetControllerCounter (notnull IEntity firingRangeController, EControlerSection type, int value)
void	RpcAsk_AddIndicator (RplId controllerReplicationId, vector localCoordOfHit, vector localVectorOfHit)
void	SCR_FiringRangeManager (IEntitySource src, IEntity parent)
void	~SCR_FiringRangeManager ()
Public Member Functions inherited from ScriptedGameTriggerEntity
bool	ScriptedEntityFilterForQuery (IEntity ent)
	Override this method in inherited class to define a new filter. This base filter will not be used unless overridden!
Public Member Functions inherited from BaseGameTriggerEntity
ScriptInvoker	GetOnQueryFinished ()
proto external bool	QueryEntityInside (notnull IEntity ent)
proto external void	QueryEntitiesInside ()
proto external bool	DefaultEntityFilterForQuery (IEntity ent)
proto external int	GetEntitiesInside (out notnull array< IEntity > outEntities)
	Get the entities inside the triggers.
proto external void	SetSphereRadius (float radius)
proto external float	GetSphereRadius ()
proto external void	SetUpdateRate (float updateRate)
proto external float	GetUpdateRate ()
proto external void	EnablePeriodicQueries (bool enable)
proto external bool	IsPeriodicQueriesEnabled ()
proto external void	AddFilterName (string name)
	Add a name to the filter.
proto external bool	RemoveFilterName (string name)
	Remove a name from the filter.
proto external void	AddClassType (TypeName classType)
	Add a class type to the filter.
proto external bool	RemoveClassType (TypeName classType)
	Remove a class type from the filter.
proto external void	AddPrefabFilter (PrefabFilter prefabFilter)
	Add a prefab filter to the filters.
proto external bool	RemovePrefabFilter (PrefabFilter prefabFilter)
	Remove a prefab filter from the filters.
proto external EQueryEntitiesFlags	GetTraceMask ()
	Get flag(s) from the traces done by the the trigger.
proto external void	SetTraceMask (EQueryEntitiesFlags flags)
	Sets trace mask.
proto external void	ClearTraceMask (EQueryEntitiesFlags flags)
	Clears trace mask.

Static Public Member Functions
static SCR_FiringRangeManager	GetMainManagerInstance ()
	Get MAIN manager instance.

Protected Member Functions
void	RpcAsk_RemoveIndicators (RplId controllerReplicationId)
void	RpcAsk_ClearWidgets (int playerID)
void	RpcAsk_ControllerLight (RplId controllerReplicationId, ControllerLightType light, bool mode)
void	RpcAsk_SetControllerCounter (RplId controllerReplicationId, EControlerSection type, int value)
bool	CheckMasterOnlyMethod (string methodName)
Protected Member Functions inherited from ScriptedGameTriggerEntity
void	OnInit (IEntity owner)
void	OnFrame (IEntity owner, float timeSlice)
Protected Member Functions inherited from BaseGameTriggerEntity
void	OnQueryFinished (bool bIsEmpty)
	callback - query finished - occurs when the current query finished being processd and has updated results

Protected Attributes
Widget	m_wRoot
SCR_FiringRangeManager	m_FiringRangeManagerInstance
Protected Attributes inherited from BaseGameTriggerEntity
ref ScriptInvoker	Event_OnQueryFinished = new ScriptInvoker()

Static Protected Attributes
static SCR_FiringRangeManager	s_FiringRangeManagerMain

Constructor & Destructor Documentation

SCR_FiringRangeManager()

void SCR_FiringRangeManager.SCR_FiringRangeManager	(	IEntitySource	src,
		IEntity	parent )

~SCR_FiringRangeManager()

void SCR_FiringRangeManager.~SCR_FiringRangeManager

(

)

Member Function Documentation

AddIndicator()

void SCR_FiringRangeManager.AddIndicator	(	vector	localCoordOfHit,
		vector	localVectorOfHit,
		IEntity	pOwnerEntity )

CheckMasterOnlyMethod()

bool SCR_FiringRangeManager.CheckMasterOnlyMethod ( string methodName )

protected

ClearPlayerScore()

void SCR_FiringRangeManager.ClearPlayerScore

(

int

playerID

)

ControllerLight()

void SCR_FiringRangeManager.ControllerLight	(	notnull IEntity	firingRangeController,
		ControllerLightType	light,
		bool	mode )

CountPlayerScore()

void SCR_FiringRangeManager.CountPlayerScore	(	int	scoringPlayer,
		int	scorePoints )

EOnFrame()

override void SCR_FiringRangeManager.EOnFrame	(	IEntity	owner,
		float	timeSlice )

EOnInit()

override void SCR_FiringRangeManager.EOnInit

(

IEntity

owner

)

GenerateRows()

void SCR_FiringRangeManager.GenerateRows

(

)

GetHighScoreInfo()

int SCR_FiringRangeManager.GetHighScoreInfo

(

array< SCR_PlayerScoreInfoFiringRange >

infos

)

GetInstance()

SCR_FiringRangeManager SCR_FiringRangeManager.GetInstance

(

)

Get manager instance.

GetMainManagerInstance()

static SCR_FiringRangeManager SCR_FiringRangeManager.GetMainManagerInstance ( )

static

Get MAIN manager instance.

GetPlayerID()

int SCR_FiringRangeManager.GetPlayerID

(

IEntity

ent

)

Get player ID.

GetPlayerName()

string SCR_FiringRangeManager.GetPlayerName

(

IEntity

ent

)

Get player name.

GetRootWidget()

Widget SCR_FiringRangeManager.GetRootWidget

(

)

Get m_wRoot widget.

IsPlayerInFiringRangeArea()

bool SCR_FiringRangeManager.IsPlayerInFiringRangeArea

(

int

playerID

)

Return true if the ID is in the list of players in firing range area. If not, returns false.

IsProxy()

bool SCR_FiringRangeManager.IsProxy

(

)

Return if is proxy or not.

NameChanged()

bool SCR_FiringRangeManager.NameChanged

(

)

OnActivate()

override void SCR_FiringRangeManager.OnActivate

(

IEntity

ent

)

callback - activation - occurs when and entity which fulfills the filter definitions enters the Trigger

Implements BaseGameTriggerEntity.

OnDeactivate()

override void SCR_FiringRangeManager.OnDeactivate

(

IEntity

ent

)

callback - deactivation - occurs when and entity which was activated (OnActivate) leaves the Trigger

Implements BaseGameTriggerEntity.

PlayerCountChangedInArea()

bool SCR_FiringRangeManager.PlayerCountChangedInArea

(

)

RegisterFiringRangeController()

void SCR_FiringRangeManager.RegisterFiringRangeController

(

IEntity

firingLineController

)

Register all firing range controllers into one array This is happening at the beginning of scenario.

So we are able to remove assigned fireline from player in moment he disconects or is killed.

RegisterPlayerInArea()

void SCR_FiringRangeManager.RegisterPlayerInArea

(

int

playerID

)

Add the player into the array of players in firing range area.

RemoveAssignedPlayerFromFireline()

void SCR_FiringRangeManager.RemoveAssignedPlayerFromFireline

(

int

playerID

)

Remove assigned firing line and targets from player if he is killed or if he disconects.

RemoveIndicators()

void SCR_FiringRangeManager.RemoveIndicators

(

RplId

controllerReplicationId

)

RemovePlayerFromArea()

void SCR_FiringRangeManager.RemovePlayerFromArea

(

int

playerID

)

Remove the player from the array of players in firing range area.

RpcAsk_AddIndicator()

void SCR_FiringRangeManager.RpcAsk_AddIndicator	(	RplId	controllerReplicationId,
		vector	localCoordOfHit,
		vector	localVectorOfHit )

RpcAsk_ClearWidgets()

void SCR_FiringRangeManager.RpcAsk_ClearWidgets ( int playerID )

protected

RpcAsk_ControllerLight()

void SCR_FiringRangeManager.RpcAsk_ControllerLight ( RplId controllerReplicationId, ControllerLightType light, bool mode )

protected

RpcAsk_RemoveIndicators()

void SCR_FiringRangeManager.RpcAsk_RemoveIndicators ( RplId controllerReplicationId )

protected

RpcAsk_SetControllerCounter()

void SCR_FiringRangeManager.RpcAsk_SetControllerCounter ( RplId controllerReplicationId, EControlerSection type, int value )

protected

ScoreChanged()

bool SCR_FiringRangeManager.ScoreChanged

(

)

ScoreMaxChanged()

bool SCR_FiringRangeManager.ScoreMaxChanged

(

)

SetControllerCounter()

void SCR_FiringRangeManager.SetControllerCounter	(	notnull IEntity	firingRangeController,
		EControlerSection	type,
		int	value )

SetPlayerScoreMax()

void SCR_FiringRangeManager.SetPlayerScoreMax	(	int	playerID,
		float	maxScore )

SpawnCommunicationPrefab()

void SCR_FiringRangeManager.SpawnCommunicationPrefab

(

int

playerID

)

UpdateScoreboardData()

void SCR_FiringRangeManager.UpdateScoreboardData

(

)

Member Data Documentation

m_FiringRangeManagerInstance

SCR_FiringRangeManager SCR_FiringRangeManager.m_FiringRangeManagerInstance

protected

m_wRoot

Widget SCR_FiringRangeManager.m_wRoot

protected

s_FiringRangeManagerMain

SCR_FiringRangeManager SCR_FiringRangeManager.s_FiringRangeManagerMain

staticprotected

---

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

• Game/FiringRange/SCR_FiringRangeManager.c