Class CivicObjectComponent

Inheritance
System.Object
WorldObjectComponent
CivicObjectComponent
Inherited Members
Namespace: Eco.Gameplay.Components
Assembly: Eco.Gameplay.dll
Syntax
[RequireComponent]
public class CivicObjectComponent : WorldObjectComponent, ILinkable, IOwned, IHasSerializableID, IRPCAuthChecks, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, IHasInteractions, IOrphanAssignment, ISettlementAssociated, IController, IViewController, IHasUniversalID, INotifyPropertyChanged, IPickupConfirmationComponent, IHostsObjects

Constructors

CivicObjectComponent()

Declaration
public CivicObjectComponent()

Properties

Availability

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

CachedHostedObjects

Declaration
public ProposablePair[] CachedHostedObjects { get; }
Property Value
Type Description
ProposablePair[]

CivicTitle

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

ComponentPrefabName

Declaration
public override string ComponentPrefabName { get; }
Property Value
Type Description
System.String
Overrides

ComponentTabName

Declaration
public override LocString ComponentTabName { get; }
Property Value
Type Description
LocString
Overrides

Enabled

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

MaxCount

Declaration
public int MaxCount { get; set; }
Property Value
Type Description
System.Int32

ObjectListTitle

Declaration
public LocString ObjectListTitle { get; set; }
Property Value
Type Description
LocString

ObjectType

Declaration
public virtual Type ObjectType { get; set; }
Property Value
Type Description
System.Type

Settlement

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

UsedSlots

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

Methods

ApplyEdit(User, IProposable)

Declaration
public void ApplyEdit(User user, IProposable proposable)
Parameters
Type Name Description
User user
IProposable proposable

CanEdit(Player)

Declaration
public bool CanEdit(Player player)
Parameters
Type Name Description
Player player
Returns
Type Description
System.Boolean

CivicPowers(Player)

Declaration
public LocString CivicPowers(Player player)
Parameters
Type Name Description
Player player
Returns
Type Description
LocString

CopyFrom(Player, IProposable, IProposable, IProposable)

Declaration
public void CopyFrom(Player player, IProposable editingTarget, IProposable copyFrom, IProposable removeOld)
Parameters
Type Name Description
Player player
IProposable editingTarget
IProposable copyFrom
IProposable removeOld

Destroy()

Declaration
public override void Destroy()
Overrides

DisableProposables()

We make disable all proposables, meaning we make all the active ones as drafts again, we remove the draft ones and delete all elections currently in progress for them.

Declaration
public void DisableProposables()

Edit(Player, IProposable, IProposable)

Declaration
public void Edit(Player player, IProposable original, IProposable draft)
Parameters
Type Name Description
Player player
IProposable original
IProposable draft

ForceMakeNewActive(IProposable)

Declaration
public IProposable ForceMakeNewActive(IProposable prop)
Parameters
Type Name Description
IProposable prop
Returns
Type Description
IProposable

ForceMakeNewDraft(IProposable)

Declaration
public IProposable ForceMakeNewDraft(IProposable prop)
Parameters
Type Name Description
IProposable prop
Returns
Type Description
IProposable

GetComponentPickupConfirmation()

Declaration
public LocString GetComponentPickupConfirmation()
Returns
Type Description
LocString

Initialize()

Declaration
public override void Initialize()
Overrides

MakeNew(User, IProposable, IProposable)

Declaration
public IProposable MakeNew(User user, IProposable editingTarget, IProposable copyFrom)
Parameters
Type Name Description
User user
IProposable editingTarget
IProposable copyFrom
Returns
Type Description
IProposable

OnCreate()

Declaration
public override void OnCreate()
Overrides

Remove(Player, IProposable)

Declaration
public Task Remove(Player player, IProposable target)
Parameters
Type Name Description
Player player
IProposable target
Returns
Type Description
System.Threading.Tasks.Task

Setup(Type, Int32)

Declaration
public void Setup(Type objectType, int slotCount)
Parameters
Type Name Description
System.Type objectType
System.Int32 slotCount

TriggerHostedObjectUpdate()

Declaration
public void TriggerHostedObjectUpdate()

Explicit Interface Implementations

IHostsObjects.UpdateHostedStatus()

Declaration
void IHostsObjects.UpdateHostedStatus()

IOrphanAssignment.QueueAssignOrphans

Declaration
bool IOrphanAssignment.QueueAssignOrphans { get; set; }
Returns
Type Description
System.Boolean

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods