MarkerManager Class Reference

This class is used to create and clear gameplay markers, the on-screen indicators that point at a world position or at an object. Markers are identified by an id, and optionally by a group id. Creating a marker with an id that already exists replaces the existing marker. More...

Public Member Functions
void	CreateGlobalMarker (Context instigator, string id, int markerType, Context targetObject, UnityEngine.Vector3 offset, UnityEngine.Color color)
	Creates a marker that follows a world object and is visible to every player.
void	CreateGlobalMarker (Context instigator, string id, string groupId, int markerType, Context targetObject, UnityEngine.Vector3 offset, UnityEngine.Color color)
	Creates a marker in a group that follows a world object and is visible to every player.
void	CreateMarkerForPlayer (Context instigator, Context player, string id, int markerType, Context targetObject, UnityEngine.Vector3 offset, UnityEngine.Color color)
	Creates a marker that follows a world object and is only visible to the given player.
void	CreateMarkerForPlayer (Context instigator, Context player, string id, string groupId, int markerType, Context targetObject, UnityEngine.Vector3 offset, UnityEngine.Color color)
	Creates a marker in a group that follows a world object and is only visible to the given player.
void	ClearGlobalMarker (Context instigator, string id)
	Clears a marker that is visible to every player.
void	ClearGlobalMarker (Context instigator, string id, string groupId)
	Clears a marker that is only visible to the given player.
void	ClearGlobalMarkerGroup (Context instigator, string groupId)
	Clears a marker that is visible to every player.
void	ClearMarkerForPlayer (Context instigator, Context player, string id)
	Clears a marker that is only visible to the given player.
void	ClearMarkerForPlayer (Context instigator, Context player, string id, string groupId)
	Clears a marker that is only visible to the given player.
void	ClearMarkerGroupForPlayer (Context instigator, Context player, string groupId)
	Clears a marker that is only visible to the given player.

Detailed Description

This class is used to create and clear gameplay markers, the on-screen indicators that point at a world position or at an object. Markers are identified by an id, and optionally by a group id. Creating a marker with an id that already exists replaces the existing marker.

Member Function Documentation

ClearGlobalMarker() [1/2]

void ClearGlobalMarker	(	Context	instigator,
		string	id )

Clears a marker that is visible to every player.

Parameters

instigator	The source context of this change
id	The id of the marker to clear.

ClearGlobalMarker() [2/2]

void ClearGlobalMarker	(	Context	instigator,
		string	id,
		string	groupId )

Clears a marker that is only visible to the given player.

Parameters

instigator	The source context of this change
id	The id of the marker to clear.
groupId	The id of the group to clear.

ClearGlobalMarkerGroup()

void ClearGlobalMarkerGroup	(	Context	instigator,
		string	groupId )

Clears a marker that is visible to every player.

Parameters

instigator	The source context of this change
groupId	The id of the group to clear.

ClearMarkerForPlayer() [1/2]

void ClearMarkerForPlayer	(	Context	instigator,
		Context	player,
		string	id )

Clears a marker that is only visible to the given player.

Parameters

instigator	The source context of this change
player	The context of the player the marker was created for.
id	The id of the marker to clear.

ClearMarkerForPlayer() [2/2]

void ClearMarkerForPlayer	(	Context	instigator,
		Context	player,
		string	id,
		string	groupId )

Clears a marker that is only visible to the given player.

Parameters

instigator	The source context of this change
player	The context of the player the marker was created for.
id	The id of the marker to clear.
groupId	The id of the group to clear.

ClearMarkerGroupForPlayer()

void ClearMarkerGroupForPlayer	(	Context	instigator,
		Context	player,
		string	groupId )

Clears a marker that is only visible to the given player.

Parameters

instigator	The source context of this change
player	The context of the player the marker was created for.
groupId	The id of the group to clear.

CreateGlobalMarker() [1/2]

void CreateGlobalMarker	(	Context	instigator,
		string	id,
		int	markerType,
		Context	targetObject,
		UnityEngine.Vector3	offset,
		UnityEngine.Color	color )

Creates a marker that follows a world object and is visible to every player.

Parameters

instigator	The source context of this change
id	The id identifying this marker, used to clear it later.
markerType	The type of marker as MarkerType
targetObject	The context of the world object the marker will follow.
offset	The offset from the target object to place the marker at.
color	The color of the marker.

CreateGlobalMarker() [2/2]

void CreateGlobalMarker	(	Context	instigator,
		string	id,
		string	groupId,
		int	markerType,
		Context	targetObject,
		UnityEngine.Vector3	offset,
		UnityEngine.Color	color )

Creates a marker in a group that follows a world object and is visible to every player.

Parameters

instigator	The source context of this change
id	The id identifying this marker, used to clear it later.
groupId	The id of the group this marker belongs to.
markerType	The type of marker as MarkerType
targetObject	The context of the world object the marker will follow.
offset	The offset from the target object to place the marker at.
color	The color of the marker.

CreateMarkerForPlayer() [1/2]

void CreateMarkerForPlayer	(	Context	instigator,
		Context	player,
		string	id,
		int	markerType,
		Context	targetObject,
		UnityEngine.Vector3	offset,
		UnityEngine.Color	color )

Creates a marker that follows a world object and is only visible to the given player.

Parameters

instigator	The source context of this change
player	The context of the player that will see this marker.
id	The id identifying this marker, used to clear it later.
markerType	The type of marker as MarkerType
targetObject	The context of the world object the marker will follow.
offset	The offset from the target object to place the marker at.
color	The color of the marker.

CreateMarkerForPlayer() [2/2]

void CreateMarkerForPlayer	(	Context	instigator,
		Context	player,
		string	id,
		string	groupId,
		int	markerType,
		Context	targetObject,
		UnityEngine.Vector3	offset,
		UnityEngine.Color	color )

Creates a marker in a group that follows a world object and is only visible to the given player.

Parameters

instigator	The source context of this change
player	The context of the player that will see this marker.
id	The id identifying this marker, used to clear it later.
groupId	The id of the group this marker belongs to.
markerType	The type of marker as MarkerType
targetObject	The context of the world object the marker will follow.
offset	The offset from the target object to place the marker at.
color	The color of the marker.