SCR_FactionCommanderConflictBaseMenuHandler Interface Reference

Inheritance diagram for SCR_FactionCommanderConflictBaseMenuHandler:

Public Member Functions
bool	CanCreateObjectiveEntryBeShown (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity)
bool	CanCreateObjectiveEntryBeSelected (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity, out string disabledText="")
override bool	CanEntryBeShown (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity)
override bool	CanEntryBeSelected (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity, out string disabledText="")
override bool	CanGroupEntryBeSelected (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity, SCR_AIGroup group, out string disabledText="")
Public Member Functions inherited from SCR_FactionCommanderBaseTaskMenuHandler
TypeName	GetTaskPrefabClassTypename ()
override bool	CanGroupEntryBeShown (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity, SCR_AIGroup group)
Public Member Functions inherited from SCR_FactionCommanderBaseMenuHandler
void	SetMenuEntry (SCR_FactionCommanderMenuEntry menuEntry)
SCR_FactionCommanderMenuEntry	GetMenuEntry ()
bool	CanQuickEntryBeShown (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity)
void	OnEntryHovered (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity)
void	OnCommandIssued (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity, SCR_AIGroup group)

Protected Member Functions
SCR_CampaignFactionCommanderPlayerComponent	GetLocalCampaignCommanderComponent ()
SCR_CampaignMilitaryBaseComponent	GetHoveredBase ()
SCR_Task	GetTaskOnBase (SCR_CampaignMilitaryBaseComponent targetBase, Faction targetFaction, TypeName taskClass)
SCR_Task	GetTask (IEntity hoveredEntity, notnull Faction faction, TypeName taskClass)
SCR_Task	GetTaskOnHoveredBase (notnull Faction faction, TypeName taskClass)
bool	CanCampaignGroupEntryBeSelected (notnull Faction faction, IEntity hoveredEntity, notnull SCR_AIGroup group, TypeName taskClass)
Protected Member Functions inherited from SCR_FactionCommanderBaseTaskMenuHandler
ResourceName	GetTaskPrefab ()
bool	IsTaskValid (IEntity hoveredEntity)
Protected Member Functions inherited from SCR_FactionCommanderBaseMenuHandler
SCR_FactionCommanderPlayerComponent	GetLocalCommanderComponent ()

Protected Attributes
bool	m_bIsObjectiveCreationEnabled
Protected Attributes inherited from SCR_FactionCommanderBaseMenuHandler
SCR_FactionCommanderMenuEntry	m_MenuEntry

Static Protected Attributes
const string	BASE_NOT_SELECTED_TEXT = "#AR-FactionCommander_NoBaseSelected"

Member Function Documentation

CanCampaignGroupEntryBeSelected()

bool SCR_FactionCommanderConflictBaseMenuHandler.CanCampaignGroupEntryBeSelected ( notnull Faction faction, IEntity hoveredEntity, notnull SCR_AIGroup group, TypeName taskClass )

protected

CanCreateObjectiveEntryBeSelected()

bool SCR_FactionCommanderConflictBaseMenuHandler.CanCreateObjectiveEntryBeSelected	(	notnull Faction	commanderFaction,
		int	playerId,
		vector	position,
		IEntity	hoveredEntity,
		out string	disabledText = "" )

CanCreateObjectiveEntryBeShown()

bool SCR_FactionCommanderConflictBaseMenuHandler.CanCreateObjectiveEntryBeShown	(	notnull Faction	commanderFaction,
		int	playerId,
		vector	position,
		IEntity	hoveredEntity )

Implemented in SCR_FactionCommanderCommandConflictBaseMenuHandler, and SCR_FactionCommanderDismantleCommandMenuHandler.

CanEntryBeSelected()

override bool SCR_FactionCommanderConflictBaseMenuHandler.CanEntryBeSelected	(	notnull Faction	commanderFaction,
		int	playerId,
		vector	position,
		IEntity	hoveredEntity,
		out string	disabledText = "" )

Implements SCR_FactionCommanderBaseMenuHandler.

Implemented in SCR_FactionCommanderCancelConflictBaseMenuHandler, SCR_FactionCommanderCommandConflictBaseMenuHandler, SCR_FactionCommanderCommandConflictMenuHandler, SCR_FactionCommanderDismantleCommandMenuHandler, and SCR_FactionCommanderEstablishCommandMenuHandler.

CanEntryBeShown()

override bool SCR_FactionCommanderConflictBaseMenuHandler.CanEntryBeShown	(	notnull Faction	commanderFaction,
		int	playerId,
		vector	position,
		IEntity	hoveredEntity )

Implements SCR_FactionCommanderBaseTaskMenuHandler.

Implemented in SCR_FactionCommanderCancelConflictBaseMenuHandler, SCR_FactionCommanderCommandConflictMenuHandler, and SCR_FactionCommanderEstablishCommandMenuHandler.

CanGroupEntryBeSelected()

override bool SCR_FactionCommanderConflictBaseMenuHandler.CanGroupEntryBeSelected	(	notnull Faction	commanderFaction,
		int	playerId,
		vector	position,
		IEntity	hoveredEntity,
		SCR_AIGroup	group,
		out string	disabledText = "" )

Implements SCR_FactionCommanderBaseMenuHandler.

Implemented in SCR_FactionCommanderCommandConflictBaseMenuHandler, SCR_FactionCommanderCommandConflictMenuHandler, SCR_FactionCommanderDismantleCommandMenuHandler, and SCR_FactionCommanderEstablishCommandMenuHandler.

GetHoveredBase()

SCR_CampaignMilitaryBaseComponent SCR_FactionCommanderConflictBaseMenuHandler.GetHoveredBase ( )

protected

GetLocalCampaignCommanderComponent()

SCR_CampaignFactionCommanderPlayerComponent SCR_FactionCommanderConflictBaseMenuHandler.GetLocalCampaignCommanderComponent ( )

protected

GetTask()

SCR_Task SCR_FactionCommanderConflictBaseMenuHandler.GetTask ( IEntity hoveredEntity, notnull Faction faction, TypeName taskClass )

protected

GetTaskOnBase()

SCR_Task SCR_FactionCommanderConflictBaseMenuHandler.GetTaskOnBase ( SCR_CampaignMilitaryBaseComponent targetBase, Faction targetFaction, TypeName taskClass )

protected

GetTaskOnHoveredBase()

SCR_Task SCR_FactionCommanderConflictBaseMenuHandler.GetTaskOnHoveredBase ( notnull Faction faction, TypeName taskClass )

protected

Member Data Documentation

BASE_NOT_SELECTED_TEXT

const string SCR_FactionCommanderConflictBaseMenuHandler.BASE_NOT_SELECTED_TEXT = "#AR-FactionCommander_NoBaseSelected"

staticprotected

m_bIsObjectiveCreationEnabled

bool SCR_FactionCommanderConflictBaseMenuHandler.m_bIsObjectiveCreationEnabled

protected

---

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

• Game/FactionCommander/MenuHandlers/SCR_FactionCommanderConflictBaseMenuHandler.c