SCR_EntitySpawnerSlotComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_EntitySpawnerSlotComponentClass

Enumerations
enum	SCR_EEntitySpawnerSlotType {   INVALID = 0 , GROUP_SMALL = 1 << 0 , GROUP_MEDIUM = 1 << 1 , GROUP_BIG = 1 << 2 ,   VEHICLE_SMALL = 1 << 3 , VEHICLE_MEDIUM = 1 << 4 , VEHICLE_LARGE = 1 << 5 }

Functions
bool	IsEntityLabelInRange (notnull SCR_EntityLabelPointComponent labelComp)
void	SetRallyPoint (notnull SCR_EntityLabelPointComponent labelComp)
SCR_EntityLabelPointComponent	GetRallyPoint ()
SCR_EEntitySpawnerSlotType	GetSlotType ()
bool	IsOccupied ()
	Returns true, if slot is occupied.
void	MoveCharactersFromSlot ()
	Moves away all characters from slot, if there is suitable empty position in vicinity.
int	GetCharactersInSlot (out array< ChimeraCharacter > characterArray)
void	FillExcludedEntities ()
bool	CharacterFoundCallback (IEntity ent)
bool	FilterCharactersCallback (IEntity ent)
bool	TraceCallback (IEntity ent)
bool	IsEntityDestroyed (IEntity entity)
void	OnRallyPointUpdated ()
	Called when Rally Point gets moved.
bool	RallyPointSearchCallback (IEntity ent)
	Callback for Query in GetRallyPoint. Returns false, once SCR_EntityLabelPointComponent matching parameters was found (And thus ending query).
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
	Editable Mine.
void	~SCR_EntitySpawnerSlotComponent ()

Variables
SCR_EntitySpawnerSlotComponentClass	m_RplComponent
	Specifies slot to be used with nearby Entity Spawner Components.
SCR_SpawnerSlotManager	m_SlotManager
SCR_EntityLabelPointComponent	m_RallyPointLabelComponent
ref array< ChimeraCharacter >	m_aCharacterArray
ref array< IEntity >	m_aExcludedEntities

Enumeration Type Documentation

SCR_EEntitySpawnerSlotType

enum SCR_EEntitySpawnerSlotType

protected

Enumerator
INVALID
GROUP_SMALL
GROUP_MEDIUM
GROUP_BIG
VEHICLE_SMALL
VEHICLE_MEDIUM
VEHICLE_LARGE

Definition at line 464 of file SCR_EntitySpawnerSlotComponent.c.

Function Documentation

CharacterFoundCallback()

bool CharacterFoundCallback ( IEntity ent )

protected

Callback used in GetCharacterInSlot for query. Adds living ChimeraCharacters into array.

Parameters

[in]

ent

Returns

always true

Definition at line 277 of file SCR_EntitySpawnerSlotComponent.c.

FillExcludedEntities()

void FillExcludedEntities ( )

protected

Definition at line 247 of file SCR_EntitySpawnerSlotComponent.c.

FilterCharactersCallback()

bool FilterCharactersCallback ( IEntity ent )

protected

Filtering used in GetCharacterInSlot for query

Returns

Definition at line 292 of file SCR_EntitySpawnerSlotComponent.c.

GetCharactersInSlot()

int GetCharactersInSlot ( out array< ChimeraCharacter > characterArray )

protected

Get all ChimeraCharacters in slot. Returns count.

Parameters

[in]

characterArray

outs array containing all ChimeraCharacters in slot

Definition at line 229 of file SCR_EntitySpawnerSlotComponent.c.

GetRallyPoint()

SCR_EntityLabelPointComponent GetRallyPoint ( )

protected

Get Assigned Rally point. If there is none, Slot will try to find new one.

Returns

Definition at line 114 of file SCR_EntitySpawnerSlotComponent.c.

GetSlotType()

SCR_EEntitySpawnerSlotType GetSlotType ( )

protected

Returns

Definition at line 128 of file SCR_EntitySpawnerSlotComponent.c.

IsEntityDestroyed()

bool IsEntityDestroyed ( IEntity entity )

protected

Definition at line 333 of file SCR_EntitySpawnerSlotComponent.c.

IsEntityLabelInRange()

bool IsEntityLabelInRange ( notnull SCR_EntityLabelPointComponent labelComp )

protected

Returns true, if SCR_EntityLabelPointComponent is in range defined by m_fMaxRallyPointDistance

Parameters

[in]

labelComp

Returns

Definition at line 88 of file SCR_EntitySpawnerSlotComponent.c.

IsOccupied()

bool IsOccupied ( )

protected

Returns true, if slot is occupied.

Definition at line 139 of file SCR_EntitySpawnerSlotComponent.c.

MoveCharactersFromSlot()

void MoveCharactersFromSlot ( )

protected

Moves away all characters from slot, if there is suitable empty position in vicinity.

Definition at line 165 of file SCR_EntitySpawnerSlotComponent.c.

OnRallyPointUpdated()

void OnRallyPointUpdated ( )

protected

Called when Rally Point gets moved.

Definition at line 344 of file SCR_EntitySpawnerSlotComponent.c.

RallyPointSearchCallback()

bool RallyPointSearchCallback ( IEntity ent )

protected

Callback for Query in GetRallyPoint. Returns false, once SCR_EntityLabelPointComponent matching parameters was found (And thus ending query).

Definition at line 356 of file SCR_EntitySpawnerSlotComponent.c.

SetRallyPoint()

void SetRallyPoint ( notnull SCR_EntityLabelPointComponent labelComp )

protected

Assign labelComponent to be used as Rally Point. If component owner isn't in range, Rally point won't be assigned

Parameters

[in]

labelComp

Definition at line 102 of file SCR_EntitySpawnerSlotComponent.c.

TraceCallback()

bool TraceCallback ( IEntity ent )

protected

Callback for TracePosition in IsOccupied. Can be overridden to implement custom conditions for checks in traces

Parameters

[in]

ent

Definition at line 303 of file SCR_EntitySpawnerSlotComponent.c.

~SCR_EntitySpawnerSlotComponent()

void ~SCR_EntitySpawnerSlotComponent ( )

protected

Definition at line 407 of file SCR_EntitySpawnerSlotComponent.c.

Variable Documentation

m_aCharacterArray

ref array<ChimeraCharacter> m_aCharacterArray

protected

Definition at line 81 of file SCR_EntitySpawnerSlotComponent.c.

m_aExcludedEntities

ref array<IEntity> m_aExcludedEntities

protected

Definition at line 82 of file SCR_EntitySpawnerSlotComponent.c.

m_RallyPointLabelComponent

SCR_EntityLabelPointComponent m_RallyPointLabelComponent

protected

Definition at line 80 of file SCR_EntitySpawnerSlotComponent.c.

m_RplComponent

SCR_EntitySpawnerSlotComponentClass m_RplComponent

Specifies slot to be used with nearby Entity Spawner Components.

m_SlotManager

SCR_SpawnerSlotManager m_SlotManager

protected

Definition at line 79 of file SCR_EntitySpawnerSlotComponent.c.