SCR_MapDebugUI Class Reference

Inheritance diagram for SCR_MapDebugUI:

Protected Member Functions
void	ShowUnits ()
	Show infantry units.
void	SetPropsVisible (bool state)
void	GetUnitName (IEntity ent, out string name, out notnull array< string > nameParams)
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 ()
override void	Update (float timeSlice)
override void	OnMapOpen (MapConfiguration config)
override void	Init ()

Protected Attributes
float	m_fUnitIconRotation
ResourceName	m_sIconImageset
bool	m_bIsUnitVisible
ref array< MapItem >	m_aMapItems = {}
SCR_MapDescriptorDefaults	m_DefaultsCfg

Detailed Description

Definition at line 1 of file SCR_MapDebugUI.c.

Member Function Documentation

GetUnitName()

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

inlineprotected

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)

Definition at line 100 of file SCR_MapDebugUI.c.

Init()

override void SCR_MapDebugUI::Init ( )

inlineprotected

Definition at line 266 of file SCR_MapDebugUI.c.

OnMapOpen()

override void SCR_MapDebugUI::OnMapOpen ( MapConfiguration config )

inlineprotected

Definition at line 253 of file SCR_MapDebugUI.c.

OnRadialMenuOpen()

void SCR_MapDebugUI::OnRadialMenuOpen ( )

inlineprotected

Definition at line 205 of file SCR_MapDebugUI.c.

PanToPlayer()

void SCR_MapDebugUI::PanToPlayer ( )

inlineprotected

Context callback.

Definition at line 132 of file SCR_MapDebugUI.c.

SetPropsVisible()

void SCR_MapDebugUI::SetPropsVisible ( bool state )

inlineprotected

Sets visibility of a descriptor type props across all layers

Parameters

state

determines visibility

Definition at line 75 of file SCR_MapDebugUI.c.

ShowUnits()

void SCR_MapDebugUI::ShowUnits ( )

inlineprotected

Show infantry units.

Definition at line 16 of file SCR_MapDebugUI.c.

ToggleLight()

void SCR_MapDebugUI::ToggleLight ( )

inlineprotected

Toggle map light.

Definition at line 181 of file SCR_MapDebugUI.c.

Update()

override void SCR_MapDebugUI::Update ( float timeSlice )

inlineprotected

Definition at line 246 of file SCR_MapDebugUI.c.

UpdateUnits()

void SCR_MapDebugUI::UpdateUnits ( )

inlineprotected

Update unit map items.

Definition at line 190 of file SCR_MapDebugUI.c.

ZoomLayerDown()

void SCR_MapDebugUI::ZoomLayerDown ( )

inlineprotected

Zooms to the ceiling of lower layer.

Definition at line 168 of file SCR_MapDebugUI.c.

ZoomLayerUp()

void SCR_MapDebugUI::ZoomLayerUp ( )

inlineprotected

Zooms to the beginning of higher layer.

Definition at line 153 of file SCR_MapDebugUI.c.

ZoomToPPU1()

void SCR_MapDebugUI::ZoomToPPU1 ( )

inlineprotected

Zooms to current pixel per unit ratio == 1.

Definition at line 146 of file SCR_MapDebugUI.c.

Member Data Documentation

m_aMapItems

ref array<MapItem> SCR_MapDebugUI::m_aMapItems = {}

protected

Definition at line 10 of file SCR_MapDebugUI.c.

m_bIsUnitVisible

bool SCR_MapDebugUI::m_bIsUnitVisible

protected

Definition at line 9 of file SCR_MapDebugUI.c.

m_DefaultsCfg

SCR_MapDescriptorDefaults SCR_MapDebugUI::m_DefaultsCfg

protected

Definition at line 12 of file SCR_MapDebugUI.c.

m_fUnitIconRotation

float SCR_MapDebugUI::m_fUnitIconRotation

protected

Definition at line 4 of file SCR_MapDebugUI.c.

m_sIconImageset

ResourceName SCR_MapDebugUI::m_sIconImageset

protected

Definition at line 7 of file SCR_MapDebugUI.c.

---

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

• scripts/Game/Map/ComponentsUI/SCR_MapDebugUI.c