Show / Hide Table of Contents

Class DistrictMap

Inheritance
System.Object
SimpleEntry
SimpleProposable
DistrictMap
Implements
ILinkableParameterized<SimpleEntry.NamingOptions>
ICachesValidity
IDescribable
IProposable
IHasID
IReInitializable
IHasReferenceableSerializableID
IHostedObject
INamed
IHasTeleportOption
IHasSerializableID
ILinkableParameterized<System.Boolean>
ILinkable
ICustomValidity
IValidity
ISuffixName
ISingleEditingUser
IPlayerUseTracking
IThreadSafeSubscriptions
ISubscriptions<ThreadSafeSubscriptions>
ISubscriptions
ISettlementAssociated
IController
IViewController
IHasUniversalID
System.ComponentModel.INotifyPropertyChanged
IRPCAuthChecks
ICustomClientEdit
ICopyable
IHasSubRegistrarEntries
IMinimapOption
IMapEntryOverlay
IPlotOverlayWithMapLegend
IMinimapCategorizedOption
Inherited Members
SimpleProposable.requiresHost
SimpleProposable.SetRequiresHost(Boolean)
SimpleProposable.Valid()
SimpleProposable.DisableHostedObject()
SimpleProposable.AssignHostObject(WorldObject)
SimpleProposable.CanBeAssignedTo(IOrphanAssignment)
SimpleProposable.OnBeforeStateChangeInternal(ProposableState, CivicsUtils.StateChangeDetailFlags)
SimpleProposable.InitializeDraftProposable()
SimpleProposable.ApplyUpdatedProposable(IProposable)
SimpleProposable.OnCreate()
SimpleProposable.SetState(ProposableState)
SimpleProposable.UsingPlayers
SimpleProposable.State
SimpleProposable.HostID
SimpleProposable.HostObject
SimpleProposable.TargetToReplace
SimpleProposable.ScanPeriodically
SimpleProposable.LastValidTime
SimpleProposable.Submitted
SimpleProposable.RevisionParent
SimpleProposable.Election
SimpleProposable.RemovedBy
SimpleProposable.RemovalElection
SimpleProposable.Settlement
SimpleProposable.CurrentEditingUser
SimpleProposable.RequiresHost
SimpleProposable.DescribedWithTable
SimpleProposable.RequiresSlot
SimpleProposable.IsActive
SimpleProposable.WasRemoved
SimpleProposable.IHostedObject.HostingSettlement
SimpleProposable.IHostedObject.CanBeEdited
SimpleProposable.IHostedObject.ExpirationWarningsIssued
SimpleEntry.PostLoad()
SimpleEntry.CreatorText(Player)
SimpleEntry.ToString()
SimpleEntry.SaveInRegistrar()
SimpleEntry.UILinkContent()
SimpleEntry.UILinkContent(Boolean)
SimpleEntry.UILinkContent(SimpleEntry.NamingOptions)
SimpleEntry.ReInitialize()
SimpleEntry.MarkDirty()
SimpleEntry.UserDescription
SimpleEntry.Name
SimpleEntry.Creator
SimpleEntry.NameSuffix
SimpleEntry.CreationTime
SimpleEntry.CachedValidity
SimpleEntry.IsDestroyed
SimpleEntry.OnValidityChanged
SimpleEntry.Initialized
SimpleEntry.MarkedUpName
SimpleEntry.Id
SimpleEntry.IconName
SimpleEntry.Registrar
SimpleEntry.WorldTimeSinceCreation
SimpleEntry.CanBeDeleted
SimpleEntry.TextName
SimpleEntry.Scannable
SimpleEntry.Style
SimpleEntry.ControllerID
SimpleEntry.TrueResult
SimpleEntry.Subscriptions
SimpleEntry.PropertyChanged
Namespace: Eco.Gameplay.Civics.Districts
Assembly: Eco.Gameplay.dll
Syntax
public class DistrictMap : SimpleProposable, ILinkableParameterized<SimpleEntry.NamingOptions>, ICachesValidity, IDescribable, IProposable, IHasID, IReInitializable, IHasReferenceableSerializableID, IHostedObject, INamed, IHasTeleportOption, IHasSerializableID, ILinkableParameterized<bool>, ILinkable, ICustomValidity, IValidity, ISuffixName, ISingleEditingUser, IPlayerUseTracking, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, ISettlementAssociated, IController, IViewController, IHasUniversalID, INotifyPropertyChanged, IRPCAuthChecks, ICustomClientEdit, ICopyable, IHasSubRegistrarEntries, IMinimapOption, IMapEntryOverlay, IPlotOverlayWithMapLegend, IMinimapCategorizedOption

Constructors

DistrictMap()

Declaration
public DistrictMap()

Fields

DistrictDescriptionUpdatedEvent

Declaration
public static ThreadSafeAction<District> DistrictDescriptionUpdatedEvent
Field Value
Type Description
ThreadSafeAction<District>

DistrictPlotCountCache

Declaration
public Dictionary<District, int> DistrictPlotCountCache
Field Value
Type Description
System.Collections.Generic.Dictionary<District, System.Int32>

DistrictsUpdatedEvent

Declaration
public static ThreadSafeAction<DistrictMap> DistrictsUpdatedEvent
Field Value
Type Description
ThreadSafeAction<DistrictMap>

Properties

Districts

Declaration
public ControllerDictionary<int, District> Districts { get; set; }
Property Value
Type Description
ControllerDictionary<System.Int32, District>

FolderStructure

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

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; set; }
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>

Priority

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

SubRegistrarEntries

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

Methods

AddDistrict(Player)

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

CopyFrom(Object)

Declaration
public CopyResult CopyFrom(object source)
Parameters
Type Name Description
System.Object source
Returns
Type Description
CopyResult

DescribeSize(District)

Declaration
public string DescribeSize(District district)
Parameters
Type Name Description
District district
Returns
Type Description
System.String

Description()

Declaration
public override LocString Description()
Returns
Type Description
LocString
Overrides
SimpleEntry.Description()

Destroyed()

Declaration
public override void Destroyed()
Overrides
SimpleProposable.Destroyed()

DistrictChanged(District)

Declaration
public void DistrictChanged(District district)
Parameters
Type Name Description
District district

Edit(User, Boolean, Action<IController>, Action<User>)

Declaration
public void Edit(User user, bool readOnly, Action<IController> onSubmit = null, Action<User> onClose = null)
Parameters
Type Name Description
User user
System.Boolean readOnly
System.Action<IController> onSubmit
System.Action<User> onClose

EditAsync(User, Boolean, Action<IController>, Action<User>)

Declaration
public Task EditAsync(User user, bool readOnly, Action<IController> onSubmit = null, Action<User> onClose = null)
Parameters
Type Name Description
User user
System.Boolean readOnly
System.Action<IController> onSubmit
System.Action<User> onClose
Returns
Type Description
System.Threading.Tasks.Task

GetArea(District)

Declaration
public object GetArea(District entry)
Parameters
Type Name Description
District entry
Returns
Type Description
System.Object

GetDistrictAtPlotPos(PlotPos)

Declaration
public District GetDistrictAtPlotPos(PlotPos plotPos)
Parameters
Type Name Description
PlotPos plotPos
Returns
Type Description
District

GetDistrictAtWorldPos(WorldPosition2i)

Declaration
public District GetDistrictAtWorldPos(WorldPosition2i worldPos)
Parameters
Type Name Description
WorldPosition2i worldPos
Returns
Type Description
District

GetDistrictByID(Int32)

Declaration
public District GetDistrictByID(int id)
Parameters
Type Name Description
System.Int32 id
Returns
Type Description
District

GetPairsOfOldAndNewRevisions(IProposable)

Declaration
public override Dictionary<IHasID, IHasID> GetPairsOfOldAndNewRevisions(IProposable old)
Parameters
Type Name Description
IProposable old
Returns
Type Description
System.Collections.Generic.Dictionary<IHasID, IHasID>
Overrides
SimpleProposable.GetPairsOfOldAndNewRevisions(IProposable)

Initialize()

Declaration
public override void Initialize()
Overrides
SimpleProposable.Initialize()

OnLinkClicked(TooltipOrigin, TooltipClickContext, User)

Declaration
public override void OnLinkClicked(TooltipOrigin origin, TooltipClickContext clickContext, User user)
Parameters
Type Name Description
TooltipOrigin origin
TooltipClickContext clickContext
User user
Overrides
SimpleProposable.OnLinkClicked(TooltipOrigin, TooltipClickContext, User)

OnStateChangedInternal(ProposableState, CivicsUtils.StateChangeDetailFlags)

Declaration
public override void OnStateChangedInternal(ProposableState oldState, CivicsUtils.StateChangeDetailFlags flags)
Parameters
Type Name Description
ProposableState oldState
CivicsUtils.StateChangeDetailFlags flags
Overrides
SimpleProposable.OnStateChangedInternal(ProposableState, CivicsUtils.StateChangeDetailFlags)

Remove(District)

Declaration
public void Remove(District district)
Parameters
Type Name Description
District district

ResetMap()

Declaration
public void ResetMap()

UpdateDistricts()

Declaration
public void UpdateDistricts()

Implements

ILinkableParameterized<T>
ICachesValidity
IDescribable
IProposable
IHasID
IReInitializable
IHasReferenceableSerializableID
IHostedObject
INamed
IHasTeleportOption
IHasSerializableID
ILinkableParameterized<T>
ILinkable
ICustomValidity
IValidity
ISuffixName
ISingleEditingUser
IPlayerUseTracking
IThreadSafeSubscriptions
ISubscriptions<TSubscriptionsList>
ISubscriptions
ISettlementAssociated
IController
IViewController
IHasUniversalID
System.ComponentModel.INotifyPropertyChanged
IRPCAuthChecks
ICustomClientEdit
ICopyable
IHasSubRegistrarEntries
IMinimapOption
IMapEntryOverlay
IPlotOverlayWithMapLegend
IMinimapCategorizedOption

Extension Methods

TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
TypeTooltipExtensions.UILinkGeneric(Object)
CivicsTooltipLibrary.DistrictMapTooltip(DistrictMap)
ILinkableTooltipLibrary.SimpleProposableLinkClicked(SimpleProposable)
MiscTooltipLibrary.SimpleEntryTooltip(SimpleEntry, User)
MiscTooltipLibrary.SimpleEntryTitle(SimpleEntry)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾