Class WorldMarker

Inheritance
System.Object
WorldMarker
Namespace: Eco.Gameplay.UI.WorldMarker
Assembly: Eco.Gameplay.dll
Syntax
public class WorldMarker : Object, IMinimapObject, IController, IViewController, INotifyPropertyChanged, IMinimapCategorizedOption, IMinimapOption, IHasReferenceableSerializableID, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, IHasTeleportOption, IHasSerializableID, IHasUniversalID

Constructors

WorldMarker()

Declaration
protected WorldMarker()

WorldMarker(Vector3i, String)

Declaration
public WorldMarker(Vector3i pos, string text)
Parameters
Type Name Description
Vector3i pos
System.String text

Fields

GroupComposedWorldMarker

Declaration
public bool GroupComposedWorldMarker
Field Value
Type Description
System.Boolean

Temp

Declaration
public bool Temp
Field Value
Type Description
System.Boolean

Properties

CanChangeText

Declaration
public bool CanChangeText { get; }
Property Value
Type Description
System.Boolean

CanMove

Declaration
public bool CanMove { get; }
Property Value
Type Description
System.Boolean

Color

Declaration
public Color Color { get; }
Property Value
Type Description
Color

ControllerID

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

Creator

Declaration
public User Creator { get; }
Property Value
Type Description
User

DependantOverlayName

Declaration
public string DependantOverlayName { get; }
Property Value
Type Description
System.String

DisplayDistance

Declaration
public bool DisplayDistance { get; }
Property Value
Type Description
System.Boolean

DisplayName

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
System.String

DisplayObjectCategory

Declaration
public string DisplayObjectCategory { get; set; }
Property Value
Type Description
System.String

DisplayOffScreen

Declaration
public bool DisplayOffScreen { get; }
Property Value
Type Description
System.Boolean

DisplayText

Declaration
public bool DisplayText { get; }
Property Value
Type Description
System.Boolean

FolderStructure

Declaration
public string FolderStructure { get; set; }
Property Value
Type Description
System.String

HasAccess

Declaration
public ControllerHashSet<IAlias> HasAccess { get; }
Property Value
Type Description
ControllerHashSet<IAlias>

IconNameOverride

Declaration
public string IconNameOverride { get; }
Property Value
Type Description
System.String

IsOnByDefault

Declaration
public bool IsOnByDefault { get; }
Property Value
Type Description
System.Boolean

IsOverlayObject

Declaration
public bool IsOverlayObject { get; }
Property Value
Type Description
System.Boolean

IsTutorialMarker

Declaration
public bool IsTutorialMarker { get; set; }
Property Value
Type Description
System.Boolean

IsVisibleOnMinimap

Declaration
public bool IsVisibleOnMinimap { get; set; }
Property Value
Type Description
System.Boolean

MarkedUpName

Declaration
public LocString MarkedUpName { get; }
Property Value
Type Description
LocString

MaxDistanceToShow

Declaration
public float MaxDistanceToShow { get; }
Property Value
Type Description
System.Single

Name

Declaration
public string Name { get; }
Property Value
Type Description
System.String

OverrideTarget

Declaration
public IMinimapObject OverrideTarget { get; }
Property Value
Type Description
IMinimapObject

Owner

Declaration
public IAlias Owner { get; }
Property Value
Type Description
IAlias

Pos

Declaration
public Vector3i Pos { get; }
Property Value
Type Description
Vector3i

Position

Declaration
public Vector3 Position { get; }
Property Value
Type Description
System.Numerics.Vector3

Priority

Declaration
public float Priority { get; }
Property Value
Type Description
System.Single

Rotation

Declaration
public float Rotation { get; }
Property Value
Type Description
System.Single

Scale

Declaration
public Vector3 Scale { get; }
Property Value
Type Description
System.Numerics.Vector3

Settlement

Declaration
public Settlement Settlement { get; set; }
Property Value
Type Description
Settlement

Subscriptions

Declaration
public ref ThreadSafeSubscriptions Subscriptions { get; }
Property Value
Type Description
ThreadSafeSubscriptions

SubTitle

Declaration
public string SubTitle { get; set; }
Property Value
Type Description
System.String

TargetNetworkID

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

TargetViewID

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

Text

Declaration
public string Text { get; }
Property Value
Type Description
System.String

TooltipTile

Declaration
public LocString TooltipTile { get; }
Property Value
Type Description
LocString

Type

Declaration
public Type Type { get; }
Property Value
Type Description
System.Type

UserDefinedFolderStructure

Declaration
public string UserDefinedFolderStructure { get; set; }
Property Value
Type Description
System.String

WorkOrder

Declaration
public WorkOrder WorkOrder { get; }
Property Value
Type Description
WorkOrder

Methods

CheckPermissions(Player)

Declaration
public bool CheckPermissions(Player player)
Parameters
Type Name Description
Player player
Returns
Type Description
System.Boolean

CopyToClipboard(Player)

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

Remove(Player)

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

SetColor(Player, Color)

Declaration
public void SetColor(Player player, Color color)
Parameters
Type Name Description
Player player
Color color

SetDisplayDistance(Player, Boolean)

Declaration
public void SetDisplayDistance(Player player, bool b)
Parameters
Type Name Description
Player player
System.Boolean b

SetDisplayName(Player, String)

Declaration
public void SetDisplayName(Player player, string text)
Parameters
Type Name Description
Player player
System.String text

SetDisplayOffScreen(Player, Boolean)

Declaration
public void SetDisplayOffScreen(Player player, bool b)
Parameters
Type Name Description
Player player
System.Boolean b

SetDisplayText(Player, Boolean)

Declaration
public void SetDisplayText(Player player, bool b)
Parameters
Type Name Description
Player player
System.Boolean b

SetMaxDistanceToShow(Player, Single)

Declaration
public void SetMaxDistanceToShow(Player player, float v)
Parameters
Type Name Description
Player player
System.Single v

SetPos(Player, Vector3i)

Declaration
public void SetPos(Player player, Vector3i pos)
Parameters
Type Name Description
Player player
Vector3i pos

SetSettlement(User, Settlement)

Set the new settlement and return true if it succeeded and was changed.

Declaration
public bool SetSettlement(User user, Settlement newSettlement)
Parameters
Type Name Description
User user
Settlement newSettlement
Returns
Type Description
System.Boolean

SetTextNoParse(String)

Declaration
public void SetTextNoParse(string text)
Parameters
Type Name Description
System.String text

SetUserDefinedFolderStructure(Player, String)

Declaration
public void SetUserDefinedFolderStructure(Player player, string folder)
Parameters
Type Name Description
Player player
System.String folder

SetVisiblity(WorldMarkerVisibility)

Use the given WorldMarkerVisibility value to determine if the WorldMarker should be shown on the minimap or not, can be extended to provide options to show in World or not too.

Declaration
public void SetVisiblity(WorldMarkerVisibility visibility)
Parameters
Type Name Description
WorldMarkerVisibility visibility

SetWorkOrder(Player, WorkOrder)

Declaration
public void SetWorkOrder(Player player, WorkOrder order)
Parameters
Type Name Description
Player player
WorkOrder order

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods