SCR_AIMessageSelectionMenuEntry Interface Reference

Inheritance diagram for SCR_AIMessageSelectionMenuEntry:

Public Member Functions
void	SetParentComms (AICommunicationComponent parentComms, AIAgent receiver)
Public Member Functions inherited from AIMessageSelectionMenuEntry
void	AIMessageSelectionMenuEntry (AIMessage pAIMessage)
	Create new AIMessageSelectionMenuEntry instance with provided message.
proto external void	SetAIMessage (AIMessage pAIMessage)
	Set the message for this menu entry.
proto external AIMessage	GetAIMessage ()
	Retrieve the message from this menu entry. Can be null.
Public Member Functions inherited from ScriptedSelectionMenuEntry
override bool	GetEntryIconPathScript (out string outIconPath)
	If overridden and true is returned, outIconPath is returned when BaseSelectionMenuEntry.GetEntryIconPath is called.
override UIInfo	GetUIInfoScript ()
	Can be overridden to return desired UIInfo in GetUIInfo method.
void	UpdateVisuals ()
	Base visuals update function for specific entry update.
ResourceName	GetEntryLayout ()
	API for entry widget and component.
void	SetEntryLayout (ResourceName entryLayout)
Widget	GetEntryWidget ()
void	SetEntryWidget (Widget root)
string	GetName ()
void	SetName (string name)
Public Member Functions inherited from BaseSelectionMenuEntry
proto external bool	CanBeShown (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be shown?
proto external bool	CanBePerformed (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be performed?
proto external void	Perform (IEntity user, BaseSelectionMenu sourceMenu)
	Request to perform this entry.
proto external string	GetEntryName ()
	Return the name of this entry.
proto external string	GetEntryDescription ()
	Return the description of this entry.
proto external string	GetEntryIconPath ()
	Return the icon path of this entry.
proto external UIInfo	GetUIInfo ()
	Get related UI info or null if none.

Protected Member Functions
override void	OnPerform (IEntity user, BaseSelectionMenu sourceMenu)
	Callback for when this entry is supposed to be performed.
override bool	CanBeShownScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be shown?
override bool	CanBePerformedScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be performed?
override bool	GetEntryNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseSelectionMenuEntry.GetEntryName is called.
override bool	GetEntryDescriptionScript (out string outDescription)
	If overridden and true is returned, outDescription is returned when BaseSelectionMenuEntry.GetEntryDescription is called.

Additional Inherited Members
Static Public Attributes inherited from ScriptedSelectionMenuEntry
const string	LAYOUT_ENTRY_DEFAULT = "{121C45A1F59DC1AF}UI/layouts/Common/RadialMenu/RadialEntryElement.layout"
Protected Attributes inherited from ScriptedSelectionMenuEntry
ResourceName	m_EntryLayout = LAYOUT_ENTRY_DEFAULT
ref Widget	m_wEntry
string	m_sName

Member Function Documentation

CanBePerformedScript()

override bool SCR_AIMessageSelectionMenuEntry.CanBePerformedScript ( IEntity user, BaseSelectionMenu sourceMenu )

protected

Can this entry be performed?

Implements ScriptedSelectionMenuEntry.

CanBeShownScript()

override bool SCR_AIMessageSelectionMenuEntry.CanBeShownScript ( IEntity user, BaseSelectionMenu sourceMenu )

protected

Can this entry be shown?

Implements ScriptedSelectionMenuEntry.

GetEntryDescriptionScript()

override bool SCR_AIMessageSelectionMenuEntry.GetEntryDescriptionScript ( out string outDescription )

protected

If overridden and true is returned, outDescription is returned when BaseSelectionMenuEntry.GetEntryDescription is called.

If not overriden or false is returned the default value from UIInfo is taken (or empty string if no UI info exists)

Implements ScriptedSelectionMenuEntry.

GetEntryNameScript()

override bool SCR_AIMessageSelectionMenuEntry.GetEntryNameScript ( out string outName )

protected

If overridden and true is returned, outName is returned when BaseSelectionMenuEntry.GetEntryName is called.

If not overridden or false is returned the default value from UIInfo is taken (or empty string if no UI info exists)

Implements ScriptedSelectionMenuEntry.

OnPerform()

override void SCR_AIMessageSelectionMenuEntry.OnPerform ( IEntity user, BaseSelectionMenu sourceMenu )

protected

Callback for when this entry is supposed to be performed.

Implements ScriptedSelectionMenuEntry.

SetParentComms()

void SCR_AIMessageSelectionMenuEntry.SetParentComms	(	AICommunicationComponent	parentComms,
		AIAgent	receiver )

---

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

• Game/UI/HUD/SelectionMenu/Entries/SCR_AIMessageSelectionMenuEntry.c