Class WorldMarkerManager

World marker list and management for a single user. Global ones are held elsewhere.

Inheritance
System.Object
WorldMarkerManager
Namespace: Eco.Gameplay.UI.WorldMarker
Assembly: Eco.Gameplay.dll
Syntax
[ChatCommandHandler]
public class WorldMarkerManager : Object, IController, IViewController, IHasUniversalID

Constructors

WorldMarkerManager()

Declaration
public WorldMarkerManager()

Fields

GroupMarkerParts

Declaration
public ThreadSafeList<GroupMarkerPart> GroupMarkerParts
Field Value
Type Description
ThreadSafeList<GroupMarkerPart>

Properties

AllMarkers

Declaration
public IEnumerable<WorldMarker> AllMarkers { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<WorldMarker>

ControllerID

Declaration
public ref int ControllerID { get; }
Property Value
Type Description
System.Int32

DisabledFolders

Declaration
public ThreadSafeHashSet<string> DisabledFolders { get; }
Property Value
Type Description
ThreadSafeHashSet<System.String>

DisabledMarkers

Declaration
public ThreadSafeHashSet<WorldMarker> DisabledMarkers { get; }
Property Value
Type Description
ThreadSafeHashSet<WorldMarker>

List

Declaration
public ControllerList<WorldMarker> List { get; }
Property Value
Type Description
ControllerList<WorldMarker>

OnMarkerOpen

Declaration
public ThreadSafeAction<WorldMarker> OnMarkerOpen { get; }
Property Value
Type Description
ThreadSafeAction<WorldMarker>

Methods

Add(User, Vector3i, String, Boolean, Boolean, MarkerFolderName)

Declaration
public WorldMarker Add(User user, Vector3i pos, string text, bool useExistingIfAtPosition, bool isTutorialMarker = false, MarkerFolderName folderStructure)
Parameters
Type Name Description
User user
Vector3i pos
System.String text
System.Boolean useExistingIfAtPosition
System.Boolean isTutorialMarker
MarkerFolderName folderStructure
Returns
Type Description
WorldMarker

Clear(Player)

Declaration
public void Clear(Player player)
Parameters
Type Name Description
Player player

EnableAllMarkers(Boolean)

Declaration
public void EnableAllMarkers(bool enable)
Parameters
Type Name Description
System.Boolean enable

EnableMarker(WorldMarker, Boolean)

Declaration
public void EnableMarker(WorldMarker marker, bool enable)
Parameters
Type Name Description
WorldMarker marker
System.Boolean enable

FolderDestroyed(String)

Declaration
public void FolderDestroyed(string folder)
Parameters
Type Name Description
System.String folder

FolderStateChanged(String, Boolean)

Declaration
public void FolderStateChanged(string folder, bool enabled)
Parameters
Type Name Description
System.String folder
System.Boolean enabled

Initialize(Action)

Declaration
public void Initialize(Action save)
Parameters
Type Name Description
System.Action save

Mark(User, String)

Declaration
[ChatSubCommand]
public static bool Mark(User user, string text = null)
Parameters
Type Name Description
User user
System.String text
Returns
Type Description
System.Boolean

MarkGlobal(User, String)

Declaration
[ChatSubCommand]
public static bool MarkGlobal(User user, string text = null)
Parameters
Type Name Description
User user
System.String text
Returns
Type Description
System.Boolean

Remove(WorldMarker)

Declaration
public void Remove(WorldMarker worldMarker)
Parameters
Type Name Description
WorldMarker worldMarker

Remove(IEnumerable<WorldMarker>)

Declaration
public void Remove(IEnumerable<WorldMarker> worldMarkers)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<WorldMarker> worldMarkers

RemoveAll(Predicate<WorldMarker>)

Declaration
public void RemoveAll(Predicate<WorldMarker> markerPredicate)
Parameters
Type Name Description
System.Predicate<WorldMarker> markerPredicate

RemoveGroupPartMarker(Guid)

Declaration
public void RemoveGroupPartMarker(Guid id)
Parameters
Type Name Description
System.Guid id

RemoveMarkerAt(Vector3i)

Declaration
public void RemoveMarkerAt(Vector3i pos)
Parameters
Type Name Description
Vector3i pos

RemoveNearestGlobalMark(User)

Declaration
[ChatSubCommand]
public static bool RemoveNearestGlobalMark(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Boolean

SetGroupPartMarker(Guid, Vector3i, String, IEnumerable<IStack>, String, Boolean)

Declaration
public void SetGroupPartMarker(Guid id, Vector3i pos, string category, IEnumerable<IStack> items, string text = null, bool displayOffScreen = true)
Parameters
Type Name Description
System.Guid id
Vector3i pos
System.String category
System.Collections.Generic.IEnumerable<IStack> items
System.String text
System.Boolean displayOffScreen

SetSettlement(Player, WorldMarker, Settlement)

Declaration
public void SetSettlement(Player player, WorldMarker marker, Settlement settlement)
Parameters
Type Name Description
Player player
WorldMarker marker
Settlement settlement

Implements

Extension Methods