SCR_SpawnerRequestComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_SpawnerRequestComponentClass

Functions
SCR_SpawnerRequestComponentClass ScriptGameComponentClass	RplProp ()] protected int m_iQueuedAIs
	Used for handling entity spawning requests for SCR_CatalogEntitySpawnerComponent and inherited classes, attached to SCR_PlayerController. More...
void	RequestPlayerTeleport (vector position)
protected void	RPC_DoTeleportPlayer (vector position)
void	AddQueuedAI (int value)
	Add (or substract) AI to quenue. More...
int	GetQueuedAIs ()
void	EnableSpawning (notnull SCR_DefenderSpawnerComponent defenderSpawnerComp, bool enable, int playerID)
protected void	RPC_DoEnableSpawning (RplId defenderSpawnerID, bool enable, int playerID)
void	RequestCatalogEntitySpawn (int index, notnull SCR_CatalogEntitySpawnerComponent spawnerComponent, IEntity user, SCR_EntitySpawnerSlotComponent slot)
protected void	RPC_DoRequestCatalogSpawn (RplId rplCompId, int index, int userId, RplId slotRplId)
void	SendPlayerFeedback (int msgID, int assetIndex, int catalogType=-1)
protected void	RPC_DoPlayerFeedbackImpl (int msgID, int assetIndex, int catalogType)
	Show notification about request result to the requester. More...
string	GetMessageStringForCatalogType (EEntityCatalogType catalogType)
override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...

Function Documentation

AddQueuedAI()

void AddQueuedAI

(

int

value

)

Add (or substract) AI to quenue.

Definition at line 30 of file SCR_SpawnerRequestComponent.c.

EnableSpawning()

void 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

Definition at line 51 of file SCR_SpawnerRequestComponent.c.

GetMessageStringForCatalogType()

string GetMessageStringForCatalogType

(

EEntityCatalogType

catalogType

)

Parameters

[in]

catalogType

catalog type from enum.

Returns

string ID to be used in succesful request feedbacks.

Definition at line 196 of file SCR_SpawnerRequestComponent.c.

GetQueuedAIs()

int GetQueuedAIs

(

)

Returns

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

Definition at line 41 of file SCR_SpawnerRequestComponent.c.

RequestCatalogEntitySpawn()

void 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

Definition at line 89 of file SCR_SpawnerRequestComponent.c.

RequestPlayerTeleport()

void RequestPlayerTeleport

(

vector

position

)

Parameters

[in]

position

Definition at line 16 of file SCR_SpawnerRequestComponent.c.

RPC_DoEnableSpawning()

protected void RPC_DoEnableSpawning	(	RplId	defenderSpawnerID,
		bool	enable,
		int	playerID
	)

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

Definition at line 70 of file SCR_SpawnerRequestComponent.c.

RPC_DoPlayerFeedbackImpl()

protected void RPC_DoPlayerFeedbackImpl	(	int	msgID,
		int	assetIndex,
		int	catalogType
	)

Show notification about request result to the requester.

Definition at line 155 of file SCR_SpawnerRequestComponent.c.

RPC_DoRequestCatalogSpawn()

protected void RPC_DoRequestCatalogSpawn	(	RplId	rplCompId,
		int	index,
		int	userId,
		RplId	slotRplId
	)

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

Definition at line 117 of file SCR_SpawnerRequestComponent.c.

RPC_DoTeleportPlayer()

protected void RPC_DoTeleportPlayer

(

vector

position

)

Definition at line 23 of file SCR_SpawnerRequestComponent.c.

RplProp()

SCR_SpawnerRequestComponentClass ScriptGameComponentClass RplProp

(

)

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

SendPlayerFeedback()

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

Send notification to player

Parameters

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

Definition at line 147 of file SCR_SpawnerRequestComponent.c.