Class FurnitureCreator

Namespace

S1API.Items.Buildable

Assembly

S1API.dll

Creates first-class custom furniture backed by the game's native building system.

public static class FurnitureCreator

Inheritance

object

FurnitureCreator

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

CloneFrom(BuildableItemDefinition)

Creates a presentation-only furniture variant from an existing buildable definition. The builder owns an isolated visual clone and independent material instances.

public static FurnitureDefinitionBuilder CloneFrom(BuildableItemDefinition source)

Parameters

source BuildableItemDefinition

The native grid or surface furniture donor.

Returns

FurnitureDefinitionBuilder

A builder initialized with the donor's safe placement and item defaults.

Exceptions

ArgumentNullException

Thrown when source is null.

ArgumentException

Thrown when the donor has specialized runtime behavior.

CloneFrom(string)

Creates a presentation-only furniture variant from a registered native donor. The builder owns an isolated visual clone and independent material instances.

public static FurnitureDefinitionBuilder CloneFrom(string sourceItemId)

Parameters

sourceItemId string

The stable ID of the native grid or surface furniture donor.

Returns

FurnitureDefinitionBuilder

A builder initialized with the donor's safe placement and item defaults.

Exceptions

ArgumentException

Thrown when the ID is invalid, the donor is missing, or the donor has specialized runtime behavior.

CreateBuilder()

Creates a builder for a custom placeable furniture item.

public static FurnitureDefinitionBuilder CreateBuilder()

Returns

FurnitureDefinitionBuilder

A new furniture definition builder with grid-placement defaults.