Class CivicAction

Inheritance
System.Object
CivicAction
CivicAction_AddElement
CivicAction_ChangeElement
CivicAction_RemoveElement
CivicAction_EnterElection
CivicAction_RemoveFromOffice
CivicAction_ResignFromOffice
CivicAction_StartCandidateElection
CivicAction_Veto
CivicAction_Vote
CivicAction_WithdrawFromElection
ElectionPoll.CivicAction_FinishPoll
ElectionPoll.CivicAction_StartPoll
CivicAction_PerformExecutiveAction
CivicAction_RevokeCitizenship
SettlementCivicAction
SettlementCivicActionWithTarget
Namespace: Eco.Gameplay.Civics
Assembly: Eco.Gameplay.dll
Syntax
public abstract class CivicAction : Object, IValidity, IDescribable, IRPCAuthChecks, ISettlementAssociated, IController, IViewController, IHasUniversalID, INotifyPropertyChanged

Constructors

CivicAction()

Declaration
protected CivicAction()

Properties

ContainedElementName

Declaration
public virtual LocString ContainedElementName { get; }
Property Value
Type Description
LocString

ControllerID

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

NotifyOnPerform

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

Settlement

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

Subject

Declaration
public virtual LocString Subject { get; }
Property Value
Type Description
LocString

TableHeader

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

Methods

CanEdit(User)

Declaration
public virtual Result CanEdit(User user)
Parameters
Type Name Description
User user
Returns
Type Description
Result

CanExecute(User)

Declaration
public virtual Result CanExecute(User user)
Parameters
Type Name Description
User user
Returns
Type Description
Result

Description()

Declaration
public abstract LocString Description()
Returns
Type Description
LocString

ElectionStarted(User, Election)

Declaration
public virtual LocString ElectionStarted(User user, Election election)
Parameters
Type Name Description
User user
Election election
Returns
Type Description
LocString

Failed(User)

Declaration
public virtual LocString Failed(User user)
Parameters
Type Name Description
User user
Returns
Type Description
LocString

Initialize(Settlement)

Declaration
public virtual void Initialize(Settlement settlement)
Parameters
Type Name Description
Settlement settlement

IsNull()

Declaration
public virtual bool IsNull()
Returns
Type Description
System.Boolean

IsSameAction(CivicAction)

We use this to detect when two civic actions are doing the same thing (We don't just override Equals, because in some cases we still wants two civic actions that do the same thing to not be equal.)

Declaration
public virtual bool IsSameAction(CivicAction action)
Parameters
Type Name Description
CivicAction action
Returns
Type Description
System.Boolean

Perform(User, Election)

Declaration
public abstract Result Perform(User user, Election election)
Parameters
Type Name Description
User user
Election election
Returns
Type Description
Result

ValidateParamsOnSubmit()

Declaration
public virtual void ValidateParamsOnSubmit()

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods