Class ConstructionSystem

The client-side implementation of the construction system, which is used for constructing entities in game.

Inheritance
System.Object
SharedConstructionSystem
ConstructionSystem
Namespace: Content.Client.Construction
Assembly: Content.Client.dll
Syntax
public sealed class ConstructionSystem : SharedConstructionSystem

Properties

| Improve this Doc View Source

CraftingEnabled

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

Methods

| Improve this Doc View Source

ClearAllGhosts()

Removes all construction ghosts.

Declaration
public void ClearAllGhosts()
| Improve this Doc View Source

ClearGhost(Int32)

Removes a construction ghost entity with the given ID.

Declaration
public void ClearGhost(int ghostId)
Parameters
Type Name Description
System.Int32 ghostId
| Improve this Doc View Source

GetGuide(ConstructionPrototype)

Declaration
public ConstructionGuide GetGuide(ConstructionPrototype prototype)
Parameters
Type Name Description
ConstructionPrototype prototype
Returns
Type Description
ConstructionGuide
| Improve this Doc View Source

Initialize()

Declaration
public override void Initialize()
| Improve this Doc View Source

Shutdown()

Declaration
public override void Shutdown()
| Improve this Doc View Source

SpawnGhost(ConstructionPrototype, EntityCoordinates, Direction)

Creates a construction ghost at the given location.

Declaration
public void SpawnGhost(ConstructionPrototype prototype, EntityCoordinates loc, Direction dir)
Parameters
Type Name Description
ConstructionPrototype prototype
Robust.Shared.Map.EntityCoordinates loc
Direction dir
| Improve this Doc View Source

TrySpawnGhost(ConstructionPrototype, EntityCoordinates, Direction, out Nullable<EntityUid>)

Creates a construction ghost at the given location.

Declaration
public bool TrySpawnGhost(ConstructionPrototype prototype, EntityCoordinates loc, Direction dir, out EntityUid? ghost)
Parameters
Type Name Description
ConstructionPrototype prototype
Robust.Shared.Map.EntityCoordinates loc
Direction dir
System.Nullable<EntityUid> ghost
Returns
Type Description
System.Boolean
| Improve this Doc View Source

TryStartConstruction(EntityUid, ConstructionGhostComponent)

Declaration
public void TryStartConstruction(EntityUid ghostId, ConstructionGhostComponent ghostComp = null)
Parameters
Type Name Description
EntityUid ghostId
ConstructionGhostComponent ghostComp
| Improve this Doc View Source

TryStartItemConstruction(String)

Starts constructing an item underneath the attached entity.

Declaration
public void TryStartItemConstruction(string prototypeName)
Parameters
Type Name Description
System.String prototypeName

Events

| Improve this Doc View Source

ConstructionGuideAvailable

Declaration
public event EventHandler<string>? ConstructionGuideAvailable
Event Type
Type Description
System.Nullable<EventHandler<System.String>>
| Improve this Doc View Source

CraftingAvailabilityChanged

Declaration
public event EventHandler<CraftingAvailabilityChangedArgs>? CraftingAvailabilityChanged
Event Type
Type Description
System.Nullable<EventHandler<CraftingAvailabilityChangedArgs>>
| Improve this Doc View Source

FlipConstructionPrototype

Declaration
public event EventHandler? FlipConstructionPrototype
Event Type
Type Description
System.Nullable<EventHandler>
| Improve this Doc View Source

ToggleCraftingWindow

Declaration
public event EventHandler? ToggleCraftingWindow
Event Type
Type Description
System.Nullable<EventHandler>