SCR_CampaignInfoDisplay Interface Reference

Inheritance diagram for SCR_CampaignInfoDisplay:

Public Member Functions
override bool	DisplayStartDrawInit (IEntity owner)
override void	DisplayStartDraw (IEntity owner)
override void	DisplayUpdate (IEntity owner, float timeSlice)
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)
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	HideHUD ()
void	UpdateHUDValues ()
void	UpdateHUD ()
Protected Member Functions inherited from SCR_InfoDisplayExtended
void	DisplayStopDraw (IEntity owner)
void	DisplayInit (IEntity owner)
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)
void	AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)

Protected Attributes
bool	m_bInitDone
bool	m_bPeriodicRefresh
SCR_GameModeCampaign	m_Campaign
Widget	m_wCountdownOverlay
ImageWidget	m_wLeftFlag
ImageWidget	m_wRightFlag
ImageWidget	m_wWinScoreSideLeft
ImageWidget	m_wWinScoreSideRight
RichTextWidget	m_wLeftScore
RichTextWidget	m_wRightScore
RichTextWidget	m_wWinScore
RichTextWidget	m_wCountdown
RichTextWidget	m_wFlavour
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	HUD_DURATION = 15000
static const int	SIZE_NORMAL = 20
static const int	SIZE_WINNER = 24

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

Member Function Documentation

DisplayStartDraw()

override void SCR_CampaignInfoDisplay.DisplayStartDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

Implemented in SCR_CampaignMapInfoDisplay.

DisplayStartDrawInit()

override bool SCR_CampaignInfoDisplay.DisplayStartDrawInit

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayUpdate()

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

Implements SCR_InfoDisplayExtended.

HideHUD()

void SCR_CampaignInfoDisplay.HideHUD ( )

protected

UpdateHUD()

void SCR_CampaignInfoDisplay.UpdateHUD ( )

protected

Implemented in SCR_CampaignMapInfoDisplay.

UpdateHUDValues()

void SCR_CampaignInfoDisplay.UpdateHUDValues ( )

protected

Member Data Documentation

HUD_DURATION

const int SCR_CampaignInfoDisplay.HUD_DURATION = 15000

staticprotected

m_bInitDone

bool SCR_CampaignInfoDisplay.m_bInitDone

protected

m_bPeriodicRefresh

bool SCR_CampaignInfoDisplay.m_bPeriodicRefresh

protected

m_Campaign

SCR_GameModeCampaign SCR_CampaignInfoDisplay.m_Campaign

protected

m_wCountdown

RichTextWidget SCR_CampaignInfoDisplay.m_wCountdown

protected

m_wCountdownOverlay

Widget SCR_CampaignInfoDisplay.m_wCountdownOverlay

protected

m_wFlavour

RichTextWidget SCR_CampaignInfoDisplay.m_wFlavour

protected

m_wLeftFlag

ImageWidget SCR_CampaignInfoDisplay.m_wLeftFlag

protected

m_wLeftScore

RichTextWidget SCR_CampaignInfoDisplay.m_wLeftScore

protected

m_wRightFlag

ImageWidget SCR_CampaignInfoDisplay.m_wRightFlag

protected

m_wRightScore

RichTextWidget SCR_CampaignInfoDisplay.m_wRightScore

protected

m_wWinScore

RichTextWidget SCR_CampaignInfoDisplay.m_wWinScore

protected

m_wWinScoreSideLeft

ImageWidget SCR_CampaignInfoDisplay.m_wWinScoreSideLeft

protected

m_wWinScoreSideRight

ImageWidget SCR_CampaignInfoDisplay.m_wWinScoreSideRight

protected

SIZE_NORMAL

const int SCR_CampaignInfoDisplay.SIZE_NORMAL = 20

staticprotected

SIZE_WINNER

const int SCR_CampaignInfoDisplay.SIZE_WINNER = 24

staticprotected

---

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

• Game/UI/HUD/SCR_CampaignInfoDisplay.c