SCR_FactionCommanderBaseMenuHandler Interface Reference

Inheritance diagram for SCR_FactionCommanderBaseMenuHandler:

Public Member Functions
void	SetMenuEntry (SCR_FactionCommanderMenuEntry menuEntry)
SCR_FactionCommanderMenuEntry	GetMenuEntry ()
bool	CanQuickEntryBeShown (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity)
bool	CanEntryBeShown (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity)
bool	CanEntryBeSelected (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity, out string disabledText="")
bool	CanGroupEntryBeShown (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity, SCR_AIGroup group)
bool	CanGroupEntryBeSelected (notnull Faction commanderFaction, int playerId, vector position, IEntity hoveredEntity, SCR_AIGroup group, out string disabledText="")
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_FactionCommanderPlayerComponent	GetLocalCommanderComponent ()

Protected Attributes
SCR_FactionCommanderMenuEntry	m_MenuEntry

Member Function Documentation

CanEntryBeSelected()

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

Implemented in SCR_FactionCommanderBaseCancelRequestMenuHandler, SCR_FactionCommanderCancelConflictBaseMenuHandler, SCR_FactionCommanderCancelMenuHandler, SCR_FactionCommanderCommandConflictBaseMenuHandler, SCR_FactionCommanderCommandConflictMenuHandler, SCR_FactionCommanderConfirmMenuHandler, SCR_FactionCommanderConflictBaseMenuHandler, SCR_FactionCommanderDismantleCommandMenuHandler, SCR_FactionCommanderEstablishBaseRequestMenuHandler, and SCR_FactionCommanderEstablishCommandMenuHandler.

CanEntryBeShown()

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

Implemented in SCR_FactionCommanderBaseRequestMenuHandler, SCR_FactionCommanderBaseTaskMenuHandler, SCR_FactionCommanderCancelConflictBaseMenuHandler, SCR_FactionCommanderCommandConflictMenuHandler, SCR_FactionCommanderConfirmMenuHandler, SCR_FactionCommanderConflictBaseMenuHandler, SCR_FactionCommanderEstablishBaseRequestCancelMenuHandler, SCR_FactionCommanderEstablishBaseRequestConfirmMenuHandler, SCR_FactionCommanderEstablishBaseRequestDenyMenuHandler, SCR_FactionCommanderEstablishBaseRequestMenuHandler, SCR_FactionCommanderEstablishCommandMenuHandler, SCR_FactionCommanderMainCommandMenuHandler, and SCR_FactionCommanderMainRequestMenuHandler.

CanGroupEntryBeSelected()

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

Implemented in SCR_FactionCommanderBaseRequestMenuHandler, SCR_FactionCommanderCommandConflictBaseMenuHandler, SCR_FactionCommanderCommandConflictMenuHandler, SCR_FactionCommanderConflictBaseMenuHandler, SCR_FactionCommanderDismantleCommandMenuHandler, SCR_FactionCommanderEstablishBaseRequestMenuHandler, and SCR_FactionCommanderEstablishCommandMenuHandler.

CanGroupEntryBeShown()

bool SCR_FactionCommanderBaseMenuHandler.CanGroupEntryBeShown	(	notnull Faction	commanderFaction,
		int	playerId,
		vector	position,
		IEntity	hoveredEntity,
		SCR_AIGroup	group )

Implemented in SCR_FactionCommanderBaseRequestMenuHandler, SCR_FactionCommanderBaseTaskMenuHandler, and SCR_FactionCommanderCommandConflictBaseMenuHandler.

CanQuickEntryBeShown()

bool SCR_FactionCommanderBaseMenuHandler.CanQuickEntryBeShown	(	notnull Faction	commanderFaction,
		int	playerId,
		vector	position,
		IEntity	hoveredEntity )

Implemented in SCR_FactionCommanderBaseRequestMenuHandler, SCR_FactionCommanderCommandConflictBaseMenuHandler, SCR_FactionCommanderCommandConflictMenuHandler, SCR_FactionCommanderDismantleCommandMenuHandler, SCR_FactionCommanderEstablishBaseRequestMenuHandler, and SCR_FactionCommanderEstablishCommandMenuHandler.

GetLocalCommanderComponent()

SCR_FactionCommanderPlayerComponent SCR_FactionCommanderBaseMenuHandler.GetLocalCommanderComponent ( )

protected

GetMenuEntry()

SCR_FactionCommanderMenuEntry SCR_FactionCommanderBaseMenuHandler.GetMenuEntry

(

)

OnCommandIssued()

void SCR_FactionCommanderBaseMenuHandler.OnCommandIssued	(	notnull Faction	commanderFaction,
		int	playerId,
		vector	position,
		IEntity	hoveredEntity,
		SCR_AIGroup	group )

Implemented in SCR_FactionCommanderBaseCancelRequestMenuHandler, SCR_FactionCommanderBaseRequestMenuHandler, SCR_FactionCommanderCancelConflictBaseMenuHandler, SCR_FactionCommanderCancelMenuHandler, SCR_FactionCommanderCommandConflictBaseMenuHandler, SCR_FactionCommanderCommandConflictMenuHandler, SCR_FactionCommanderConfirmMenuHandler, SCR_FactionCommanderDismantleCommandMenuHandler, SCR_FactionCommanderEstablishBaseRequestConfirmMenuHandler, SCR_FactionCommanderEstablishBaseRequestDenyMenuHandler, SCR_FactionCommanderEstablishBaseRequestMenuHandler, and SCR_FactionCommanderEstablishCommandMenuHandler.

OnEntryHovered()

void SCR_FactionCommanderBaseMenuHandler.OnEntryHovered	(	notnull Faction	commanderFaction,
		int	playerId,
		vector	position,
		IEntity	hoveredEntity )

SetMenuEntry()

void SCR_FactionCommanderBaseMenuHandler.SetMenuEntry

(

SCR_FactionCommanderMenuEntry

menuEntry

)

Member Data Documentation

m_MenuEntry

SCR_FactionCommanderMenuEntry SCR_FactionCommanderBaseMenuHandler.m_MenuEntry

protected

---

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

• Game/FactionCommander/MenuHandlers/SCR_FactionCommanderBaseMenuHandler.c