Table of Contents

Class BuildManager

Namespace
S1API.Building
Assembly
S1API.dll

Provides control over the building system.

public static class BuildManager
Inheritance
BuildManager
Inherited Members

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)

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

Parameters

item ItemInstance
grid Grid
originCoordinate Vector2
rotation int
guid string

Returns

GameObject

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

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

Parameters

item ItemInstance
parentSurface Surface
relativePosition Vector3
relativeRotation Quaternion
guid string

Returns

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()