A wrapper class utilized by SCR_ActionsRadialMenuEditorComponent for creating a specialized Entry (SCR_SelectionMenuEntry) class to be utilized by the Editor. More...

Inheritance diagram for SCR_EditorActionSelectionMenuEntry:

[legend]

Public Member Functions
SCR_BaseEditorAction	GetAction ()
	Gets the underlying Editor Action this entry is created for.

string	GetActionShortcut ()
	Getter for the underlying Editor Action's Shortcut.

void	SCR_EditorActionSelectionMenuEntry (notnull SCR_BaseEditorAction action, notnull SCR_BaseActionsEditorComponent actionEditorComponent, vector cursorPosition, int actionFlags)

Public Member Functions inherited from SCR_SelectionMenuEntry
ScriptInvoker	GetOnPerform ()

ScriptInvoker	GetOnPerformFail ()

ScriptInvoker	GetOnIconChange ()

void	Update ()
	Public method to make entry update itself.

void	Perform ()
	Public method to call entry perform Don't override! To define entry perform behavior override OnPerform() below.

void	Enable (bool enable)

void	SetId (string id)

string	GetId ()

void	SetName (string name)

void	SetDescription (string description)

void	SetIcon (ResourceName iconPath, string imageSetName="")
	Set icon and invoke change.

void	SetIconFromDeafaultImageSet (string imageSetName="")

ResourceName	GetCustomLayout ()

void	SetCustomLayout (ResourceName layout)

void	SetEntryComponent (SCR_SelectionMenuEntryComponent entryComponent)

SCR_SelectionMenuEntryComponent	GetEntryComponent ()

bool	IsEnabled ()

void	SetInputAction (string action)

string	GetInputAction ()

void	SCR_SelectionMenuEntry ()

Public Member Functions inherited from SCR_UIInfo
ResourceName	GetIconPath ()
	Get icon.

string	GetIconSetName ()
	Returns Icon Set name if imageset.

bool	HasIcon ()
	Check if the info has an icon defined.

bool	SetIconTo (ImageWidget imageWidget)
	Set icon to given image widget.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

Public Member Functions inherited from SCR_UIDescription
LocalizedString	GetUnformattedDescription ()
	Get the unformatted description from SCR_HintUIInfo instance.

void	SetDescription (LocalizedString description)
	Change the description from SCR_HintUIInfo instance.

LocalizedString	GetDescription ()
	Get description.

bool	HasDescription ()
	Check if the info has a description defined.

bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

Public Member Functions inherited from SCR_UIName
LocalizedString	GetUnformattedName ()
	Get The unformatted Name from SCR_HintUIInfo instance.

void	SetName (LocalizedString name)
	Change the Name from SCR_HintUIInfo instance.

LocalizedString	GetName ()
	Get name.

bool	HasName ()
	Check if the info has a name defined.

bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.

void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
	Print out contents of this UI info.

Protected Member Functions
override void	OnPerform ()
	Empty methods for deifinition of perform behavior.

Protected Member Functions inherited from SCR_SelectionMenuEntry
void	InvokeOnPerform ()

void	InvokeOnPerformFail ()

void	InvokeOnIconChange (ResourceName icon, string imageSetImage)

void	OnPerform ()
	Empty methods for deifinition of perform behavior.

void	OnEntryClick (SCR_SelectionMenuEntryComponent entryComponent)

Protected Member Functions inherited from SCR_UIInfo
override void	CopyFrom (SCR_UIName source)

override void	CopyFrom (SCR_UIName source)

void	CopyFrom (SCR_UIName source)

Protected Attributes
ref SCR_BaseEditorAction	m_Action

SCR_BaseActionsEditorComponent	m_ActionsEditorComponent

vector	m_vCursorWorldPos

int	m_iFlags

Protected Attributes inherited from SCR_SelectionMenuEntry
string	m_sId

bool	m_bEnabled

string	m_sInputAction

ResourceName	m_sCustomLayout

ref SCR_SelectionMenuEntryComponent	m_EntryComponent

ref ScriptInvoker< SCR_SelectionMenuEntry >	m_OnPerform

ref ScriptInvoker< SCR_SelectionMenuEntry >	m_OnPerformFail

ref ScriptInvoker< SCR_SelectionMenuEntry, ResourceName, string >	m_OnIconChange

Protected Attributes inherited from SCR_UIInfo
ResourceName	Icon

string	IconSetName

Protected Attributes inherited from SCR_UIDescription
LocalizedString	Description

Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Additional Inherited Members
Static Public Member Functions inherited from SCR_UIInfo
static SCR_UIInfo	GetInfo (BaseContainer source, string varName)
	Get UIInfo from a source object.

static SCR_UIInfo	CreateInfo (UIInfo source)
	Create SCR_UIInfo from engine UIInfo.

static SCR_UIInfo	CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
	Create SCR_UIInfo from basic params.

static SCR_UIInfo	CreatePlaceholderInfo (TypeName type)
	Get placeholder info.

Detailed Description

A wrapper class utilized by SCR_ActionsRadialMenuEditorComponent for creating a specialized Entry (SCR_SelectionMenuEntry) class to be utilized by the Editor.

Constructor & Destructor Documentation

◆ SCR_EditorActionSelectionMenuEntry()

void SCR_EditorActionSelectionMenuEntry.SCR_EditorActionSelectionMenuEntry	(	notnull SCR_BaseEditorAction	action,
		notnull SCR_BaseActionsEditorComponent	actionEditorComponent,
		vector	cursorPosition,
		int	actionFlags
	)

Member Function Documentation

◆ GetAction()

SCR_BaseEditorAction SCR_EditorActionSelectionMenuEntry.GetAction ( )

Gets the underlying Editor Action this entry is created for.

Returns: the Editor Action controlled by this Entry.

◆ GetActionShortcut()

string SCR_EditorActionSelectionMenuEntry.GetActionShortcut ( )

Getter for the underlying Editor Action's Shortcut.

Returns: the Shortcut string for the Editor Action this Entry is created for.

◆ OnPerform()

override void SCR_EditorActionSelectionMenuEntry.OnPerform ( )

protected

Empty methods for deifinition of perform behavior.

Implements SCR_SelectionMenuEntry.

Member Data Documentation

◆ m_Action

ref SCR_BaseEditorAction SCR_EditorActionSelectionMenuEntry.m_Action

protected

◆ m_ActionsEditorComponent

SCR_BaseActionsEditorComponent SCR_EditorActionSelectionMenuEntry.m_ActionsEditorComponent

protected

◆ m_iFlags

int SCR_EditorActionSelectionMenuEntry.m_iFlags

protected

◆ m_vCursorWorldPos

vector SCR_EditorActionSelectionMenuEntry.m_vCursorWorldPos

protected

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

Game/Editor/UI/RadialMenu/SCR_EditorActionSelectionMenuEntry.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SCR_EditorActionSelectionMenuEntry()

Member Function Documentation

◆ GetAction()

◆ GetActionShortcut()

◆ OnPerform()

Member Data Documentation

◆ m_Action

◆ m_ActionsEditorComponent

◆ m_iFlags

◆ m_vCursorWorldPos