SCR_CampaignFactionCommanderPlayerComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_CampaignFactionCommanderPlayerComponentClass
	Handles interactions for the faction Commander role in Conflict. Should be attached to player controller. More...

Functions
SCR_CommanderGraphLinesData	GetGraphLinesData ()
override void	OnMapOpen (MapConfiguration config)
override void	OnMapClose (MapConfiguration config)
void	OnBaseHovered (SCR_CampaignMilitaryBaseComponent base)
SCR_CampaignMilitaryBaseComponent	GetHoveredBase ()
void	OnRadialMenuBeforeOpen ()
	Called each time the radial menu is before open in the map.
override void	ClearRadialMenu ()
override void	OnEntryHovered (SCR_SelectionMenuEntry entry, int id)
	Triggered when a radial menu entry is hovered on.
void	LinkBaseWithGroup (notnull SCR_AIGroup group)
	Draw a map link from a base to a group leader.
void	ClearAllLinks ()
	Remove all existing map links.
bool	IsValidRequest (SCR_CampaignMilitaryBaseComponent base)
void	CreateCampaignMilitaryBaseTask (ResourceName taskPrefab, SCR_AIGroup group, int playerId, vector positionOffset=vector.Zero)
void	RpcAsk_CreateCampaignMilitaryBaseTask (ResourceName taskPrefab, int assigneeId, int factionIndex, int playerId, int baseCallsign, vector positionOffset)
void	RpcAsk_CheatCommander (int playerId)
void	SetSuppliesLimit (notnull SCR_CampaignMilitaryBaseComponent base, float value)
void	RpcAsk_SetSuppliesLimit (int baseCallsign, float value)
void	SetReservedSupplyAmount (notnull SCR_CampaignMilitaryBaseComponent base, float value)
void	RpcAsk_SetReservedSupplyAmount (int baseCallsign, float value)
void	SetSupplyRequestExecutionPriority (notnull SCR_CampaignMilitaryBaseComponent base, int priority)
void	RpcAsk_SetSupplyRequestExecutionPriority (int baseCallsign, int priority)

Variables
SCR_CampaignFactionCommanderPlayerComponentClass	m_HoveredBase
SCR_CampaignMilitaryBaseComponent	m_CurrentHoveredBase
bool	m_bMustClearHoveredBase
ref array< MapLink >	m_aMapLinks = {}

Function Documentation

ClearAllLinks()

void ClearAllLinks ( )

protected

Remove all existing map links.

Definition at line 198 of file SCR_CampaignFactionCommanderPlayerComponent.c.

ClearRadialMenu()

override void ClearRadialMenu ( )

protected

Definition at line 108 of file SCR_CampaignFactionCommanderPlayerComponent.c.

CreateCampaignMilitaryBaseTask()

void CreateCampaignMilitaryBaseTask ( ResourceName taskPrefab, SCR_AIGroup group, int playerId, vector positionOffset = vector.Zero )

protected

Create campaign military base task

Parameters

[in]	taskPrefab
[in]	group
[in]	playerId
[in]	handler
[in]	positionOffset

Definition at line 242 of file SCR_CampaignFactionCommanderPlayerComponent.c.

GetGraphLinesData()

SCR_CommanderGraphLinesData GetGraphLinesData ( )

protected

Definition at line 33 of file SCR_CampaignFactionCommanderPlayerComponent.c.

GetHoveredBase()

SCR_CampaignMilitaryBaseComponent GetHoveredBase ( )

protected

Definition at line 92 of file SCR_CampaignFactionCommanderPlayerComponent.c.

IsValidRequest()

bool IsValidRequest ( SCR_CampaignMilitaryBaseComponent base )

protected

Definition at line 222 of file SCR_CampaignFactionCommanderPlayerComponent.c.

LinkBaseWithGroup()

void LinkBaseWithGroup ( notnull SCR_AIGroup group )

protected

Draw a map link from a base to a group leader.

Definition at line 153 of file SCR_CampaignFactionCommanderPlayerComponent.c.

OnBaseHovered()

void OnBaseHovered ( SCR_CampaignMilitaryBaseComponent base )

protected

Definition at line 79 of file SCR_CampaignFactionCommanderPlayerComponent.c.

OnEntryHovered()

override void OnEntryHovered ( SCR_SelectionMenuEntry entry, int id )

protected

Triggered when a radial menu entry is hovered on.

Definition at line 123 of file SCR_CampaignFactionCommanderPlayerComponent.c.

OnMapClose()

override void OnMapClose ( MapConfiguration config )

protected

Definition at line 65 of file SCR_CampaignFactionCommanderPlayerComponent.c.

OnMapOpen()

override void OnMapOpen ( MapConfiguration config )

protected

Definition at line 49 of file SCR_CampaignFactionCommanderPlayerComponent.c.

OnRadialMenuBeforeOpen()

void OnRadialMenuBeforeOpen ( )

protected

Called each time the radial menu is before open in the map.

Definition at line 99 of file SCR_CampaignFactionCommanderPlayerComponent.c.

RpcAsk_CheatCommander()

void RpcAsk_CheatCommander ( int playerId )

protected

Definition at line 358 of file SCR_CampaignFactionCommanderPlayerComponent.c.

RpcAsk_CreateCampaignMilitaryBaseTask()

void RpcAsk_CreateCampaignMilitaryBaseTask ( ResourceName taskPrefab, int assigneeId, int factionIndex, int playerId, int baseCallsign, vector positionOffset )

protected

Definition at line 262 of file SCR_CampaignFactionCommanderPlayerComponent.c.

RpcAsk_SetReservedSupplyAmount()

void RpcAsk_SetReservedSupplyAmount ( int baseCallsign, float value )

protected

Definition at line 405 of file SCR_CampaignFactionCommanderPlayerComponent.c.

RpcAsk_SetSuppliesLimit()

void RpcAsk_SetSuppliesLimit ( int baseCallsign, float value )

protected

Definition at line 385 of file SCR_CampaignFactionCommanderPlayerComponent.c.

RpcAsk_SetSupplyRequestExecutionPriority()

void RpcAsk_SetSupplyRequestExecutionPriority ( int baseCallsign, int priority )

protected

Definition at line 425 of file SCR_CampaignFactionCommanderPlayerComponent.c.

SetReservedSupplyAmount()

void SetReservedSupplyAmount ( notnull SCR_CampaignMilitaryBaseComponent base, float value )

protected

Sets the reserved supply amount for a specified campaign military base.

Parameters

[in]	base	Reference to the campaign military base for which the reserved supply amount is set.
[in]	value	The new value to assign as the reserved supply amount for the base.

Definition at line 398 of file SCR_CampaignFactionCommanderPlayerComponent.c.

SetSuppliesLimit()

void SetSuppliesLimit ( notnull SCR_CampaignMilitaryBaseComponent base, float value )

protected

Sets the supply limit for a given campaign military base.

Parameters

[in]	base	Reference to the campaign military base whose supply limit will be set.
[in]	value	The new supply limit to assign to the base.

Definition at line 378 of file SCR_CampaignFactionCommanderPlayerComponent.c.

SetSupplyRequestExecutionPriority()

void SetSupplyRequestExecutionPriority ( notnull SCR_CampaignMilitaryBaseComponent base, int priority )

protected

Sets the supply request execution priority for a specified campaign military base.

Parameters

[in]	base	Reference to the campaign military base whose supply request priority will be set.
[in]	priority	The new execution priority to assign to the base.

Definition at line 418 of file SCR_CampaignFactionCommanderPlayerComponent.c.

Variable Documentation

m_aMapLinks

ref array<MapLink> m_aMapLinks = {}

protected

Definition at line 22 of file SCR_CampaignFactionCommanderPlayerComponent.c.

m_bMustClearHoveredBase

bool m_bMustClearHoveredBase

protected

Definition at line 20 of file SCR_CampaignFactionCommanderPlayerComponent.c.

m_CurrentHoveredBase

SCR_CampaignMilitaryBaseComponent m_CurrentHoveredBase

protected

Definition at line 18 of file SCR_CampaignFactionCommanderPlayerComponent.c.

m_HoveredBase

SCR_CampaignFactionCommanderPlayerComponentClass m_HoveredBase