SCR_EntitySpawnerSlotComponent Interface Reference

Specifies slot to be used with nearby Entity Spawner Components. More...

Inheritance diagram for SCR_EntitySpawnerSlotComponent:

Public Member Functions
bool	IsEntityLabelInRange (notnull SCR_EntityLabelPointComponent labelComp)
	Returns true, if SCR_EntityLabelPointComponent is in range defined by m_fMaxRallyPointDistance.
void	SetRallyPoint (notnull SCR_EntityLabelPointComponent labelComp)
	Assign labelComponent to be used as Rally Point.
SCR_EntityLabelPointComponent	GetRallyPoint ()
	Get Assigned Rally point.
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)
	Get all ChimeraCharacters in slot.
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
void	~SCR_EntitySpawnerSlotComponent ()
override void	EOnFrame (IEntity owner, float timeSlice)
override void	_WB_AfterWorldUpdate (IEntity owner, float timeSlice)

Protected Member Functions
void	FillExcludedEntities ()
bool	CharacterFoundCallback (IEntity ent)
	Callback used in GetCharacterInSlot for query.
bool	FilterCharactersCallback (IEntity ent)
	Filtering used in GetCharacterInSlot for query.
bool	TraceCallback (IEntity ent)
	Callback for TracePosition in IsOccupied.
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)
void	DrawDebugShape ()

Protected Attributes
bool	m_bShowDebugShape
ref Shape	m_DebugShape
int	m_iDebugShapeColor = Color.CYAN
RplComponent	m_RplComponent
SCR_SpawnerSlotManager	m_SlotManager
SCR_EntityLabelPointComponent	m_RallyPointLabelComponent
ref array< ChimeraCharacter >	m_aCharacterArray
ref array< IEntity >	m_aExcludedEntities

Detailed Description

Specifies slot to be used with nearby Entity Spawner Components.

Constructor & Destructor Documentation

~SCR_EntitySpawnerSlotComponent()

void SCR_EntitySpawnerSlotComponent.~SCR_EntitySpawnerSlotComponent

(

)

Member Function Documentation

_WB_AfterWorldUpdate()

override void SCR_EntitySpawnerSlotComponent._WB_AfterWorldUpdate	(	IEntity	owner,
		float	timeSlice
	)

CharacterFoundCallback()

bool SCR_EntitySpawnerSlotComponent.CharacterFoundCallback ( IEntity  ent )

protected

Callback used in GetCharacterInSlot for query.

Adds living ChimeraCharacters into array.

Parameters

[in]

ent

Returns

always true

DrawDebugShape()

void SCR_EntitySpawnerSlotComponent.DrawDebugShape ( )

protected

EOnFrame()

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

EOnInit()

override void SCR_EntitySpawnerSlotComponent.EOnInit

(

IEntity

owner

)

FillExcludedEntities()

void SCR_EntitySpawnerSlotComponent.FillExcludedEntities ( )

protected

FilterCharactersCallback()

bool SCR_EntitySpawnerSlotComponent.FilterCharactersCallback ( IEntity  ent )

protected

Filtering used in GetCharacterInSlot for query.

Returns

GetCharactersInSlot()

int SCR_EntitySpawnerSlotComponent.GetCharactersInSlot

(

out array< ChimeraCharacter >

characterArray

)

Get all ChimeraCharacters in slot.

Returns count.

Parameters

[in]

characterArray

outs array containing all ChimeraCharacters in slot

GetRallyPoint()

SCR_EntityLabelPointComponent SCR_EntitySpawnerSlotComponent.GetRallyPoint

(

)

Get Assigned Rally point.

If there is none, Slot will try to find new one.

Returns

GetSlotType()

SCR_EEntitySpawnerSlotType SCR_EntitySpawnerSlotComponent.GetSlotType

(

)

Returns

IsEntityDestroyed()

bool SCR_EntitySpawnerSlotComponent.IsEntityDestroyed ( IEntity  entity )

protected

IsEntityLabelInRange()

bool SCR_EntitySpawnerSlotComponent.IsEntityLabelInRange

(

notnull SCR_EntityLabelPointComponent

labelComp

)

Returns true, if SCR_EntityLabelPointComponent is in range defined by m_fMaxRallyPointDistance.

Parameters

[in]

labelComp

Returns

IsOccupied()

bool SCR_EntitySpawnerSlotComponent.IsOccupied

(

)

Returns true, if slot is occupied.

MoveCharactersFromSlot()

void SCR_EntitySpawnerSlotComponent.MoveCharactersFromSlot

(

)

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

OnPostInit()

override void SCR_EntitySpawnerSlotComponent.OnPostInit

(

IEntity

owner

)

OnRallyPointUpdated()

void SCR_EntitySpawnerSlotComponent.OnRallyPointUpdated ( )

protected

Called when Rally Point gets moved.

RallyPointSearchCallback()

bool SCR_EntitySpawnerSlotComponent.RallyPointSearchCallback ( IEntity  ent )

protected

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

SetRallyPoint()

void SCR_EntitySpawnerSlotComponent.SetRallyPoint

(

notnull SCR_EntityLabelPointComponent

labelComp

)

Assign labelComponent to be used as Rally Point.

If component owner isn't in range, Rally point won't be assigned

Parameters

[in]

labelComp

TraceCallback()

bool SCR_EntitySpawnerSlotComponent.TraceCallback ( IEntity  ent )

protected

Callback for TracePosition in IsOccupied.

Can be overridden to implement custom conditions for checks in traces

Parameters

[in]

ent

Member Data Documentation

m_aCharacterArray

ref array<ChimeraCharacter> SCR_EntitySpawnerSlotComponent.m_aCharacterArray

protected

m_aExcludedEntities

ref array<IEntity> SCR_EntitySpawnerSlotComponent.m_aExcludedEntities

protected

m_bShowDebugShape

bool SCR_EntitySpawnerSlotComponent.m_bShowDebugShape

protected

m_DebugShape

ref Shape SCR_EntitySpawnerSlotComponent.m_DebugShape

protected

m_iDebugShapeColor

int SCR_EntitySpawnerSlotComponent.m_iDebugShapeColor = Color.CYAN

protected

m_RallyPointLabelComponent

SCR_EntityLabelPointComponent SCR_EntitySpawnerSlotComponent.m_RallyPointLabelComponent

protected

m_RplComponent

RplComponent SCR_EntitySpawnerSlotComponent.m_RplComponent

protected

m_SlotManager

SCR_SpawnerSlotManager SCR_EntitySpawnerSlotComponent.m_SlotManager

protected

---

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

• Game/Components/Spawner/SCR_EntitySpawnerSlotComponent.c