SCR_XPInfoDisplay Interface Reference

Inheritance diagram for SCR_XPInfoDisplay:

Public Member Functions
override void	DisplayInit (IEntity owner)
override bool	DisplayStartDrawInit (IEntity owner)
override void	DisplayStartDraw (IEntity owner)
override void	OnSettingsChanged ()
void	AllowShowingInfo (bool allow)
void	ToggleXPInfo (bool visible)
void	~SCR_XPInfoDisplay ()
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	RecolorXPBar ()
void	HideHUD ()
void	ShowXPInfo (int totalXP, SCR_EXPRewards rewardID, int XP, bool volunteer, bool profileUsed, int skillLevel)
void	UpdateXPProgressBar (notnull SCR_FactionManager factionManager, SCR_ECharacterRank curRank, SCR_ECharacterRank prevRank, int XP, int totalXP, bool notify)
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
bool	m_bNegativeXP
bool	m_bInitDone
bool	m_bIsInfoAllowed = true
SCR_XPHandlerComponent	m_PlayerXPComponent
TextWidget	m_wTitle
TextWidget	m_wRank
TextWidget	m_wRankNoIcon
TextWidget	m_wSkill
ImageWidget	m_wRankIcon
ProgressBarWidget	m_wProgress
ProgressBarWidget	m_wProgressDiff
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
static const int	XP_INFO_DURATION = 10000
static const ResourceName	RANK_ICON_IMAGESET = "{5D7F0C1AB551F610}UI/Textures/MilitaryIcons/MilitaryIcons.imageset"

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

Constructor & Destructor Documentation

~SCR_XPInfoDisplay()

void SCR_XPInfoDisplay.~SCR_XPInfoDisplay

(

)

Member Function Documentation

AllowShowingInfo()

void SCR_XPInfoDisplay.AllowShowingInfo

(

bool

allow

)

DisplayInit()

override void SCR_XPInfoDisplay.DisplayInit

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayStartDraw()

override void SCR_XPInfoDisplay.DisplayStartDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayStartDrawInit()

override bool SCR_XPInfoDisplay.DisplayStartDrawInit

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

HideHUD()

void SCR_XPInfoDisplay.HideHUD ( )

protected

OnSettingsChanged()

override void SCR_XPInfoDisplay.OnSettingsChanged

(

)

Implements SCR_InfoDisplayExtended.

RecolorXPBar()

void SCR_XPInfoDisplay.RecolorXPBar ( )

protected

ShowXPInfo()

void SCR_XPInfoDisplay.ShowXPInfo ( int  totalXP, SCR_EXPRewards  rewardID, int  XP, bool  volunteer, bool  profileUsed, int  skillLevel  )

protected

ToggleXPInfo()

void SCR_XPInfoDisplay.ToggleXPInfo

(

bool

visible

)

UpdateXPProgressBar()

void SCR_XPInfoDisplay.UpdateXPProgressBar ( notnull SCR_FactionManager  factionManager, SCR_ECharacterRank  curRank, SCR_ECharacterRank  prevRank, int  XP, int  totalXP, bool  notify  )

protected

Member Data Documentation

m_bInitDone

bool SCR_XPInfoDisplay.m_bInitDone

protected

m_bIsInfoAllowed

bool SCR_XPInfoDisplay.m_bIsInfoAllowed = true

protected

m_bNegativeXP

bool SCR_XPInfoDisplay.m_bNegativeXP

protected

m_PlayerXPComponent

SCR_XPHandlerComponent SCR_XPInfoDisplay.m_PlayerXPComponent

protected

m_wProgress

ProgressBarWidget SCR_XPInfoDisplay.m_wProgress

protected

m_wProgressDiff

ProgressBarWidget SCR_XPInfoDisplay.m_wProgressDiff

protected

m_wRank

TextWidget SCR_XPInfoDisplay.m_wRank

protected

m_wRankIcon

ImageWidget SCR_XPInfoDisplay.m_wRankIcon

protected

m_wRankNoIcon

TextWidget SCR_XPInfoDisplay.m_wRankNoIcon

protected

m_wSkill

TextWidget SCR_XPInfoDisplay.m_wSkill

protected

m_wTitle

TextWidget SCR_XPInfoDisplay.m_wTitle

protected

RANK_ICON_IMAGESET

const ResourceName SCR_XPInfoDisplay.RANK_ICON_IMAGESET = "{5D7F0C1AB551F610}UI/Textures/MilitaryIcons/MilitaryIcons.imageset"

staticprotected

XP_INFO_DURATION

const int SCR_XPInfoDisplay.XP_INFO_DURATION = 10000

staticprotected

---

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

• Game/UI/HUD/SCR_XPInfoDisplay.c