Class CustomProductItemCreator

Namespace

S1API.Products

Assembly

S1API.dll

Creates generic non-mixable custom product definitions.

public static class CustomProductItemCreator

Inheritance

object

CustomProductItemCreator

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

CreateBuilder(string, ProductKind)

Creates a builder for a generic custom product.

public static CustomProductDefinitionBuilder CreateBuilder(string id, ProductKind productKind)

Parameters

id string

A stable namespaced product ID in mod-id:product-id form.

productKind ProductKind

The registered logical product kind, including the vanilla compatibility drug type required by native save and product-item data.

Returns

CustomProductDefinitionBuilder

A new custom product definition builder.

Remarks

Keep this durable ID namespaced for saves and multiplayer. If you do not want to type the namespace when testing through the console, register the short name with ConsoleItemAliases after Build() so give <alias> resolves it locally.