SCR_MapDebugUI Interface Reference

Inheritance diagram for SCR_MapDebugUI:

Public Member Functions
void	SetPropsVisible (bool state)
	Sets visibility of a descriptor type props across all layers.
void	GetUnitName (IEntity ent, out string name, out notnull array< string > nameParams)
	Get/update name.
override void	Update (float timeSlice)
	Update method for frame operations.
override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
override void	Init ()
	Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.
Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()
bool	IsExclusive ()
void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events, called every time component is activated, usually on map open.
bool	IsToolMenuFocused ()
void	SCR_MapUIBaseComponent ()

Protected Member Functions
void	ShowUnits ()
	Show infantry units.
void	PanToPlayer ()
	Context callback.
void	ZoomToPPU1 ()
	Zooms to current pixel per unit ratio == 1.
void	ZoomLayerUp ()
	Zooms to the beginning of higher layer.
void	ZoomLayerDown ()
	Zooms to the ceiling of lower layer.
void	ToggleLight ()
	Toggle map light.
void	UpdateUnits ()
	Update unit map items.
void	OnRadialMenuOpen ()
Protected Member Functions inherited from SCR_MapUIBaseComponent
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

Protected Attributes
float	m_fUnitIconRotation
ResourceName	m_sIconImageset
bool	m_bIsUnitVisible
ref array< MapItem >	m_aMapItems = {}
SCR_MapDescriptorDefaults	m_DefaultsCfg
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bIsExclusive
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Member Function Documentation

GetUnitName()

void SCR_MapDebugUI.GetUnitName	(	IEntity	ent,
		out string	name,
		out notnull array< string >	nameParams )

Get/update name.

Parameters

	ent	is the subject
[out]	name	Name or formatting of name
[out]	nameParams	If uses formating: Firstname, Alias and Surname (Alias can be an empty string)

Init()

override void SCR_MapDebugUI.Init

(

)

Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.

Implements SCR_MapUIBaseComponent.

OnMapOpen()

override void SCR_MapDebugUI.OnMapOpen

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnRadialMenuOpen()

void SCR_MapDebugUI.OnRadialMenuOpen ( )

protected

PanToPlayer()

void SCR_MapDebugUI.PanToPlayer ( )

protected

Context callback.

SetPropsVisible()

void SCR_MapDebugUI.SetPropsVisible

(

bool

state

)

Sets visibility of a descriptor type props across all layers.

Parameters

state

determines visibility

ShowUnits()

void SCR_MapDebugUI.ShowUnits ( )

protected

Show infantry units.

ToggleLight()

void SCR_MapDebugUI.ToggleLight ( )

protected

Toggle map light.

Update()

override void SCR_MapDebugUI.Update

(

float

timeSlice

)

Update method for frame operations.

Implements SCR_MapUIBaseComponent.

UpdateUnits()

void SCR_MapDebugUI.UpdateUnits ( )

protected

Update unit map items.

ZoomLayerDown()

void SCR_MapDebugUI.ZoomLayerDown ( )

protected

Zooms to the ceiling of lower layer.

ZoomLayerUp()

void SCR_MapDebugUI.ZoomLayerUp ( )

protected

Zooms to the beginning of higher layer.

ZoomToPPU1()

void SCR_MapDebugUI.ZoomToPPU1 ( )

protected

Zooms to current pixel per unit ratio == 1.

Member Data Documentation

m_aMapItems

ref array<MapItem> SCR_MapDebugUI.m_aMapItems = {}

protected

m_bIsUnitVisible

bool SCR_MapDebugUI.m_bIsUnitVisible

protected

m_DefaultsCfg

SCR_MapDescriptorDefaults SCR_MapDebugUI.m_DefaultsCfg

protected

m_fUnitIconRotation

float SCR_MapDebugUI.m_fUnitIconRotation

protected

m_sIconImageset

ResourceName SCR_MapDebugUI.m_sIconImageset

protected

---

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

• Game/Map/ComponentsUI/SCR_MapDebugUI.c