Show / Hide Table of Contents

Class SimpleProposable

Inheritance
System.Object
SimpleEntry
SimpleProposable
CivicArticle
Constitution
ConstitutionalAmendment
Demographic
DistrictMap
ElectionProcess
Election
ImmigrationPolicy
Injunction
Law
Workable
District
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
Inherited Members
SimpleEntry.Description()
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.Misc
Assembly: Eco.Gameplay.dll
Syntax
[RPCAuthMaxProposableState]
public abstract class SimpleProposable : SimpleEntry, 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

Constructors

SimpleProposable()

Declaration
protected SimpleProposable()

Fields

requiresHost

Declaration
protected bool requiresHost
Field Value
Type Description
System.Boolean

Properties

CurrentEditingUser

Declaration
public User CurrentEditingUser { get; set; }
Property Value
Type Description
User

DescribedWithTable

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

Election

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

HostID

Declaration
public Guid HostID { get; }
Property Value
Type Description
System.Guid

HostObject

Declaration
public WorldObjectHandle HostObject { get; protected set; }
Property Value
Type Description
WorldObjectHandle

IsActive

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

LastValidTime

Declaration
public double LastValidTime { get; set; }
Property Value
Type Description
System.Double

RemovalElection

Declaration
public Election RemovalElection { get; set; }
Property Value
Type Description
Election

RemovedBy

Declaration
public User RemovedBy { get; set; }
Property Value
Type Description
User

RequiresHost

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

RequiresSlot

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

RevisionParent

Declaration
public IProposable RevisionParent { get; set; }
Property Value
Type Description
IProposable

ScanPeriodically

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

Settlement

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

State

Declaration
public ProposableState State { get; set; }
Property Value
Type Description
ProposableState

Submitted

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

TargetToReplace

Declaration
public IProposable TargetToReplace { get; set; }
Property Value
Type Description
IProposable

UsingPlayers

Declaration
public ThreadSafeList<WeakReference> UsingPlayers { get; set; }
Property Value
Type Description
ThreadSafeList<System.WeakReference>

WasRemoved

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

Methods

ApplyUpdatedProposable(IProposable)

Declaration
public virtual void ApplyUpdatedProposable(IProposable old)
Parameters
Type Name Description
IProposable old

AssignHostObject(WorldObject)

Declaration
public virtual void AssignHostObject(WorldObject newHost)
Parameters
Type Name Description
WorldObject newHost

CanBeAssignedTo(IOrphanAssignment)

Declaration
public virtual bool CanBeAssignedTo(IOrphanAssignment container)
Parameters
Type Name Description
IOrphanAssignment container
Returns
Type Description
System.Boolean

Destroyed()

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

DisableHostedObject()

Declaration
public virtual void DisableHostedObject()

GetPairsOfOldAndNewRevisions(IProposable)

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

Initialize()

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

InitializeDraftProposable()

Declaration
public virtual void InitializeDraftProposable()

OnBeforeStateChangeInternal(ProposableState, CivicsUtils.StateChangeDetailFlags)

Callback before state change, we need it separate from OnStateChangedInternal to ensure when we set State any State subscription will deal with valid state.

Declaration
public virtual void OnBeforeStateChangeInternal(ProposableState newState, CivicsUtils.StateChangeDetailFlags flags)
Parameters
Type Name Description
ProposableState newState
CivicsUtils.StateChangeDetailFlags flags

OnCreate()

Declaration
public virtual void OnCreate()

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
SimpleEntry.OnLinkClicked(TooltipOrigin, TooltipClickContext, User)

OnStateChangedInternal(ProposableState, CivicsUtils.StateChangeDetailFlags)

Callback when state changed.

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

SetRequiresHost(Boolean)

Declaration
public void SetRequiresHost(bool set)
Parameters
Type Name Description
System.Boolean set

SetState(ProposableState)

Declaration
public void SetState(ProposableState newState)
Parameters
Type Name Description
ProposableState newState

Valid()

Declaration
public virtual Result Valid()
Returns
Type Description
Result

Explicit Interface Implementations

IHostedObject.CanBeEdited

Declaration
bool IHostedObject.CanBeEdited { get; set; }
Returns
Type Description
System.Boolean

IHostedObject.ExpirationWarningsIssued

Declaration
int IHostedObject.ExpirationWarningsIssued { get; set; }
Returns
Type Description
System.Int32

IHostedObject.HostingSettlement

Declaration
Settlement IHostedObject.HostingSettlement { get; }
Returns
Type Description
Settlement

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

Extension Methods

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