Interface IAnnexable

Something that can be annexed (settlement or homestead deed)

Namespace: Eco.Gameplay.Settlements
Assembly: Eco.Gameplay.dll
Syntax
public interface IAnnexable : IController, IViewController, IHasUniversalID

Properties

CanAnnex

Declaration
virtual bool CanAnnex { get; }
Property Value
Type Description
System.Boolean

CultureTotal

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

Founded

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

HostObject

Declaration
WorldObjectHandle HostObject { get; }
Property Value
Type Description
WorldObjectHandle

MarkedUpName

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

Name

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

Parent

Declaration
Settlement Parent { get; }
Property Value
Type Description
Settlement

PlotPosSet

Declaration
HashSet<PlotPos> PlotPosSet { get; }
Property Value
Type Description
System.Collections.Generic.HashSet<PlotPos>

ReductionPercentageForAnnexation

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

SettlementIDtoAnnexWarningIssued

Declaration
ThreadSafeDictionary<int, int> SettlementIDtoAnnexWarningIssued { get; set; }
Property Value
Type Description
ThreadSafeDictionary<System.Int32, System.Int32>

SettlementType

Declaration
Nullable<SettlementType> SettlementType { get; }
Property Value
Type Description
System.Nullable<SettlementType>

SettlementTypeAsIndex

Declaration
virtual int SettlementTypeAsIndex { get; }
Property Value
Type Description
System.Int32

TypeAndName

Declaration
LocString TypeAndName { get; }
Property Value
Type Description
LocString

TypeDisplayName

Declaration
LocString TypeDisplayName { get; }
Property Value
Type Description
LocString

Methods

Citizens()

Declaration
IEnumerable<User> Citizens()
Returns
Type Description
System.Collections.Generic.IEnumerable<User>

DistanceTo(Vector2i)

Declaration
float DistanceTo(Vector2i worldPos)
Parameters
Type Name Description
Vector2i worldPos
Returns
Type Description
System.Single

HasAncestor(Settlement)

True if the given settlement is a parent anywhere up the hierarchy

Declaration
bool HasAncestor(Settlement settlement)
Parameters
Type Name Description
Settlement settlement
Returns
Type Description
System.Boolean

Notify(LocString)

Declaration
void Notify(LocString msg)
Parameters
Type Name Description
LocString msg

Extension Methods