SCR_ScenarioFrameworkTriggerCountdownDisplay Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkTriggerCountdownDisplay:

Public Member Functions
override void	DisplayStartDraw (IEntity owner)
	Starts drawing the display.
override void	DisplayUpdate (IEntity owner, float timeSlice)
	Periodically updates the HUD.
void	HandleHUD ()
	Handles if HUD should be enabled or disabled.
void	RetrieveTriggerInfo (float activationCountdownTimer, float tempWaitTime, int playersCountByFactionInside, int playersCountByFaction, string playerActivationNotificationTitle, bool triggerConditionsStatus, float minimumPlayersNeededPercentage)
	Handles if HUD should be enabled or disabled.
void	RetrieveCountInsideTrigger (int countInsideTrigger)
	Retrieves count inside trigger for turning off the HUD in cases where player owning this display is not inside.
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	ShowHUD (bool show)
	Toggles if HUD should be shown or hidden.
void	UpdateHUD ()
	Updates HUD according to the values and conditions acquired from the trigger.
Protected Member Functions inherited from SCR_InfoDisplayExtended
bool	DisplayStartDrawInit (IEntity owner)
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_bTriggerConditionsStatus
int	m_iPlayersCountByFactionInside
int	m_iPlayersCountByFaction
float	m_fTempTimeSlice
float	m_fActivationCountdownTimer
float	m_fTempWaitTime
float	m_fMinimumPlayersNeededPercentage
string	m_sPlayerActivationNotificationTitle
Widget	m_wInfoOverlay
Widget	m_wCountdownOverlay
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()

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_ScenarioFrameworkTriggerCountdownDisplay.DisplayStartDraw

(

IEntity

owner

)

Starts drawing the display.

Implements SCR_InfoDisplayExtended.

DisplayUpdate()

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

Periodically updates the HUD.

Implements SCR_InfoDisplayExtended.

HandleHUD()

void SCR_ScenarioFrameworkTriggerCountdownDisplay.HandleHUD

(

)

Handles if HUD should be enabled or disabled.

RetrieveCountInsideTrigger()

void SCR_ScenarioFrameworkTriggerCountdownDisplay.RetrieveCountInsideTrigger

(

int

countInsideTrigger

)

Retrieves count inside trigger for turning off the HUD in cases where player owning this display is not inside.

RetrieveTriggerInfo()

void SCR_ScenarioFrameworkTriggerCountdownDisplay.RetrieveTriggerInfo	(	float	activationCountdownTimer,
		float	tempWaitTime,
		int	playersCountByFactionInside,
		int	playersCountByFaction,
		string	playerActivationNotificationTitle,
		bool	triggerConditionsStatus,
		float	minimumPlayersNeededPercentage )

Handles if HUD should be enabled or disabled.

ShowHUD()

void SCR_ScenarioFrameworkTriggerCountdownDisplay.ShowHUD ( bool show )

protected

Toggles if HUD should be shown or hidden.

UpdateHUD()

void SCR_ScenarioFrameworkTriggerCountdownDisplay.UpdateHUD ( )

protected

Updates HUD according to the values and conditions acquired from the trigger.

Member Data Documentation

m_bTriggerConditionsStatus

bool SCR_ScenarioFrameworkTriggerCountdownDisplay.m_bTriggerConditionsStatus

protected

m_fActivationCountdownTimer

float SCR_ScenarioFrameworkTriggerCountdownDisplay.m_fActivationCountdownTimer

protected

m_fMinimumPlayersNeededPercentage

float SCR_ScenarioFrameworkTriggerCountdownDisplay.m_fMinimumPlayersNeededPercentage

protected

m_fTempTimeSlice

float SCR_ScenarioFrameworkTriggerCountdownDisplay.m_fTempTimeSlice

protected

m_fTempWaitTime

float SCR_ScenarioFrameworkTriggerCountdownDisplay.m_fTempWaitTime

protected

m_iPlayersCountByFaction

int SCR_ScenarioFrameworkTriggerCountdownDisplay.m_iPlayersCountByFaction

protected

m_iPlayersCountByFactionInside

int SCR_ScenarioFrameworkTriggerCountdownDisplay.m_iPlayersCountByFactionInside

protected

m_sPlayerActivationNotificationTitle

string SCR_ScenarioFrameworkTriggerCountdownDisplay.m_sPlayerActivationNotificationTitle

protected

m_wCountdown

RichTextWidget SCR_ScenarioFrameworkTriggerCountdownDisplay.m_wCountdown

protected

m_wCountdownOverlay

Widget SCR_ScenarioFrameworkTriggerCountdownDisplay.m_wCountdownOverlay

protected

m_wFlavour

RichTextWidget SCR_ScenarioFrameworkTriggerCountdownDisplay.m_wFlavour

protected

m_wInfoOverlay

Widget SCR_ScenarioFrameworkTriggerCountdownDisplay.m_wInfoOverlay

protected

---

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

• Game/UI/ScenarioFramework/SCR_ScenarioFrameworkTriggerCountdownDisplay.c