Class SettlementType

Wrapper for working with SettlementType Tier, provides easy access methods like getting children/parents and Display name

Inheritance
System.Object
SettlementType
Implements
System.IEquatable<SettlementType>
System.IComparable<SettlementType>
Namespace: Eco.Shared.Items
Assembly: Eco.Shared.dll
Syntax
[Serialized]
public sealed class SettlementType : ValueType, IEquatable<SettlementType>, IComparable<SettlementType>

Constructors

SettlementType(Int32)

Declaration
public SettlementType(int tier)
Parameters
Type Name Description
System.Int32 tier

Properties

All

Returns each settlement type available.

Declaration
public static SettlementType[] All { get; }
Property Value
Type Description
SettlementType[]

CanHaveChildrenSettlements

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

CanHaveParent

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

DisplayName

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

DisplayNamePlural

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

HighestSettlement

Declaration
public static SettlementType HighestSettlement { get; }
Property Value
Type Description
SettlementType

LowestSettlement

Declaration
public static SettlementType LowestSettlement { get; }
Property Value
Type Description
SettlementType

ShouldAlwaysHaveDirectCitizens

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

Methods

ChildrenTypes()

Declaration
public IEnumerable<SettlementType> ChildrenTypes()
Returns
Type Description
System.Collections.Generic.IEnumerable<SettlementType>

CompareTo(SettlementType)

Declaration
public int CompareTo(SettlementType other)
Parameters
Type Name Description
SettlementType other
Returns
Type Description
System.Int32

Equals(SettlementType)

Declaration
public bool Equals(SettlementType other)
Parameters
Type Name Description
SettlementType other
Returns
Type Description
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean

GetChild()

Declaration
public Nullable<SettlementType> GetChild()
Returns
Type Description
System.Nullable<SettlementType>

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

GetParent()

Declaration
public Nullable<SettlementType> GetParent()
Returns
Type Description
System.Nullable<SettlementType>

ParentTypes()

Declaration
public IEnumerable<SettlementType> ParentTypes()
Returns
Type Description
System.Collections.Generic.IEnumerable<SettlementType>

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Operators

Equality(SettlementType, SettlementType)

Declaration
public static bool operator ==(SettlementType x, SettlementType y)
Parameters
Type Name Description
SettlementType x
SettlementType y
Returns
Type Description
System.Boolean

Explicit(SettlementType to Int32)

Declaration
public static explicit operator int (SettlementType v)
Parameters
Type Name Description
SettlementType v
Returns
Type Description
System.Int32

GreaterThan(SettlementType, SettlementType)

Declaration
public static bool operator>(SettlementType x, SettlementType y)
Parameters
Type Name Description
SettlementType x
SettlementType y
Returns
Type Description
System.Boolean

GreaterThanOrEqual(SettlementType, SettlementType)

Declaration
public static bool operator >=(SettlementType x, SettlementType y)
Parameters
Type Name Description
SettlementType x
SettlementType y
Returns
Type Description
System.Boolean

Inequality(SettlementType, SettlementType)

Declaration
public static bool operator !=(SettlementType x, SettlementType y)
Parameters
Type Name Description
SettlementType x
SettlementType y
Returns
Type Description
System.Boolean

LessThan(SettlementType, SettlementType)

Declaration
public static bool operator <(SettlementType x, SettlementType y)
Parameters
Type Name Description
SettlementType x
SettlementType y
Returns
Type Description
System.Boolean

LessThanOrEqual(SettlementType, SettlementType)

Declaration
public static bool operator <=(SettlementType x, SettlementType y)
Parameters
Type Name Description
SettlementType x
SettlementType y
Returns
Type Description
System.Boolean

Implements

System.IEquatable<>
System.IComparable<>

Extension Methods