Class BuildManager

Namespace

S1API.Building

Assembly

S1API.dll

Provides control over the building system.

public static class BuildManager

Inheritance

object

BuildManager

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

CurrentBuildHandler

Gets the current build handler GameObject, if any.

public static GameObject? CurrentBuildHandler { get; }

Property Value

GameObject

IsBuilding

Gets whether the player is currently in building mode.

public static bool IsBuilding { get; }

Property Value

bool

Methods

CreateGridItem(ItemInstance, Grid, Vector2, int, string)

Creates a grid item from an item instance.

public static GameObject CreateGridItem(ItemInstance item, Grid grid, Vector2 originCoordinate, int rotation, string guid = "")

Parameters

item ItemInstance

The item to create.

grid Grid

The target grid.

originCoordinate Vector2

The origin coordinate on the grid.

rotation int

The rotation (0, 90, 180, 270).

guid string

Optional GUID.

Returns

GameObject

The created grid item GameObject.

CreateSurfaceItem(ItemInstance, Surface, Vector3, Quaternion, string)

Creates a surface item from an item instance.

public static GameObject CreateSurfaceItem(ItemInstance item, Surface parentSurface, Vector3 relativePosition, Quaternion relativeRotation, string guid = "")

Parameters

item ItemInstance

The item to create.

parentSurface Surface

The parent surface.

relativePosition Vector3

Position relative to the surface.

relativeRotation Quaternion

Rotation relative to the surface.

guid string

Optional GUID.

Returns

GameObject

The created surface item GameObject.

StartBuilding(ItemInstance)

Starts building mode with the specified item.

public static void StartBuilding(ItemInstance item)

Parameters

item ItemInstance

The item instance to build.

StopBuilding()

Stops the current building mode.

public static void StopBuilding()