Class InfluenceMap

Inheritance
System.Object
InfluenceMap
Namespace: Eco.Gameplay.InfluenceObjects
Assembly: Eco.Gameplay.dll
Syntax
public class InfluenceMap : Object, IController, IViewController, IHasUniversalID, IPlotOverlayWithMapLegend, IMapEntryOverlay, IMinimapOption, IMinimapCategorizedOption

Constructors

InfluenceMap(String, Single)

Declaration
public InfluenceMap(string displayName, float priority)
Parameters
Type Name Description
System.String displayName
System.Single priority

Properties

ChildMap

Declaration
public InfluenceMap ChildMap { get; }
Property Value
Type Description
InfluenceMap

ControllerID

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

FolderStructure

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

Influencers

Declaration
public ControllerList<IInfluencer> Influencers { get; }
Property Value
Type Description
ControllerList<IInfluencer>

IsOnByDefault

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

LegendEntriesViewKey

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

Map

Declaration
public Array2D<int> Map { get; }
Property Value
Type Description
Array2D<System.Int32>

MapEntries

Declaration
public Dictionary<int, MapEntry> MapEntries { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.Int32, MapEntry>

MarkedUpName

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

Name

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

OverlayName

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

ParentMap

Declaration
public InfluenceMap ParentMap { get; }
Property Value
Type Description
InfluenceMap

Priority

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

Methods

DescribeMap()

Describes the plot counts for this influence map of each influencer.

Declaration
public LocString DescribeMap()
Returns
Type Description
LocString

GetInfluencePlotPos(PlotPos)

Declaration
public int GetInfluencePlotPos(PlotPos plotPos)
Parameters
Type Name Description
PlotPos plotPos
Returns
Type Description
System.Int32

GetInfluenceWorldPos(Vector2i)

Declaration
public int GetInfluenceWorldPos(Vector2i worldPos)
Parameters
Type Name Description
Vector2i worldPos
Returns
Type Description
System.Int32

SetFamily(InfluenceMap, InfluenceMap)

Declaration
public void SetFamily(InfluenceMap child, InfluenceMap parent)
Parameters
Type Name Description
InfluenceMap child
InfluenceMap parent

UpdateAndGetChangedPlots(Func<PlotPos, Int32>, IEnumerable<IInfluencer>)

Assign every value in the map with the results of the passed function, then trigger updates. Returns a list of positions that yielded a change.

Declaration
public List<PlotPos> UpdateAndGetChangedPlots(Func<PlotPos, int> plotPosToInfluencer, IEnumerable<IInfluencer> influencers)
Parameters
Type Name Description
System.Func<PlotPos, System.Int32> plotPosToInfluencer
System.Collections.Generic.IEnumerable<IInfluencer> influencers
Returns
Type Description
System.Collections.Generic.List<PlotPos>

UpdateMapEntryColor(IInfluencer)

Updates the map entry color and notifies view changes for it.

Declaration
public void UpdateMapEntryColor(IInfluencer influencer)
Parameters
Type Name Description
IInfluencer influencer

Implements

Extension Methods