SCR_CampaignMapInfoDisplay Interface Reference

Inheritance diagram for SCR_CampaignMapInfoDisplay:

Public Member Functions
override bool	DisplayStartDrawInit (IEntity owner)
override void	DisplayStartDraw (IEntity owner)
override void	DisplayStopDraw (IEntity owner)
override void	UpdateHUD ()
override void	UpdateHUDValues ()
void	OnMapOpen (MapConfiguration config)
void	OnMapClose (MapConfiguration config)
Public Member Functions inherited from SCR_CampaignInfoDisplay
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	SetPlatformImage (bool setVisible, int commanderId, notnull SCR_PlayerController playerController)
void	OnFactionCommanderChanged (SCR_Faction faction, int commanderPlayerId)
Protected Member Functions inherited from SCR_CampaignInfoDisplay
void	HideHUD ()
Protected Member Functions inherited from SCR_InfoDisplayExtended
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_bMapOpen
bool	m_bCommanderRoleEnabled
bool	m_bIsPlayerCommander
Widget	m_wCommanderNameWrapper
ImageWidget	m_wPlatformIcon
RichTextWidget	m_wCommanderName
Widget	m_wPlatformScale
MapConfiguration	m_MapConfig
BaseContainer	m_GameplaySettings
Protected Attributes inherited from SCR_CampaignInfoDisplay
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
const string	CURRENT_COMMANDER_AI_TEXT = "#AR-FactionCommander_CurrentCommander_AI"
const string	CURRENT_COMMANDER_PLAYER_TEXT = "#AR-FactionCommander_CurrentCommander"
Static Protected Attributes inherited from SCR_CampaignInfoDisplay
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_CampaignMapInfoDisplay.DisplayStartDraw

(

IEntity

owner

)

Implements SCR_CampaignInfoDisplay.

DisplayStartDrawInit()

override bool SCR_CampaignMapInfoDisplay.DisplayStartDrawInit

(

IEntity

owner

)

Implements SCR_CampaignInfoDisplay.

DisplayStopDraw()

override void SCR_CampaignMapInfoDisplay.DisplayStopDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

OnFactionCommanderChanged()

void SCR_CampaignMapInfoDisplay.OnFactionCommanderChanged ( SCR_Faction faction, int commanderPlayerId )

protected

OnMapClose()

void SCR_CampaignMapInfoDisplay.OnMapClose

(

MapConfiguration

config

)

OnMapOpen()

void SCR_CampaignMapInfoDisplay.OnMapOpen

(

MapConfiguration

config

)

SetPlatformImage()

void SCR_CampaignMapInfoDisplay.SetPlatformImage ( bool setVisible, int commanderId, notnull SCR_PlayerController playerController )

protected

UpdateHUD()

override void SCR_CampaignMapInfoDisplay.UpdateHUD

(

)

Implements SCR_CampaignInfoDisplay.

UpdateHUDValues()

override void SCR_CampaignMapInfoDisplay.UpdateHUDValues

(

)

Implements SCR_CampaignInfoDisplay.

Member Data Documentation

CURRENT_COMMANDER_AI_TEXT

const string SCR_CampaignMapInfoDisplay.CURRENT_COMMANDER_AI_TEXT = "#AR-FactionCommander_CurrentCommander_AI"

staticprotected

CURRENT_COMMANDER_PLAYER_TEXT

const string SCR_CampaignMapInfoDisplay.CURRENT_COMMANDER_PLAYER_TEXT = "#AR-FactionCommander_CurrentCommander"

staticprotected

m_bCommanderRoleEnabled

bool SCR_CampaignMapInfoDisplay.m_bCommanderRoleEnabled

protected

m_bIsPlayerCommander

bool SCR_CampaignMapInfoDisplay.m_bIsPlayerCommander

protected

m_bMapOpen

bool SCR_CampaignMapInfoDisplay.m_bMapOpen

protected

m_GameplaySettings

BaseContainer SCR_CampaignMapInfoDisplay.m_GameplaySettings

protected

m_MapConfig

MapConfiguration SCR_CampaignMapInfoDisplay.m_MapConfig

protected

m_wCommanderName

RichTextWidget SCR_CampaignMapInfoDisplay.m_wCommanderName

protected

m_wCommanderNameWrapper

Widget SCR_CampaignMapInfoDisplay.m_wCommanderNameWrapper

protected

m_wPlatformIcon

ImageWidget SCR_CampaignMapInfoDisplay.m_wPlatformIcon

protected

m_wPlatformScale

Widget SCR_CampaignMapInfoDisplay.m_wPlatformScale

protected

---

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

• Game/UI/HUD/SCR_CampaignMapInfoDisplay.c