SCR_AvailableActionsDisplay Interface Reference

Inheritance diagram for SCR_AvailableActionsDisplay:

Public Member Functions
override void	DisplayUpdate (IEntity owner, float timeSlice)
void	SetOffsetY (float offset=-1)
	Set available actions layout y position.
void	SetAdditionalOffsetY (float offset)
override void	DisplayStartDraw (IEntity owner)
override void	DisplayStopDraw (IEntity owner)
override void	DisplayInit (IEntity owner)
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)

Static Public Attributes
const int	HEIGHT_DIVIDER_BIG = 70
	This values are used to determine how many actions fit in the available space. (Space / devider = MaxActions)
const int	HEIGHT_DIVIDER_MEDIUM = 50
const int	HINT_SIZE_Y = 34
const int	DEFAULT_FONT_SIZE = 20
const int	MIN_FONT_SIZE = 16

Protected Member Functions
int	GetAvailableActions (SCR_AvailableActionsConditionData data, array< ref SCR_AvailableActionContext > inActions, out array< SCR_AvailableActionContext > outActions)
	Go through the list of passed in action names of inActions and populate the outActions list with actions that are currently active (available) Returns count of available actions or -1 in case of error.
bool	CanBeShown (IEntity controlledEntity)
void	UpdateIsEnabled ()
void	DisplayHint (Widget widget, float delayFade, float delayShrink)
void	HintFadeOut (Widget widget, float delayFade, float delayShrink)
	Hide hint with fadeout.
void	HintShrink (Widget widget, float delayShrink)
	Hide hint with fadeout.
void	HintHide (Widget widget)
	Hide hint with fadeout.
void	ApplyOffsets ()
void	OnSettingsMenuClosed (ChimeraMenuBase menu)
	Callback method that is triggered when some menu is closed.
void	OnGamepadDeviceChanged (bool isUsingGamepad)
	Callback method that is triggered when player switches to or from using gamepad as his input device.
void	OnSlotUIResize ()
void	ApplyLayoutBehavior ()
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
ref array< ref SCR_AvailableActionContext >	m_aActions
	List of all actions to process at any given moment, these are filtered and available ones are displayed.
ResourceName	m_sChildLayout
float	m_fDefaultOffsetY
float	m_fOffsetY
float	m_fAdditionalOffsetY = 0
ref array< ref AvailableActionLayoutBehaviorBase >	m_aBehaviors
int	m_iButtonSizeSmall
int	m_iButtonSizeMedium
int	m_iButtonSizeLarge
ref array< ref SCR_AvailableActionsWidget >	m_aWidgets = new array<ref SCR_AvailableActionsWidget>()
	List of available action widget containers.
Widget	m_wLayoutWidget
	Layout widget in root or null if new.
int	m_iLastCount
	Amount of previously shown widgets.
bool	m_bIsEnabledSettings
	Game settings.
bool	m_bForceUpdate
	If user changed keybing then it should force update of hints.
EInputDeviceType	m_eCurrentInputDevice
ref SCR_AvailableActionsConditionData	m_data
SCR_InfoDisplaySlotHandler	m_slotHandler
SCR_HUDSlotUIComponent	m_HUDSlotComponent
float	m_fDataFetchTimer
	Timer for fetching data limitation.
int	m_iMaxActionsBig = 5
	Default values for how many large / medium buttons will be displayed before they switch to a smaller one. (This gets overritten by the SlotSize calculation)
int	m_iMaxActionsMedium = 7
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 int	PRELOADED_WIDGETS_COUNT = 16
	Count of maximum elements that will be pre-cached.

Additional Inherited Members
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath
EHudLayers	m_eLayer
int	m_iOverrideZOrder

Member Function Documentation

ApplyLayoutBehavior()

void SCR_AvailableActionsDisplay.ApplyLayoutBehavior ( )

protected

ApplyOffsets()

void SCR_AvailableActionsDisplay.ApplyOffsets ( )

protected

CanBeShown()

bool SCR_AvailableActionsDisplay.CanBeShown ( IEntity  controlledEntity )

protected

DisplayHint()

void SCR_AvailableActionsDisplay.DisplayHint ( Widget  widget, float  delayFade, float  delayShrink  )

protected

DisplayInit()

override void SCR_AvailableActionsDisplay.DisplayInit

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayStartDraw()

override void SCR_AvailableActionsDisplay.DisplayStartDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayStopDraw()

override void SCR_AvailableActionsDisplay.DisplayStopDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayUpdate()

override void SCR_AvailableActionsDisplay.DisplayUpdate	(	IEntity	owner,
		float	timeSlice
	)

Implements SCR_InfoDisplayExtended.

GetAvailableActions()

int SCR_AvailableActionsDisplay.GetAvailableActions ( SCR_AvailableActionsConditionData  data, array< ref SCR_AvailableActionContext >  inActions, out array< SCR_AvailableActionContext >  outActions  )

protected

Go through the list of passed in action names of inActions and populate the outActions list with actions that are currently active (available) Returns count of available actions or -1 in case of error.

HintFadeOut()

void SCR_AvailableActionsDisplay.HintFadeOut ( Widget  widget, float  delayFade, float  delayShrink  )

protected

Hide hint with fadeout.

HintHide()

void SCR_AvailableActionsDisplay.HintHide ( Widget  widget )

protected

Hide hint with fadeout.

HintShrink()

void SCR_AvailableActionsDisplay.HintShrink ( Widget  widget, float  delayShrink  )

protected

Hide hint with fadeout.

OnGamepadDeviceChanged()

void SCR_AvailableActionsDisplay.OnGamepadDeviceChanged ( bool  isUsingGamepad )

protected

Callback method that is triggered when player switches to or from using gamepad as his input device.

Parameters

[in]

isUsingGamepad

OnSettingsMenuClosed()

void SCR_AvailableActionsDisplay.OnSettingsMenuClosed ( ChimeraMenuBase  menu )

protected

Callback method that is triggered when some menu is closed.

Parameters

[in]

menu

that was closed

OnSlotUIResize()

void SCR_AvailableActionsDisplay.OnSlotUIResize ( )

protected

SetAdditionalOffsetY()

void SCR_AvailableActionsDisplay.SetAdditionalOffsetY

(

float

offset

)

SetOffsetY()

void SCR_AvailableActionsDisplay.SetOffsetY

(

float

offset = -1

)

Set available actions layout y position.

UpdateIsEnabled()

void SCR_AvailableActionsDisplay.UpdateIsEnabled ( )

protected

Member Data Documentation

DEFAULT_FONT_SIZE

const int SCR_AvailableActionsDisplay.DEFAULT_FONT_SIZE = 20

static

HEIGHT_DIVIDER_BIG

const int SCR_AvailableActionsDisplay.HEIGHT_DIVIDER_BIG = 70

static

This values are used to determine how many actions fit in the available space. (Space / devider = MaxActions)

HEIGHT_DIVIDER_MEDIUM

const int SCR_AvailableActionsDisplay.HEIGHT_DIVIDER_MEDIUM = 50

static

HINT_SIZE_Y

const int SCR_AvailableActionsDisplay.HINT_SIZE_Y = 34

static

m_aActions

ref array<ref SCR_AvailableActionContext> SCR_AvailableActionsDisplay.m_aActions

protected

List of all actions to process at any given moment, these are filtered and available ones are displayed.

m_aBehaviors

ref array<ref AvailableActionLayoutBehaviorBase> SCR_AvailableActionsDisplay.m_aBehaviors

protected

m_aWidgets

ref array<ref SCR_AvailableActionsWidget> SCR_AvailableActionsDisplay.m_aWidgets = new array<ref SCR_AvailableActionsWidget>()

protected

List of available action widget containers.

m_bForceUpdate

bool SCR_AvailableActionsDisplay.m_bForceUpdate

protected

If user changed keybing then it should force update of hints.

m_bIsEnabledSettings

bool SCR_AvailableActionsDisplay.m_bIsEnabledSettings

protected

Game settings.

m_data

ref SCR_AvailableActionsConditionData SCR_AvailableActionsDisplay.m_data

protected

m_eCurrentInputDevice

EInputDeviceType SCR_AvailableActionsDisplay.m_eCurrentInputDevice

protected

m_fAdditionalOffsetY

float SCR_AvailableActionsDisplay.m_fAdditionalOffsetY = 0

protected

m_fDataFetchTimer

float SCR_AvailableActionsDisplay.m_fDataFetchTimer

protected

Timer for fetching data limitation.

m_fDefaultOffsetY

float SCR_AvailableActionsDisplay.m_fDefaultOffsetY

protected

m_fOffsetY

float SCR_AvailableActionsDisplay.m_fOffsetY

protected

m_HUDSlotComponent

SCR_HUDSlotUIComponent SCR_AvailableActionsDisplay.m_HUDSlotComponent

protected

m_iButtonSizeLarge

int SCR_AvailableActionsDisplay.m_iButtonSizeLarge

protected

m_iButtonSizeMedium

int SCR_AvailableActionsDisplay.m_iButtonSizeMedium

protected

m_iButtonSizeSmall

int SCR_AvailableActionsDisplay.m_iButtonSizeSmall

protected

m_iLastCount

int SCR_AvailableActionsDisplay.m_iLastCount

protected

Amount of previously shown widgets.

m_iMaxActionsBig

int SCR_AvailableActionsDisplay.m_iMaxActionsBig = 5

protected

Default values for how many large / medium buttons will be displayed before they switch to a smaller one. (This gets overritten by the SlotSize calculation)

m_iMaxActionsMedium

int SCR_AvailableActionsDisplay.m_iMaxActionsMedium = 7

protected

m_sChildLayout

ResourceName SCR_AvailableActionsDisplay.m_sChildLayout

protected

m_slotHandler

SCR_InfoDisplaySlotHandler SCR_AvailableActionsDisplay.m_slotHandler

protected

m_wLayoutWidget

Widget SCR_AvailableActionsDisplay.m_wLayoutWidget

protected

Layout widget in root or null if new.

MIN_FONT_SIZE

const int SCR_AvailableActionsDisplay.MIN_FONT_SIZE = 16

static

PRELOADED_WIDGETS_COUNT

const int SCR_AvailableActionsDisplay.PRELOADED_WIDGETS_COUNT = 16

staticprotected

Count of maximum elements that will be pre-cached.

---

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

• Game/UI/HUD/AvailableActions/SCR_AvailableActionsDisplay.c