Class MinimapComponent

Objects with this component will have a hoverable icon generated for displaying on client's minimap.

Inheritance
System.Object
WorldObjectComponent
MinimapComponent
Inherited Members
Namespace: Eco.Gameplay.Components
Assembly: Eco.Gameplay.dll
Syntax
public class MinimapComponent : WorldObjectComponent, ILinkable, IOwned, IController, IViewController, IHasUniversalID, IHasSerializableID, IRPCAuthChecks, INotifyPropertyChanged, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, IHasInteractions
Remarks

Those icons can be either static (baked to atlas for optimization) or non-static (pos sync in real time), based on if they're Movable or not.

Constructors

MinimapComponent()

Declaration
public MinimapComponent()

Properties

CanMove

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

Methods

Destroy()

Declaration
public override void Destroy()
Overrides

InitAsMovable()

Marks the object as Movable. This can only be done before initialization is complete.

Declaration
public void InitAsMovable()

Initialize()

Declaration
public override void Initialize()
Overrides

SetCategory(LocString)

Declaration
public void SetCategory(LocString category)
Parameters
Type Name Description
LocString category

SetOverrideTarget(MinimapObject)

Sets the position provider for the target object. If null, the object's position will be used.

Declaration
public void SetOverrideTarget(MinimapObject target)
Parameters
Type Name Description
MinimapObject target
Remarks

Useful for fully syncing the positions of two minimap objects (e.g.: When a Player drives a vehicle).

SyncPosition()

Syncs the position of the MinimapObject with that of the parent WorldObject.

Declaration
public void SyncPosition()

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods