Radial menu class for handling HUD part of menu. More...

Inheritance diagram for SCR_SelectionMenuDisplay:

Public Member Functions
void	SetupMenu (SCR_SelectionMenu menu)
	Set menu and register callback reactions for menu Clear callbacks if there was any other menu used.

override void	DisplayStartDraw (IEntity owner)
	Setup menu

override void	DisplayOnSuspended ()
	Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM.

SCR_SelectionMenu	GetMenu ()

Public Member Functions inherited from SCR_InfoDisplayExtended
void	SetEnabled (bool isEnabled)

override void	Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR)
	Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.

Public Member Functions inherited from SCR_InfoDisplay
SCR_InfoDisplayHandler	GetHandler (TypeName handlerType)

SCR_InfoDisplayInvoker	GetOnStart ()

SCR_InfoDisplayInvoker	GetOnStop ()

IEntity	GetOwnerEntity ()

Widget	GetContentWidget ()

string	GetContentWidgetName ()

void	SetRootWidget (notnull Widget root)

void	SetContentWidget (notnull Widget content)

void	Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR)
	Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.

bool	IsShown ()

Widget	GetRootWidget ()

bool	GetDimensions (out float width, out float height, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.

bool	GetAnchorPosition (out float x, out float y, EWidgetAnchor anchor=EWidgetAnchor.TOPLEFT, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.

void	RegisterToHudManager ()

Public Member Functions inherited from GroupInfoDisplay
proto external int	GetInfoDisplays (out notnull array< BaseInfoDisplay > outInfoDisplays)

Public Member Functions inherited from BaseInfoDisplay
proto external GenericComponent	FindComponentInParentContainer (TypeName typeName)

Protected Member Functions
void	FindMenu ()
	Method ready for override to find menu at custom place.

void	CreateEntryWidgets ()
	Will create entries in HUD layout.

void	CreateNewEntry (int i)

void	RemoveEntry (Widget entry, int id)

void	SetupEntryWidget (notnull SCR_SelectionMenuEntry entry, notnull Widget widget, int id)
	Setup entry widget properties specific for each menu Method can e.g.

void	ClearEntryWidgets ()
	Remove all entries from HUD layout.

bool	EntriesChanged (array< ref SCR_SelectionMenuEntry > entries)
	Check if used data are still same.

void	OnMenuOpen ()

void	OnMenuClose ()

void	OnMenuEntriesUpdate (SCR_SelectionMenu menu, array< ref SCR_SelectionMenuEntry > entries)

void	OnMenuEntrySelected (SCR_SelectionMenu menu, SCR_SelectionMenuEntry entry, int id)
	React on selected entry change.

void	OnMenuEntryPerform (SCR_SelectionMenu menu, SCR_SelectionMenuEntry entry)
	React on selected entry change.

void	DebugPrint (string method, string msg)

Protected Member Functions inherited from SCR_InfoDisplayExtended
bool	DisplayStartDrawInit (IEntity owner)

void	DisplayStartDraw (IEntity owner)

void	DisplayStopDraw (IEntity owner)

void	DisplayInit (IEntity owner)

void	DisplayUpdate (IEntity owner, float timeSlice)

void	DisplayControlledEntityChanged (IEntity from, IEntity to)

void	DisplayConsciousnessChanged (bool conscious, bool init=false)

void	DisplayOnSuspended ()
	Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM.

void	DisplayOnResumed ()

void	InitializeInterfaceSettings ()

void	OnSettingsChanged ()

Protected Member Functions inherited from SCR_InfoDisplay
void	OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null)

override void	OnStartDraw (IEntity owner)

void	AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)

override void	OnStopDraw (IEntity owner)

override void	UpdateValues (IEntity owner, float timeSlice)

override void	OnInit (IEntity owner)

void	OnInit (IEntity owner)

void	UpdateValues (IEntity owner, float timeSlice)

void	OnStartDraw (IEntity owner)

void	OnStopDraw (IEntity owner)

Protected Attributes
ResourceName	m_sEntryLayout

string	m_sEntriesParent

ref SCR_SelectionMenu	m_Menu

ref array< SCR_SelectionMenuEntry >	m_aEntries = {}

ref array< ref Widget >	m_aEntryWidgets = {}

SCR_SelectionMenuEntry	m_LastSelectedEntry

int	m_iLastSelectedId = -1

Widget	m_wEntriesParent

Protected Attributes inherited from SCR_InfoDisplayExtended
bool	m_bIsEnabled

string	m_sInterfaceSettingName

SCR_PlayerController	m_PlayerController

SCR_CharacterControllerComponent	m_CharacterController

SCR_CharacterCameraHandlerComponent	m_CameraHandler

MenuManager	m_MenuManager

EventHandlerManagerComponent	m_EventHandlerManager

SCR_EditorManagerEntity	m_EditorManager

bool	m_bAttachedToPlayerController

bool	m_bInThirdPerson

bool	m_bInADS

bool	m_bIsUnconscious

bool	m_bInPauseMenu

bool	m_bInEditor

bool	m_bCanShow

bool	m_bIsEnabledInSettings = true

bool	m_bShowInAllCameras = true

Protected Attributes inherited from SCR_InfoDisplay
string	m_sParentSlot

string	m_sContentWidget

int	m_iContentWidthAdjustment

int	m_iContentHeightAdjustment

string	m_sAdaptiveOpacityWidgetName

ref array< ref SCR_InfoDisplayHandler >	m_aHandlers

bool	m_bShown

Widget	m_wRoot

Widget	m_wContent

Widget	m_wSlot

SCR_HUDManagerComponent	m_HUDManager

int	m_iChildDisplays = 0

ref array< BaseInfoDisplay >	m_aChildDisplays = new array<BaseInfoDisplay>

SCR_InfoDisplay	m_pParentDisplay

bool	m_bRegistered = false

IEntity	m_OwnerEntity

ref array< ref SCR_InfoDisplayHandler >	m_aUpdatableHandlers = {}

ref SCR_InfoDisplayInvoker	m_OnStart = new SCR_InfoDisplayInvoker()

ref SCR_InfoDisplayInvoker	m_OnStop = new SCR_InfoDisplayInvoker()

Static Protected Attributes
const float	FADE_IN_SPEED = UIConstants.FADE_RATE_SUPER_FAST

Additional Inherited Members
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath

EHudLayers	m_eLayer

int	m_iOverrideZOrder

Detailed Description

Radial menu class for handling HUD part of menu.

Member Function Documentation

◆ ClearEntryWidgets()

void SCR_SelectionMenuDisplay.ClearEntryWidgets ( )

protected

Remove all entries from HUD layout.

Implemented in SCR_RadialMenuDisplay.

◆ CreateEntryWidgets()

void SCR_SelectionMenuDisplay.CreateEntryWidgets ( )

protected

Will create entries in HUD layout.

◆ CreateNewEntry()

void SCR_SelectionMenuDisplay.CreateNewEntry ( int i )

protected

◆ DebugPrint()

void SCR_SelectionMenuDisplay.DebugPrint	(	string	method,
		string	msg
	)

protected

◆ DisplayOnSuspended()

override void SCR_SelectionMenuDisplay.DisplayOnSuspended ( )

Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM.

Implements SCR_InfoDisplayExtended.

◆ DisplayStartDraw()

override void SCR_SelectionMenuDisplay.DisplayStartDraw ( IEntity owner )

Setup menu

Implements SCR_InfoDisplayExtended.

Implemented in SCR_RadialMenuDisplay, and SCR_VONRadialDisplay.

◆ EntriesChanged()

bool SCR_SelectionMenuDisplay.EntriesChanged ( array< ref SCR_SelectionMenuEntry > entries )

protected

Check if used data are still same.

◆ FindMenu()

void SCR_SelectionMenuDisplay.FindMenu ( )

protected

Method ready for override to find menu at custom place.

◆ GetMenu()

SCR_SelectionMenu SCR_SelectionMenuDisplay.GetMenu ( )

◆ OnMenuClose()

void SCR_SelectionMenuDisplay.OnMenuClose ( )

protected

Implemented in SCR_RadialMenuDisplay.

◆ OnMenuEntriesUpdate()

void SCR_SelectionMenuDisplay.OnMenuEntriesUpdate	(	SCR_SelectionMenu	menu,
		array< ref SCR_SelectionMenuEntry >	entries
	)

protected

Implemented in SCR_RadialMenuDisplay.

◆ OnMenuEntryPerform()

void SCR_SelectionMenuDisplay.OnMenuEntryPerform	(	SCR_SelectionMenu	menu,
		SCR_SelectionMenuEntry	entry
	)

protected

React on selected entry change.

Implemented in SCR_RadialMenuDisplay, and SCR_VONRadialDisplay.

◆ OnMenuEntrySelected()

void SCR_SelectionMenuDisplay.OnMenuEntrySelected	(	SCR_SelectionMenu	menu,
		SCR_SelectionMenuEntry	entry,
		int	id
	)

protected

React on selected entry change.

Implemented in SCR_RadialMenuDisplay.

◆ OnMenuOpen()

void SCR_SelectionMenuDisplay.OnMenuOpen ( )

protected

Implemented in SCR_RadialMenuDisplay.

◆ RemoveEntry()

void SCR_SelectionMenuDisplay.RemoveEntry	(	Widget	entry,
		int	id
	)

protected

◆ SetupEntryWidget()

void SCR_SelectionMenuDisplay.SetupEntryWidget	(	notnull SCR_SelectionMenuEntry	entry,
		notnull Widget	widget,
		int	id
	)

protected

Setup entry widget properties specific for each menu Method can e.g.

entries position - that can be different for horizontal and radial menus Ready for override

Implemented in SCR_RadialMenuDisplay.

◆ SetupMenu()

void SCR_SelectionMenuDisplay.SetupMenu ( SCR_SelectionMenu menu )

Set menu and register callback reactions for menu Clear callbacks if there was any other menu used.

Implemented in SCR_RadialMenuDisplay.

Member Data Documentation

◆ FADE_IN_SPEED

const float SCR_SelectionMenuDisplay.FADE_IN_SPEED = UIConstants.FADE_RATE_SUPER_FAST

staticprotected

◆ m_aEntries

ref array<SCR_SelectionMenuEntry> SCR_SelectionMenuDisplay.m_aEntries = {}

protected

◆ m_aEntryWidgets

ref array<ref Widget> SCR_SelectionMenuDisplay.m_aEntryWidgets = {}

protected

◆ m_iLastSelectedId

int SCR_SelectionMenuDisplay.m_iLastSelectedId = -1

protected

◆ m_LastSelectedEntry

SCR_SelectionMenuEntry SCR_SelectionMenuDisplay.m_LastSelectedEntry

protected

◆ m_Menu

ref SCR_SelectionMenu SCR_SelectionMenuDisplay.m_Menu

protected

◆ m_sEntriesParent

string SCR_SelectionMenuDisplay.m_sEntriesParent

protected

◆ m_sEntryLayout

ResourceName SCR_SelectionMenuDisplay.m_sEntryLayout

protected

◆ m_wEntriesParent

Widget SCR_SelectionMenuDisplay.m_wEntriesParent

protected

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

Game/UI/HUD/SelectionMenu/SCR_SelectionMenuDisplay.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ClearEntryWidgets()

◆ CreateEntryWidgets()

◆ CreateNewEntry()

◆ DebugPrint()

◆ DisplayOnSuspended()

◆ DisplayStartDraw()

◆ EntriesChanged()

◆ FindMenu()

◆ GetMenu()

◆ OnMenuClose()

◆ OnMenuEntriesUpdate()

◆ OnMenuEntryPerform()

◆ OnMenuEntrySelected()

◆ OnMenuOpen()

◆ RemoveEntry()

◆ SetupEntryWidget()

◆ SetupMenu()

Member Data Documentation

◆ FADE_IN_SPEED

◆ m_aEntries

◆ m_aEntryWidgets

◆ m_iLastSelectedId

◆ m_LastSelectedEntry

◆ m_Menu

◆ m_sEntriesParent

◆ m_sEntryLayout

◆ m_wEntriesParent