Show / Hide Table of Contents

Class SettlementFoundationObject

Base class for objects that define a new settlement.

Inheritance
System.Object
WorldObject
CivicObject
SettlementFoundationObject
Implements
INetObjectPriority
INetObject
INetObjectPosition
IPositionAndBounds
IUsable
IStorage
ISerializable
IRPCAuthChecks
ILinkableParameterized<LinkConfig>
ILinkable
IHasPosition
IDeedOwned
IPlayerUseTracking
INamed
IHasSerializableID
IThreadSafeSubscriptions
ISubscriptions<ThreadSafeSubscriptions>
ISubscriptions
IInteractionTargetPriority
IPermanentDestroyHandler
ICivicObject
IMoveableWithinDeedAndInfluence
IMoveableWithRestrictions
IClaimStakeObject
System.ComponentModel.INotifyPropertyChanged
IObjectMovementLimitedByConstantDistance
IController
IViewController
IHasUniversalID
Inherited Members
CivicObject.InitCivicObjects()
CivicObject.CivicSlotTypes
WorldObject.netEntity
WorldObject.CreationItem
WorldObject.enabled
WorldObject.operating
WorldObject.IsHUDElement
WorldObject.AttachedTo
WorldObject.GetIcon(Type)
WorldObject.SetDirty()
WorldObject.RoomUpdated()
WorldObject.OnAdd(User, WrappedWorldPosition3, Quaternion, Boolean, WorldObject)
WorldObject.OnUsingPlayersChange()
WorldObject.PostAdd()
WorldObject.CreateEntity()
WorldObject.Tick()
WorldObject.SetAdminForceEnabled(Boolean)
WorldObject.UpdateEnabledAndOperating()
WorldObject.LateTick()
WorldObject.ToggleAnimatedState(Player, String)
WorldObject.GetAnimatedState<T>(String)
WorldObject.SetAnimatedState(String, Single)
WorldObject.SetAnimatedState(String, Boolean)
WorldObject.SetAnimatedState(String, String)
WorldObject.TriggerAnimatedEvent(String)
WorldObject.SetName(Player, String)
WorldObject.SetName(String)
WorldObject.MoveWorldObjectTo(Vector3i, Quaternion)
WorldObject.PlaceWorldObjectBlocks(WorldObject)
WorldObject.CloseUIForAll(Boolean)
WorldObject.Destroy()
WorldObject.DoInitializationSteps()
WorldObject.ComponentsInitialized()
WorldObject.FinishInitialize()
WorldObject.OnClick(Player)
WorldObject.GetDeed()
WorldObject.OnAuthChanged()
WorldObject.OnAuthSet(Deed)
WorldObject.ToString()
WorldObject.UILink<T>(Boolean)
WorldObject.UILink(Int32, Type, Boolean)
WorldObject.UILink(Type, Boolean)
WorldObject.OnLinkClicked(TooltipOrigin, TooltipClickContext, User)
WorldObject.UILinkContent()
WorldObject.UILinkContent(LinkConfig)
WorldObject.SendInitialState(BSONObject, INetObjectViewer)
WorldObject.SendUpdate(BSONObject, INetObjectViewer)
WorldObject.ReceiveUpdate(BSONObject)
WorldObject.ReceiveInitialState(BSONObject)
WorldObject.IsRelevant(INetObjectViewer)
WorldObject.IsNotRelevant(INetObjectViewer)
WorldObject.IsUpdated(INetObjectViewer)
WorldObject.AddOccupancy<T>(List<BlockOccupancy>)
WorldObject.AddOccupancy(Type, List<BlockOccupancy>)
WorldObject.AddOccupancyList(Type, BlockOccupancy[])
WorldObject.AddOccupancyRule<T>(Func<WorldObject, OccupancyInfo>)
WorldObject.GetOccupancyType(BlockOccupancyType)
WorldObject.GetOccupancy(Type)
WorldObject.GetOccupancyInfo(Type)
WorldObject.GetOccupancyRangeOrDefault(Type)
WorldObject.GetOccupancyRangeWorldPos()
WorldObject.GetBounding(Type)
WorldObject.GetOccupiedPropertyPositions(Type, Vector3, Quaternion)
WorldObject.Use(Player, InteractionTarget, InteractionTriggerInfo, String)
WorldObject.SendUIComponents(Player)
WorldObject.OpenUI(Player)
WorldObject.ReleaseUIComponents()
WorldObject.InteractOnComponent(Player, Type, String, InteractionTriggerInfo, InteractionTarget)
WorldObject.SyncPositionAndRotation()
WorldObject.IsAuthorized(User, AccessType)
WorldObject.GetOrCreateComponent<T>(String)
WorldObject.HasComponent<T>()
WorldObject.HasComponent(Type, String)
WorldObject.GetComponent<T>(String)
WorldObject.GetComponent(Type, String)
WorldObject.GetComponents<T>()
WorldObject.GetComponent(String)
WorldObject.TryGetComponent<T>(T)
WorldObject.SetComponentsParent()
WorldObject.InitializeComponents()
WorldObject.TickComponents()
WorldObject.LateTickComponents()
WorldObject.DestroyComponents()
WorldObject.SendInitialStateComponents(BSONObject, INetObjectViewer)
WorldObject.SendUpdateComponents(BSONObject, INetObjectViewer)
WorldObject.ReceiveUpdateComponents(BSONObject)
WorldObject.OnPermanentDestroy()
WorldObject.StorageHandle
WorldObject.DisplayDescription
WorldObject.Transient
WorldObject.UpdateChannel
WorldObject.DisplayName
WorldObject.TableTexture
WorldObject.TargetPriority
WorldObject.HasTier
WorldObject.Tier
WorldObject.FriendlyName
WorldObject.Description
WorldObject.Name
WorldObject.MarkedUpName
WorldObject.Creator
WorldObject.ObjectID
WorldObject.WorldObjectCreationTime
WorldObject.GivenName
WorldObject.OnAnyNameChanged
WorldObject.OnPositionChange
WorldObject.OnOperatingChange
WorldObject.OnEnableChange
WorldObject.OnMovedEvent
WorldObject.NameOfCreator
WorldObject.Enabled
WorldObject.Operating
WorldObject.OwnersMarkedUpName
WorldObject.Owners
WorldObject.AnimatedStates
WorldObject.CreatingItem
WorldObject.Using
WorldObject.Initialized
WorldObject.IsDestroyed
WorldObject.AllowResidentAccessIfCreator
WorldObject.CachedSettlementAtPos
WorldObject.UsingPlayers
WorldObject.PlacesBlocks
WorldObject.Room
WorldObject.Outside
WorldObject.CloseWhenDistant
WorldObject.AdminForceEnabled
WorldObject.LastSyncedPosition
WorldObject.Position
WorldObject.Position3i
WorldObject.Bounds
WorldObject.PlotPos
WorldObject.Rotation
WorldObject.ID
WorldObject.Active
WorldObject.Priority
WorldObject.Occupancy
WorldObject.OccupancyInfo
WorldObject.WorldOccupancy
WorldObject.WorldRange
WorldObject.InteractDistance
WorldObject.NetObjectCreationRealtime
WorldObject.ControllerID
WorldObject.Subscriptions
WorldObject.Auth
WorldObject.Components
WorldObject.PropertyChanged
WorldObject.SyncPositionEvent
Namespace: Eco.Gameplay.Settlements
Assembly: Eco.Gameplay.dll
Syntax
[RequireComponent]
[RequireComponent]
[RequireComponent]
[RequireComponent]
[RequireComponent]
[RequireComponent]
[RequireOwnedRoom]
[MayHaveComponent]
[RequireComponent]
public abstract class SettlementFoundationObject : CivicObject, INetObjectPriority, INetObject, INetObjectPosition, IPositionAndBounds, IUsable, IStorage, ISerializable, IRPCAuthChecks, ILinkableParameterized<LinkConfig>, ILinkable, IHasPosition, IDeedOwned, IPlayerUseTracking, INamed, IHasSerializableID, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, IInteractionTargetPriority, IPermanentDestroyHandler, ICivicObject, IMoveableWithinDeedAndInfluence, IMoveableWithRestrictions, IClaimStakeObject, INotifyPropertyChanged, IObjectMovementLimitedByConstantDistance, IController, IViewController, IHasUniversalID

Constructors

SettlementFoundationObject()

Declaration
protected SettlementFoundationObject()

Fields

AutoAddCurrentSettlementsAsChildAndParent

Declaration
public bool AutoAddCurrentSettlementsAsChildAndParent
Field Value
Type Description
System.Boolean

Properties

ConstantPositionToTrack

Declaration
public Vector3 ConstantPositionToTrack { get; }
Property Value
Type Description
System.Numerics.Vector3

IgnoreHeightMovement

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

IgnoreSettlementTypeOnClaimPapers

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

InitializeCivicsComponents

Declaration
protected override bool InitializeCivicsComponents { get; }
Property Value
Type Description
System.Boolean
Overrides
CivicObject.InitializeCivicsComponents

MaxDistanceFromSpecifiedPosition

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

MovementLimiterEnabled

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

Settlement

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

SettlementType

Declaration
public abstract SettlementType SettlementType { get; }
Property Value
Type Description
SettlementType

SlotCount

Declaration
public override int SlotCount { get; }
Property Value
Type Description
System.Int32
Overrides
CivicObject.SlotCount

Methods

Initialize()

Declaration
protected override void Initialize()
Overrides
CivicObject.Initialize()

OnCreatePostInitialize()

Declaration
protected override void OnCreatePostInitialize()
Overrides
CivicObject.OnCreatePostInitialize()

OnCreatePreInitialize()

Declaration
protected override void OnCreatePreInitialize()
Overrides
WorldObject.OnCreatePreInitialize()

OnDestroy()

Declaration
protected override void OnDestroy()
Overrides
CivicObject.OnDestroy()

PostInitialize()

Declaration
protected override void PostInitialize()
Overrides
WorldObject.PostInitialize()

Implements

INetObjectPriority
INetObject
INetObjectPosition
IPositionAndBounds
IUsable
IStorage
ISerializable
IRPCAuthChecks
ILinkableParameterized<T>
ILinkable
IHasPosition
IDeedOwned
IPlayerUseTracking
INamed
IHasSerializableID
IThreadSafeSubscriptions
ISubscriptions<TSubscriptionsList>
ISubscriptions
IInteractionTargetPriority
IPermanentDestroyHandler
ICivicObject
IMoveableWithinDeedAndInfluence
IMoveableWithRestrictions
IClaimStakeObject
System.ComponentModel.INotifyPropertyChanged
IObjectMovementLimitedByConstantDistance
IController
IViewController
IHasUniversalID

Extension Methods

WorldObjectDebugUtil.ThrowIfNotRunning(WorldObject)
SurfaceExtensions.AllAttachedRecursiveAndSelf(WorldObject)
PointOfInterestManager.AddAsPOI(WorldObject, String)
PointOfInterestManager.RemoveAsPOI(WorldObject, String)
TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
WorldObjectUtil.SimTickDelta(WorldObject)
WorldObjectUtil.CheckForPickUpAsync(WorldObject, Player, Boolean)
WorldObjectUtil.SelfAndComponentsWithInterface<T>(WorldObject)
WorldObjectUtil.DestroyAndReturnInventories(WorldObject, LocString)
WorldObjectUtil.ReturnAllInventoriesToCreator(WorldObject, LocString)
WorldObjectUtil.ForceReturnPropertyObject(WorldObject)
WorldObjectUtil.TryPickUpNow(WorldObject, Player, Inventory, Single, Boolean)
WorldObjectUtil.TryPickUp(WorldObject, GameActionPack, Player, Inventory, Single, Boolean, AccessType)
WorldObjectUtil.TryPickupComponents(WorldObject, WorldObjectUtil.PickupType, Inventory, User, GameActionPack, AccessType, Boolean)
OccupancyUtils.LocalToWorld(WorldObject, Ray)
OccupancyUtils.LocalToWorld(WorldObject, Vector3i)
OccupancyUtils.GroundBelow(WorldObject)
SettlementUtils.GetSettlementsAtPos(WorldObject)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
TypeTooltipExtensions.UILinkGeneric(Object)
ILinkableTooltipLibrary.WorldObjectLinkClicked(WorldObject, TooltipOrigin)
WorldObjectsTooltipLibrary.OwnerTooltip(WorldObject)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾