SCR_SpawnerRequestComponent Interface Reference

Used for handling entity spawning requests for SCR_CatalogEntitySpawnerComponent and inherited classes, attached to SCR_PlayerController. More...

Inheritance diagram for SCR_SpawnerRequestComponent:

Public Member Functions
void	RequestPlayerTeleport (vector position)
void	AddQueuedAI (int value)
	Add (or substract) AI to quenue.
int	GetQueuedAIs ()
void	EnableSpawning (notnull SCR_DefenderSpawnerComponent defenderSpawnerComp, bool enable, int playerID)
	Defender spawner request from SCR_EnableDefendersAction.
void	RequestCatalogEntitySpawn (int index, notnull SCR_CatalogEntitySpawnerComponent spawnerComponent, IEntity user, SCR_EntitySpawnerSlotComponent slot)
	Entity spawn request from SCR_SpawnEntityUserAction.
void	SendPlayerFeedback (int msgID, int assetIndex, int catalogType=-1)
	Send notification to player.
string	GetMessageStringForCatalogType (EEntityCatalogType catalogType)
override void	OnPostInit (IEntity owner)

Static Public Attributes
static const float	NOTIFICATION_DURATION = 2

Protected Member Functions
void	RPC_DoTeleportPlayer (vector position)
void	RPC_DoEnableSpawning (RplId defenderSpawnerID, bool enable, int playerID)
	Performs request on server.
void	RPC_DoRequestCatalogSpawn (RplId rplCompId, int index, int userId, RplId slotRplId)
	Performs request on server.
void	RPC_DoPlayerFeedbackImpl (int msgID, int assetIndex, int catalogType)
	Show notification about request result to the requester.

Protected Attributes
int	m_iQueuedAIs

Detailed Description

Used for handling entity spawning requests for SCR_CatalogEntitySpawnerComponent and inherited classes, attached to SCR_PlayerController.

Member Function Documentation

AddQueuedAI()

void SCR_SpawnerRequestComponent.AddQueuedAI

(

int

value

)

Add (or substract) AI to quenue.

EnableSpawning()

void SCR_SpawnerRequestComponent.EnableSpawning	(	notnull SCR_DefenderSpawnerComponent	defenderSpawnerComp,
		bool	enable,
		int	playerID
	)

Defender spawner request from SCR_EnableDefendersAction.

Parameters

[in]	defenderSpawnerComp	DefenderSpawner component to be handled
[in]	enable	to enable or disable unit spawning
[in]	playerID	id of player requesting the spawn

GetMessageStringForCatalogType()

string SCR_SpawnerRequestComponent.GetMessageStringForCatalogType

(

EEntityCatalogType

catalogType

)

Parameters

[in]

catalogType

catalog type from enum.

Returns

string ID to be used in succesful request feedbacks.

GetQueuedAIs()

int SCR_SpawnerRequestComponent.GetQueuedAIs

(

)

Returns

queued requested AI units count that are currently on the way to rally point and not yet in player's group

OnPostInit()

override void SCR_SpawnerRequestComponent.OnPostInit

(

IEntity

owner

)

RequestCatalogEntitySpawn()

void SCR_SpawnerRequestComponent.RequestCatalogEntitySpawn	(	int	index,
		notnull SCR_CatalogEntitySpawnerComponent	spawnerComponent,
		IEntity	user,
		SCR_EntitySpawnerSlotComponent	slot
	)

Entity spawn request from SCR_SpawnEntityUserAction.

Parameters

[in]	index	item index in User Action
[in]	spawnerComponent	SpawnerComponent on which should be entity spawned
[in]	user	the user requesting spawn
[in]	slot	on which should be entity spawned

RequestPlayerTeleport()

void SCR_SpawnerRequestComponent.RequestPlayerTeleport

(

vector

position

)

Parameters

[in]

position

RPC_DoEnableSpawning()

void SCR_SpawnerRequestComponent.RPC_DoEnableSpawning ( RplId  defenderSpawnerID, bool  enable, int  playerID  )

protected

Performs request on server.

Parameters

[in]	rplCompId	RplComp id of entity with SCR_DefenderSpawnerComponent
[in]	index	item index in User Faction
[in]	playerID	id of player requesting the spawn

RPC_DoPlayerFeedbackImpl()

void SCR_SpawnerRequestComponent.RPC_DoPlayerFeedbackImpl ( int  msgID, int  assetIndex, int  catalogType  )

protected

Show notification about request result to the requester.

RPC_DoRequestCatalogSpawn()

void SCR_SpawnerRequestComponent.RPC_DoRequestCatalogSpawn ( RplId  rplCompId, int  index, int  userId, RplId  slotRplId  )

protected

Performs request on server.

Parameters

[in]	rplCompId	RplComp id of entity with spawner component
[in]	index	item index in User Action
[in]	userId	id of user requesting spawn
[in]	slotRplId	slot RplID OPTIONAL

RPC_DoTeleportPlayer()

void SCR_SpawnerRequestComponent.RPC_DoTeleportPlayer ( vector  position )

protected

SendPlayerFeedback()

void SCR_SpawnerRequestComponent.SendPlayerFeedback	(	int	msgID,
		int	assetIndex,
		int	catalogType = -1
	)

Send notification to player.

Parameters

[in]	msgID
[in]	assetIndex
[in]	catalogType

Member Data Documentation

m_iQueuedAIs

int SCR_SpawnerRequestComponent.m_iQueuedAIs

protected

NOTIFICATION_DURATION

const float SCR_SpawnerRequestComponent.NOTIFICATION_DURATION = 2

static

---

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

• Game/Components/Spawner/CatalogSpawner/SCR_SpawnerRequestComponent.c