SCR_MapMarkerEntity Interface Reference

Dynamic map marker entity base class Spawned by marker manager when creating a dynamic marker -> see marker config for customization. More...

Inheritance diagram for SCR_MapMarkerEntity:

Public Member Functions
void	SetLocalVisible (bool state)
SCR_EMapMarkerType	GetType ()
int	GetMarkerConfigID ()
void	SetText (string text)
string	GetText ()
void	SetImage (string imageset, string icon)
void	GetImageResource (out ResourceName imageset, out string imageQuad)
vector	GetWorldPos ()
	Get world position coordinates.
void	SetType (SCR_EMapMarkerType type, int configID=-1)
void	SetGlobalVisible (bool state)
IEntity	GetTarget ()
	Return entity this marker is tracking.
void	SetTarget (IEntity target)
	Set entity this marker is tracking.
Faction	GetFaction ()
void	SetFaction (Faction faction)
void	OnCreateMarker ()
	Fetch marker definition from config & create widget.
void	OnDelete ()
void	LayerChangeLogic (int layerID)
void	OnUpdate ()
	Called from SCR_MapMarkerManagerComponent.
void	SCR_MapMarkerEntity (IEntitySource src, IEntity parent)
void	~SCR_MapMarkerEntity ()

Protected Member Functions
void	OnUpdateType ()
	used client side for initial visibility set
void	OnUpdatePosition ()
	for override within children classes
void	OnUpdateVisibility ()
	Create or destroy marker widget based on current state.
bool	IsVisible ()
void	OnMapClosed (MapConfiguration config)
void	OnMapLayerChanged (int layerID)
override void	EOnInit (IEntity owner)
override void	EOnFrame (IEntity owner, float timeSlice)
	Authority side update.

Protected Attributes
SCR_EMapMarkerType	m_eType
int	m_iConfigID = -1
vector	m_vPos
bool	m_bIsGlobalVisible
bool	m_bIsLocalVisible = true
int	m_iScreenX
int	m_iScreenY
float	m_fUpdateDelay = 1
float	m_fTimeTracker
string	m_sText
ResourceName	m_sImageset
string	m_sIconName
SCR_MapMarkerEntryDynamic	m_ConfigEntry
Widget	m_wRoot
SCR_MapEntity	m_MapEntity
SCR_MapMarkerDynamicWComponent	m_MarkerWidgetComp
IEntity	m_Target
Faction	m_MarkerFaction

Detailed Description

Dynamic map marker entity base class Spawned by marker manager when creating a dynamic marker -> see marker config for customization.

Constructor & Destructor Documentation

SCR_MapMarkerEntity()

void SCR_MapMarkerEntity.SCR_MapMarkerEntity	(	IEntitySource	src,
		IEntity	parent
	)

~SCR_MapMarkerEntity()

void SCR_MapMarkerEntity.~SCR_MapMarkerEntity

(

)

Member Function Documentation

EOnFrame()

override void SCR_MapMarkerEntity.EOnFrame ( IEntity  owner, float  timeSlice  )

protected

Authority side update.

EOnInit()

override void SCR_MapMarkerEntity.EOnInit ( IEntity  owner )

protected

Implemented in SCR_MapMarkerSquadLeader.

GetFaction()

Faction SCR_MapMarkerEntity.GetFaction

(

)

GetImageResource()

void SCR_MapMarkerEntity.GetImageResource	(	out ResourceName	imageset,
		out string	imageQuad
	)

GetMarkerConfigID()

int SCR_MapMarkerEntity.GetMarkerConfigID

(

)

GetTarget()

IEntity SCR_MapMarkerEntity.GetTarget

(

)

Return entity this marker is tracking.

GetText()

string SCR_MapMarkerEntity.GetText

(

)

GetType()

SCR_EMapMarkerType SCR_MapMarkerEntity.GetType

(

)

GetWorldPos()

vector SCR_MapMarkerEntity.GetWorldPos

(

)

Get world position coordinates.

IsVisible()

bool SCR_MapMarkerEntity.IsVisible ( )

protected

LayerChangeLogic()

void SCR_MapMarkerEntity.LayerChangeLogic

(

int

layerID

)

OnCreateMarker()

void SCR_MapMarkerEntity.OnCreateMarker

(

)

Fetch marker definition from config & create widget.

Implemented in SCR_MapMarkerSquadLeader.

OnDelete()

void SCR_MapMarkerEntity.OnDelete

(

)

Implemented in SCR_MapMarkerSquadLeader.

OnMapClosed()

void SCR_MapMarkerEntity.OnMapClosed ( MapConfiguration  config )

protected

OnMapLayerChanged()

void SCR_MapMarkerEntity.OnMapLayerChanged ( int  layerID )

protected

Implemented in SCR_MapMarkerSquadLeader.

OnUpdate()

void SCR_MapMarkerEntity.OnUpdate

(

)

Called from SCR_MapMarkerManagerComponent.

Implemented in SCR_MapMarkerSquadLeader.

OnUpdatePosition()

void SCR_MapMarkerEntity.OnUpdatePosition ( )

protected

for override within children classes

OnUpdateType()

void SCR_MapMarkerEntity.OnUpdateType ( )

protected

used client side for initial visibility set

OnUpdateVisibility()

void SCR_MapMarkerEntity.OnUpdateVisibility ( )

protected

Create or destroy marker widget based on current state.

SetFaction()

void SCR_MapMarkerEntity.SetFaction

(

Faction

faction

)

SetGlobalVisible()

void SCR_MapMarkerEntity.SetGlobalVisible

(

bool

state

)

SetImage()

void SCR_MapMarkerEntity.SetImage	(	string	imageset,
		string	icon
	)

SetLocalVisible()

void SCR_MapMarkerEntity.SetLocalVisible

(

bool

state

)

SetTarget()

void SCR_MapMarkerEntity.SetTarget

(

IEntity

target

)

Set entity this marker is tracking.

SetText()

void SCR_MapMarkerEntity.SetText

(

string

text

)

SetType()

void SCR_MapMarkerEntity.SetType	(	SCR_EMapMarkerType	type,
		int	configID = -1
	)

Member Data Documentation

m_bIsGlobalVisible

bool SCR_MapMarkerEntity.m_bIsGlobalVisible

protected

m_bIsLocalVisible

bool SCR_MapMarkerEntity.m_bIsLocalVisible = true

protected

m_ConfigEntry

SCR_MapMarkerEntryDynamic SCR_MapMarkerEntity.m_ConfigEntry

protected

m_eType

SCR_EMapMarkerType SCR_MapMarkerEntity.m_eType

protected

m_fTimeTracker

float SCR_MapMarkerEntity.m_fTimeTracker

protected

m_fUpdateDelay

float SCR_MapMarkerEntity.m_fUpdateDelay = 1

protected

m_iConfigID

int SCR_MapMarkerEntity.m_iConfigID = -1

protected

m_iScreenX

int SCR_MapMarkerEntity.m_iScreenX

protected

m_iScreenY

int SCR_MapMarkerEntity.m_iScreenY

protected

m_MapEntity

SCR_MapEntity SCR_MapMarkerEntity.m_MapEntity

protected

m_MarkerFaction

Faction SCR_MapMarkerEntity.m_MarkerFaction

protected

m_MarkerWidgetComp

SCR_MapMarkerDynamicWComponent SCR_MapMarkerEntity.m_MarkerWidgetComp

protected

m_sIconName

string SCR_MapMarkerEntity.m_sIconName

protected

m_sImageset

ResourceName SCR_MapMarkerEntity.m_sImageset

protected

m_sText

string SCR_MapMarkerEntity.m_sText

protected

m_Target

IEntity SCR_MapMarkerEntity.m_Target

protected

m_vPos

vector SCR_MapMarkerEntity.m_vPos

protected

m_wRoot

Widget SCR_MapMarkerEntity.m_wRoot

protected

---

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

• Game/Map/Markers/Objects/SCR_MapMarkerEntity.c