Class MinimapObject

Straight implementation of the IMinimapObject interface, used to allow objects to make use of minimap icons separate from themselves (IE, when we want to share a minimap object without syncing the entire object, like with trees/world objects).

Inheritance

System.Object

MinimapObject

Implements

IMinimapObject

IController

IViewController

IHasUniversalID

System.ComponentModel.INotifyPropertyChanged

Namespace: Eco.Gameplay.Minimap

Assembly: Eco.Gameplay.dll

Syntax

public class MinimapObject : Object, IMinimapObject, IController, IViewController, IHasUniversalID, INotifyPropertyChanged

Constructors

MinimapObject()

Declaration

public MinimapObject()

Fields

OriginalPositionWeight

Declaration

public const float OriginalPositionWeight = 0.2F

Field Value

Type	Description
System.Single

RotationForUpdate

Declaration

public const float RotationForUpdate = 1F

Field Value

Type	Description
System.Single

SqDistanceForUpdate

Declaration

public const float SqDistanceForUpdate = 0.3F

Field Value

Type	Description
System.Single

Properties

CanChangeText

Declaration

public bool CanChangeText { get; set; }

Property Value

Type	Description
System.Boolean

CanMove

Declaration

public bool CanMove { get; set; }

Property Value

Type	Description
System.Boolean

ControllerID

Declaration

public ref int ControllerID { get; }

Property Value

Type	Description
System.Int32

Creator

Declaration

public User Creator { get; set; }

Property Value

Type	Description
User

DependantOverlayName

Declaration

public string DependantOverlayName { get; set; }

Property Value

Type	Description
System.String

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

HasAccess

Declaration

public ControllerHashSet<IAlias> HasAccess { get; set; }

Property Value

Type	Description
ControllerHashSet<IAlias>

IconNameOverride

Declaration

public string IconNameOverride { get; set; }

Property Value

Type	Description
System.String

IsOverlayObject

Declaration

public bool IsOverlayObject { get; set; }

Property Value

Type	Description
System.Boolean

IsVisibleOnMinimap

Declaration

public bool IsVisibleOnMinimap { get; set; }

Property Value

Type	Description
System.Boolean

OverrideTarget

Declaration

public IMinimapObject OverrideTarget { get; set; }

Property Value

Type	Description
IMinimapObject

Owner

Declaration

public IAlias Owner { get; set; }

Property Value

Type	Description
IAlias

Position

Declaration

public Vector3 Position { get; set; }

Property Value

Type	Description
System.Numerics.Vector3

Rotation

Declaration

public float Rotation { get; set; }

Property Value

Type	Description
System.Single

Scale

Declaration

public Vector3 Scale { get; set; }

Property Value

Type	Description
System.Numerics.Vector3

SubTitle

Declaration

public string SubTitle { get; set; }

Property Value

Type	Description
System.String

TargetNetworkID

Declaration

public int TargetNetworkID { get; set; }

Property Value

Type	Description
System.Int32

TargetViewID

Declaration

public int TargetViewID { get; set; }

Property Value

Type	Description
System.Int32

Type

Declaration

public Type Type { get; set; }

Property Value

Type	Description
System.Type

Methods

CalculateTopGroundPosition(Vector3)

Declaration

public void CalculateTopGroundPosition(Vector3 position)

Parameters

Type	Name	Description
System.Numerics.Vector3	position

UpdatePosition(Vector3, Nullable<Single>)

Prevents excesive updates of minimap icons. It will update position only if it changed position by 0.3m or if have at least 1 degere of difference of rotation.

Declaration

public void UpdatePosition(Vector3 position, Nullable<float> rotation = null)

Parameters

Type	Name	Description
System.Numerics.Vector3	position
System.Nullable<System.Single>	rotation

Events

PropertyChanged

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
System.ComponentModel.PropertyChangedEventHandler

Implements

IMinimapObject

IController

IViewController

IHasUniversalID

System.ComponentModel.INotifyPropertyChanged

Extension Methods

TagUtils.TagNames(Object, Boolean)

TagUtils.TagDisplayNames(Object, Boolean)

ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)

TypeTooltipExtensions.UILinkGeneric(Object)