Interface IPlaceableItem

For items that can be placed in the world.

Namespace: Eco.Gameplay.Items
Assembly: Eco.Gameplay.dll
Syntax
public interface IPlaceableItem : IController, IViewController, IHasUniversalID

Fields

singleBlockOccupancy

Declaration
public static OccupancyContext singleBlockOccupancy
Field Value
Type Description
OccupancyContext

WaterBlocksPlacement

Declaration
public static readonly Type[] WaterBlocksPlacement
Field Value
Type Description
System.Type[]

Properties

Blockers

Declaration
virtual Type[] Blockers { get; }
Property Value
Type Description
System.Type[]

MarkedUpName

Declaration
virtual LocString MarkedUpName { get; }
Property Value
Type Description
LocString

Name

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

OccupancyContext

Declaration
virtual OccupancyContext OccupancyContext { get; }
Property Value
Type Description
OccupancyContext

ShouldCreate

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

WorldObjectType

Declaration
virtual Type WorldObjectType { get; }
Property Value
Type Description
System.Type

Methods

CanPlaceObject(Player, Vector3, Quaternion)

Declaration
virtual Task<bool> CanPlaceObject(Player player, Vector3 pos, Quaternion rotation)
Parameters
Type Name Description
Player player
System.Numerics.Vector3 pos
Quaternion rotation
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

OnPickup(WorldObject)

Declaration
virtual void OnPickup(WorldObject placedObject)
Parameters
Type Name Description
WorldObject placedObject

OnPostWorldObjectPlaced(WorldObject)

This called after the world object is placed, added to the world object manager and all its components initialized.

Declaration
virtual void OnPostWorldObjectPlaced(WorldObject addedObject)
Parameters
Type Name Description
WorldObject addedObject

OnPreWorldObjectPlaced(WorldObject)

This is called immediately before placement, before initialization and net object activation.

Declaration
virtual void OnPreWorldObjectPlaced(WorldObject placedObject)
Parameters
Type Name Description
WorldObject placedObject

Place(Player, Vector3, Quaternion, Int32)

Declaration
virtual void Place(Player player, Vector3 pos, Quaternion rotation, int placeOnSurfaceOfObjectID)
Parameters
Type Name Description
Player player
System.Numerics.Vector3 pos
Quaternion rotation
System.Int32 placeOnSurfaceOfObjectID

PlacingObject(GameActionPack, Player, ItemStack, Vector3, Quaternion)

Declaration
virtual Task PlacingObject(GameActionPack pack, Player player, ItemStack containingStack, Vector3 pos, Quaternion rotation)
Parameters
Type Name Description
GameActionPack pack
Player player
ItemStack containingStack
System.Numerics.Vector3 pos
Quaternion rotation
Returns
Type Description
System.Threading.Tasks.Task

Extension Methods