Interface IHostedObject

Add this interface when an object can't exist without a host object. IE. for a more detailed example see IProposable and SimpleProposable.

Inherited Members
Namespace: Eco.Gameplay.Placement
Assembly: Eco.Gameplay.dll
Syntax
public interface IHostedObject : ILinkable, INamed, IController, IViewController, IHasTeleportOption, IHasUniversalID, IHasSerializableID

Properties

CanBeEdited

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

Creator

Declaration
User Creator { get; set; }
Property Value
Type Description
User

ExpirationWarningsIssued

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

HostingSettlement

Declaration
Settlement HostingSettlement { get; }
Property Value
Type Description
Settlement

HostObject

Declaration
WorldObjectHandle HostObject { get; }
Property Value
Type Description
WorldObjectHandle

IsActive

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

LastValidTime

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

RequiresHost

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

ScanPeriodically

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

WasRemoved

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

Methods

AssignHostObject(WorldObject)

We assign the hosted object to its new host while at the same time updating what's needed.

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

CanBeAssignedTo(IOrphanAssignment)

We check whether this hosted object can be assigned to the new container or not.

Declaration
bool CanBeAssignedTo(IOrphanAssignment newContainer)
Parameters
Type Name Description
IOrphanAssignment newContainer
Returns
Type Description
System.Boolean

DisableHostedObject()

Declaration
void DisableHostedObject()

ReenableHostedObject()

Declaration
virtual void ReenableHostedObject()

Explicit Interface Implementations

IHasTeleportOption.CanTeleport

Declaration
bool IHasTeleportOption.CanTeleport { get; }
Returns
Type Description
System.Boolean

IHasTeleportOption.Pos

Declaration
Vector3i IHasTeleportOption.Pos { get; }
Returns
Type Description
Vector3i

Extension Methods