Map marker layout component Attached to root of marker base layout. More...

Inheritance diagram for SCR_MapMarkerWidgetComponent:

Public Member Functions
void	SetMarkerObject (notnull SCR_MapMarkerBase marker)

void	SetLayerID (int id)

void	SetRotation (float angle)

void	SetImage (ResourceName icon, string quad, float aspectRatio=1)
	Supports custom aspect ratio in case of non standard size imagesets.

void	SetGlowImage (ResourceName icon, string quad)

void	SetMilitarySymbolMode (bool state)
	Set visual mode for military symbol which is constructed through additional component.

void	SetEventListening (bool state)

void	UpdateMilitarySymbol (SCR_MilitarySymbol milSymbol)

void	SetText (string text, bool skipProfanityFilter=false)

void	SetTextVisible (bool state)

void	SetTypeIcon (int type, string text)
	Not synched secondary text.

void	SetTypeIconsVisible (bool state)

void	SetAuthor (string text)

void	SetAuthorVisible (bool state)

void	SetModeIcon (bool state, bool isPublic)

void	SetColor (Color color)

ImageWidget	GetAuthorPlatformIcon ()

void	SetTimestamp (WorldTimestamp timestamp)

void	SetTimestampVisibility (bool isVisible)

void	UpdateTimestamp (WorldTimestamp timestamp)

override bool	OnMouseEnter (Widget w, int x, int y)

override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)

override bool	OnFocus (Widget w, int x, int y)

override bool	OnFocusLost (Widget w, int x, int y)

override void	HandlerAttached (Widget w)

override void	HandlerDeattached (Widget w)

Public Member Functions inherited from SCR_ScriptedWidgetComponent
override bool	OnClick (Widget w, int x, int y, int button)

Widget	GetRootWidget ()

bool	IsVisible ()

Protected Member Functions
void	OnFilteredCallback (array< string > text)

void	UpdateCachedTimestamp ()

void	OnMapClose (MapConfiguration config)

Protected Attributes
bool	m_bIsEventListening
	in milliseconds

bool	m_bIsSymbolMode

bool	m_bIsOwnerMode

int	m_iLayerID

WorldTimestamp	m_Timestamp

bool	m_bIsTimestampVisible

ImageWidget	m_wMarkerIcon

ImageWidget	m_wMarkerGlowIcon

ImageWidget	m_wMarkerModeIcon

ImageWidget	m_wAuthorPlatformIcon

TextWidget	m_wMarkerText

TextWidget	m_wMarkerAuthor

TextWidget	m_wTypeIcon1

TextWidget	m_wTypeIcon2

TextWidget	m_wTypeIcon3

Widget	m_wSymbolRoot

Widget	m_wSymbolOverlay

Widget	m_wTypeIconRoot

Widget	m_wTypeOverlay1

Widget	m_wTypeOverlay2

Widget	m_wTypeOverlay3

TextWidget	m_wMarkerTimestamp

ref Color	m_GlowDefault = Color.FromSRGBA(21, 29, 32, 155)

ref Color	m_GlowSelected = Color.FromSRGBA(226, 168, 79, 155)

ref Color	m_TextColor = new Color(0.0, 0.0, 0.0, 1.0)

ref Color	m_CurrentImageColor = new Color(0.0, 0.0, 0.0, 1.0)

SCR_MapMarkerBase	m_MarkerObject

SCR_MapMarkerManagerComponent	m_MapMarkerManager

Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
const string	PRIVATE_QUAD = "private"

const string	PUBLIC_QUAD = "public"

const string	AUTHOR_NAME_FORMAT = "[%1]"

const int	UPDATE_TIMESTAMP_INTERVAL = 10000

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.

Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Detailed Description

Map marker layout component Attached to root of marker base layout.

Member Function Documentation

◆ GetAuthorPlatformIcon()

ImageWidget SCR_MapMarkerWidgetComponent.GetAuthorPlatformIcon ( )

◆ HandlerAttached()

override void SCR_MapMarkerWidgetComponent.HandlerAttached ( Widget w )

Implements SCR_ScriptedWidgetComponent.

◆ HandlerDeattached()

override void SCR_MapMarkerWidgetComponent.HandlerDeattached ( Widget w )

◆ OnFilteredCallback()

void SCR_MapMarkerWidgetComponent.OnFilteredCallback ( array< string > text )

protected

◆ OnFocus()

override bool SCR_MapMarkerWidgetComponent.OnFocus	(	Widget	w,
		int	x,
		int	y )

◆ OnFocusLost()

override bool SCR_MapMarkerWidgetComponent.OnFocusLost	(	Widget	w,
		int	x,
		int	y )

◆ OnMapClose()

void SCR_MapMarkerWidgetComponent.OnMapClose ( MapConfiguration config )

protected

◆ OnMouseEnter()

override bool SCR_MapMarkerWidgetComponent.OnMouseEnter	(	Widget	w,
		int	x,
		int	y )

◆ OnMouseLeave()

override bool SCR_MapMarkerWidgetComponent.OnMouseLeave	(	Widget	w,
		Widget	enterW,
		int	x,
		int	y )

◆ SetAuthor()

void SCR_MapMarkerWidgetComponent.SetAuthor ( string text )

Parameters

[in] text

◆ SetAuthorVisible()

void SCR_MapMarkerWidgetComponent.SetAuthorVisible ( bool state )

Parameters

[in] state

◆ SetColor()

void SCR_MapMarkerWidgetComponent.SetColor ( Color color )

Parameters

[in] color

◆ SetEventListening()

void SCR_MapMarkerWidgetComponent.SetEventListening ( bool state )

Parameters

[in] state

◆ SetGlowImage()

void SCR_MapMarkerWidgetComponent.SetGlowImage	(	ResourceName	icon,
		string	quad )

Parameters

[in]	icon
[in]	quad

◆ SetImage()

void SCR_MapMarkerWidgetComponent.SetImage	(	ResourceName	icon,
		string	quad,
		float	aspectRatio = 1 )

Supports custom aspect ratio in case of non standard size imagesets.

Parameters

[in]	icon
[in]	quad
[in]	aspectRatio

◆ SetLayerID()

void SCR_MapMarkerWidgetComponent.SetLayerID ( int id )

Parameters

[in] id

◆ SetMarkerObject()

void SCR_MapMarkerWidgetComponent.SetMarkerObject ( notnull SCR_MapMarkerBase marker )

Parameters

[in] marker

◆ SetMilitarySymbolMode()

void SCR_MapMarkerWidgetComponent.SetMilitarySymbolMode ( bool state )

Set visual mode for military symbol which is constructed through additional component.

Parameters

[in] state

◆ SetModeIcon()

void SCR_MapMarkerWidgetComponent.SetModeIcon	(	bool	state,
		bool	isPublic )

Parameters

[in]	state
[in]	isPublic

◆ SetRotation()

void SCR_MapMarkerWidgetComponent.SetRotation ( float angle )

Parameters

[in] angle

◆ SetText()

void SCR_MapMarkerWidgetComponent.SetText	(	string	text,
		bool	skipProfanityFilter = false )

Parameters

[in]	text
[in]	skipProfanityFilter	determines whether the marker text should be checked for profanity

◆ SetTextVisible()

void SCR_MapMarkerWidgetComponent.SetTextVisible ( bool state )

Parameters

[in] state

◆ SetTimestamp()

void SCR_MapMarkerWidgetComponent.SetTimestamp ( WorldTimestamp timestamp )

Parameters

[in] timestamp

◆ SetTimestampVisibility()

void SCR_MapMarkerWidgetComponent.SetTimestampVisibility ( bool isVisible )

◆ SetTypeIcon()

void SCR_MapMarkerWidgetComponent.SetTypeIcon	(	int	type,
		string	text )

Not synched secondary text.

◆ SetTypeIconsVisible()

void SCR_MapMarkerWidgetComponent.SetTypeIconsVisible ( bool state )

Parameters

[in] state

◆ UpdateCachedTimestamp()

void SCR_MapMarkerWidgetComponent.UpdateCachedTimestamp ( )

protected

◆ UpdateMilitarySymbol()

void SCR_MapMarkerWidgetComponent.UpdateMilitarySymbol ( SCR_MilitarySymbol milSymbol )

Parameters

[in] milSymbol

◆ UpdateTimestamp()

void SCR_MapMarkerWidgetComponent.UpdateTimestamp ( WorldTimestamp timestamp )

Parameters

[in] timestamp

Member Data Documentation

◆ AUTHOR_NAME_FORMAT

const string SCR_MapMarkerWidgetComponent.AUTHOR_NAME_FORMAT = "[%1]"

staticprotected

◆ m_bIsEventListening

bool SCR_MapMarkerWidgetComponent.m_bIsEventListening

protected

in milliseconds

◆ m_bIsOwnerMode

bool SCR_MapMarkerWidgetComponent.m_bIsOwnerMode

protected

◆ m_bIsSymbolMode

bool SCR_MapMarkerWidgetComponent.m_bIsSymbolMode

protected

◆ m_bIsTimestampVisible

bool SCR_MapMarkerWidgetComponent.m_bIsTimestampVisible

protected

◆ m_CurrentImageColor

ref Color SCR_MapMarkerWidgetComponent.m_CurrentImageColor = new Color(0.0, 0.0, 0.0, 1.0)

protected

◆ m_GlowDefault

ref Color SCR_MapMarkerWidgetComponent.m_GlowDefault = Color.FromSRGBA(21, 29, 32, 155)

protected

◆ m_GlowSelected

ref Color SCR_MapMarkerWidgetComponent.m_GlowSelected = Color.FromSRGBA(226, 168, 79, 155)

protected

◆ m_iLayerID

int SCR_MapMarkerWidgetComponent.m_iLayerID

protected

◆ m_MapMarkerManager

SCR_MapMarkerManagerComponent SCR_MapMarkerWidgetComponent.m_MapMarkerManager

protected

◆ m_MarkerObject

SCR_MapMarkerBase SCR_MapMarkerWidgetComponent.m_MarkerObject

protected

◆ m_TextColor

ref Color SCR_MapMarkerWidgetComponent.m_TextColor = new Color(0.0, 0.0, 0.0, 1.0)

protected

◆ m_Timestamp

WorldTimestamp SCR_MapMarkerWidgetComponent.m_Timestamp

protected

◆ m_wAuthorPlatformIcon

ImageWidget SCR_MapMarkerWidgetComponent.m_wAuthorPlatformIcon

protected

◆ m_wMarkerAuthor

TextWidget SCR_MapMarkerWidgetComponent.m_wMarkerAuthor

protected

◆ m_wMarkerGlowIcon

ImageWidget SCR_MapMarkerWidgetComponent.m_wMarkerGlowIcon

protected

◆ m_wMarkerIcon

ImageWidget SCR_MapMarkerWidgetComponent.m_wMarkerIcon

protected

◆ m_wMarkerModeIcon

ImageWidget SCR_MapMarkerWidgetComponent.m_wMarkerModeIcon

protected

◆ m_wMarkerText

TextWidget SCR_MapMarkerWidgetComponent.m_wMarkerText

protected

◆ m_wMarkerTimestamp

TextWidget SCR_MapMarkerWidgetComponent.m_wMarkerTimestamp

protected

◆ m_wSymbolOverlay

Widget SCR_MapMarkerWidgetComponent.m_wSymbolOverlay

protected

◆ m_wSymbolRoot

Widget SCR_MapMarkerWidgetComponent.m_wSymbolRoot

protected

◆ m_wTypeIcon1

TextWidget SCR_MapMarkerWidgetComponent.m_wTypeIcon1

protected

◆ m_wTypeIcon2

TextWidget SCR_MapMarkerWidgetComponent.m_wTypeIcon2

protected

◆ m_wTypeIcon3

TextWidget SCR_MapMarkerWidgetComponent.m_wTypeIcon3

protected

◆ m_wTypeIconRoot

Widget SCR_MapMarkerWidgetComponent.m_wTypeIconRoot

protected

◆ m_wTypeOverlay1

Widget SCR_MapMarkerWidgetComponent.m_wTypeOverlay1

protected

◆ m_wTypeOverlay2

Widget SCR_MapMarkerWidgetComponent.m_wTypeOverlay2

protected

◆ m_wTypeOverlay3

Widget SCR_MapMarkerWidgetComponent.m_wTypeOverlay3

protected

◆ PRIVATE_QUAD

const string SCR_MapMarkerWidgetComponent.PRIVATE_QUAD = "private"

staticprotected

◆ PUBLIC_QUAD

const string SCR_MapMarkerWidgetComponent.PUBLIC_QUAD = "public"

staticprotected

◆ UPDATE_TIMESTAMP_INTERVAL

const int SCR_MapMarkerWidgetComponent.UPDATE_TIMESTAMP_INTERVAL = 10000

staticprotected

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

Game/Map/Markers/SCR_MapMarkerWidgetComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetAuthorPlatformIcon()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ OnFilteredCallback()

◆ OnFocus()

◆ OnFocusLost()

◆ OnMapClose()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ SetAuthor()

◆ SetAuthorVisible()

◆ SetColor()

◆ SetEventListening()

◆ SetGlowImage()

◆ SetImage()

◆ SetLayerID()

◆ SetMarkerObject()

◆ SetMilitarySymbolMode()

◆ SetModeIcon()

◆ SetRotation()

◆ SetText()

◆ SetTextVisible()

◆ SetTimestamp()

◆ SetTimestampVisibility()

◆ SetTypeIcon()

◆ SetTypeIconsVisible()

◆ UpdateCachedTimestamp()

◆ UpdateMilitarySymbol()

◆ UpdateTimestamp()

Member Data Documentation

◆ AUTHOR_NAME_FORMAT

◆ m_bIsEventListening

◆ m_bIsOwnerMode

◆ m_bIsSymbolMode

◆ m_bIsTimestampVisible

◆ m_CurrentImageColor

◆ m_GlowDefault

◆ m_GlowSelected

◆ m_iLayerID

◆ m_MapMarkerManager

◆ m_MarkerObject

◆ m_TextColor

◆ m_Timestamp

◆ m_wAuthorPlatformIcon

◆ m_wMarkerAuthor

◆ m_wMarkerGlowIcon

◆ m_wMarkerIcon

◆ m_wMarkerModeIcon

◆ m_wMarkerText

◆ m_wMarkerTimestamp

◆ m_wSymbolOverlay

◆ m_wSymbolRoot

◆ m_wTypeIcon1

◆ m_wTypeIcon2

◆ m_wTypeIcon3

◆ m_wTypeIconRoot

◆ m_wTypeOverlay1

◆ m_wTypeOverlay2

◆ m_wTypeOverlay3

◆ PRIVATE_QUAD

◆ PUBLIC_QUAD

◆ UPDATE_TIMESTAMP_INTERVAL