SCR_MapUIElement Interface Reference

Inheritance diagram for SCR_MapUIElement:

Public Member Functions
override void	HandlerAttached (Widget w)
void	SetParent (SCR_MapUIElementContainer parent)
string	GetName ()
bool	GetIconVisible ()
void	ShowName (bool visible)
void	SetVisible (bool visible)
Widget	GetRoot ()
override bool	OnClick (Widget w, int x, int y, int button)
void	SelectIcon (bool invoke=true)
void	Select (bool select=true)
vector	GetPos ()
Color	GetColorForFaction (string factionKey)
RplId	GetSpawnPointId ()
void	SetName (string name)
Public Member Functions inherited from SCR_ScriptedWidgetComponent
Widget	GetRootWidget ()
bool	IsVisible ()

Public Attributes
ref Color	m_UnknownFactionColor
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Protected Member Functions
void	AnimExpand ()
void	AnimCollapse ()
void	PlayHoverSound (string sound)
void	SetImage (string image)

Protected Attributes
SCR_MapUIElementContainer	m_Parent
MapItem	m_MapItem
ImageWidget	m_wImage
ImageWidget	m_wGradient
ImageWidget	m_wSelectImg
ImageWidget	m_wHighlightImg
bool	m_bIsSelected
SCR_EIconType	m_eIconType
bool	m_bVisible = false
ResourceName	m_sImageSetARO
ResourceName	m_sImageSetSpecial
bool	m_bUseBackgroundGradient
string	m_sSoundBase
string	m_sSoundEnemyBase
string	m_sSoundRelay
string	m_sSoundTask
string	m_sSoundService
string	m_sSoundHover
string	m_sName
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
static SCR_MapUIElement	s_SelectedElement
const float	ANIM_SPEED = 20

Additional Inherited Members
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.

Member Function Documentation

AnimCollapse()

void SCR_MapUIElement.AnimCollapse ( )

protected

Implemented in SCR_CampaignMapUIBase, SCR_CampaignMapUIService, and SCR_TutorialMapUIBase.

AnimExpand()

void SCR_MapUIElement.AnimExpand ( )

protected

Implemented in SCR_CampaignMapUIBase, SCR_CampaignMapUIService, and SCR_TutorialMapUIBase.

GetColorForFaction()

Color SCR_MapUIElement.GetColorForFaction

(

string

factionKey

)

GetIconVisible()

bool SCR_MapUIElement.GetIconVisible

(

)

GetName()

string SCR_MapUIElement.GetName

(

)

GetPos()

vector SCR_MapUIElement.GetPos

(

)

Implemented in SCR_CampaignMapUIBase, SCR_CampaignMapUIPlayerHighlight, SCR_MapUISpawnPoint, SCR_TaskMapUIComponent, SCR_TutorialFastTravelMapElement, and SCR_TutorialMapUIBase.

GetRoot()

Widget SCR_MapUIElement.GetRoot

(

)

GetSpawnPointId()

RplId SCR_MapUIElement.GetSpawnPointId

(

)

Implemented in SCR_CampaignMapUIBase, and SCR_MapUISpawnPoint.

HandlerAttached()

override void SCR_MapUIElement.HandlerAttached

(

Widget

w

)

Implements SCR_ScriptedWidgetComponent.

Implemented in SCR_CampaignLogisticMapUIBase, SCR_CampaignMapUIBase, SCR_CampaignMapUIElement, SCR_CampaignMapUIService, SCR_MapUISpawnPoint, SCR_TaskMapUIComponent, SCR_TutorialMapUIBase, and SCR_TutorialTaskMapUIComponent.

OnClick()

override bool SCR_MapUIElement.OnClick	(	Widget	w,
		int	x,
		int	y,
		int	button )

Implements SCR_ScriptedWidgetComponent.

Implemented in SCR_CampaignLogisticMapUIBase, SCR_CampaignMapUIBase, SCR_CampaignMapUIService, and SCR_TutorialFastTravelMapElement.

PlayHoverSound()

void SCR_MapUIElement.PlayHoverSound ( string sound )

protected

Select()

void SCR_MapUIElement.Select

(

bool

select = true

)

Implemented in SCR_CampaignLogisticMapUIBase.

SelectIcon()

void SCR_MapUIElement.SelectIcon

(

bool

invoke = true

)

Implemented in SCR_CampaignMapUIBase, and SCR_MapUISpawnPoint.

SetImage()

void SCR_MapUIElement.SetImage ( string image )

protected

Implemented in SCR_CampaignMapUIBase, SCR_CampaignMapUIElement, SCR_CampaignMapUIService, and SCR_TutorialMapUIBase.

SetName()

void SCR_MapUIElement.SetName

(

string

name

)

Implemented in SCR_MapUISpawnPoint.

SetParent()

void SCR_MapUIElement.SetParent

(

SCR_MapUIElementContainer

parent

)

SetVisible()

void SCR_MapUIElement.SetVisible

(

bool

visible

)

ShowName()

void SCR_MapUIElement.ShowName

(

bool

visible

)

Implemented in SCR_CampaignMapUIBase.

Member Data Documentation

ANIM_SPEED

const float SCR_MapUIElement.ANIM_SPEED = 20

staticprotected

m_bIsSelected

bool SCR_MapUIElement.m_bIsSelected

protected

m_bUseBackgroundGradient

bool SCR_MapUIElement.m_bUseBackgroundGradient

protected

m_bVisible

bool SCR_MapUIElement.m_bVisible = false

protected

m_eIconType

SCR_EIconType SCR_MapUIElement.m_eIconType

protected

m_MapItem

MapItem SCR_MapUIElement.m_MapItem

protected

m_Parent

SCR_MapUIElementContainer SCR_MapUIElement.m_Parent

protected

m_sImageSetARO

ResourceName SCR_MapUIElement.m_sImageSetARO

protected

m_sImageSetSpecial

ResourceName SCR_MapUIElement.m_sImageSetSpecial

protected

m_sName

string SCR_MapUIElement.m_sName

protected

m_sSoundBase

string SCR_MapUIElement.m_sSoundBase

protected

m_sSoundEnemyBase

string SCR_MapUIElement.m_sSoundEnemyBase

protected

m_sSoundHover

string SCR_MapUIElement.m_sSoundHover

protected

m_sSoundRelay

string SCR_MapUIElement.m_sSoundRelay

protected

m_sSoundService

string SCR_MapUIElement.m_sSoundService

protected

m_sSoundTask

string SCR_MapUIElement.m_sSoundTask

protected

m_UnknownFactionColor

ref Color SCR_MapUIElement.m_UnknownFactionColor

m_wGradient

ImageWidget SCR_MapUIElement.m_wGradient

protected

m_wHighlightImg

ImageWidget SCR_MapUIElement.m_wHighlightImg

protected

m_wImage

ImageWidget SCR_MapUIElement.m_wImage

protected

m_wSelectImg

ImageWidget SCR_MapUIElement.m_wSelectImg

protected

s_SelectedElement

SCR_MapUIElement SCR_MapUIElement.s_SelectedElement

staticprotected

---

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

• Game/UI/Conflict/SCR_MapUIElement.c