Class JurisdictionComponent

Component that allows setting an associated settlement with a world object based on the settlements that are influencing the current position. This component can be combined into another tab if its own tab isnt needed.

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

Constructors

JurisdictionComponent()

Declaration
public JurisdictionComponent()

Fields

DisableWhenInvalid

Set to false to prevent world object from being treated as disabled when no jurisdiction is selected.

Declaration
public bool DisableWhenInvalid
Field Value
Type Description
System.Boolean
Remarks

This can be used for things like allowing crafting settlement foundation items on ballot box before jurisdiction is selected.

Properties

Availability

Declaration
public override WorldObjectComponentClientAvailability Availability { get; }
Property Value
Type Description
WorldObjectComponentClientAvailability
Overrides

Enabled

Declaration
public override bool Enabled { get; }
Property Value
Type Description
System.Boolean
Overrides

IsValid

Does this world object have a jurisdiction selected?

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

SettlementOfJurisdiction

Declaration
public Settlement SettlementOfJurisdiction { get; }
Property Value
Type Description
Settlement

Methods

Destroy()

Declaration
public override void Destroy()
Overrides

ForceSetSettlementOfJurisdiction_Debug(Settlement)

Declaration
public void ForceSetSettlementOfJurisdiction_Debug(Settlement settlement)
Parameters
Type Name Description
Settlement settlement

Initialize()

Declaration
public override void Initialize()
Overrides

OnCreate()

Declaration
public override void OnCreate()
Overrides

SetSettlementOfJurisdiction(Player, Settlement)

Trys to assigns a settlement upon which the objects in this civic object will apply. Validates it to make sure its influencing us, and prevents changes if there are active or proposed ones.

Declaration
public void SetSettlementOfJurisdiction(Player player, Settlement settlement)
Parameters
Type Name Description
Player player
Settlement settlement

Events

CanChangeAssociatedSettlement

Callback that checks if changing the settlement is allowed. Callback is expected to do the error notification to the user.

Declaration
public event Func<Player, Settlement, bool> CanChangeAssociatedSettlement
Event Type
Type Description
System.Func<Player, Settlement, System.Boolean>

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods