Table of Contents

Class QualityItemDefinitionBuilder

Namespace
S1API.Items.Quality
Assembly
S1API.dll

Builder for composing quality item definitions at runtime. Use fluent methods to configure item properties before calling Build()

public sealed class QualityItemDefinitionBuilder : StorableItemDefinitionBuilderBase<QualityItemDefinitionBuilder>
Inheritance
QualityItemDefinitionBuilder
Inherited Members
Extension Methods

Methods

Build()

Builds the item definition, registers it with the game's registry, and returns a wrapper.

public QualityItemDefinition Build()

Returns

QualityItemDefinition

A wrapper around the created quality item definition.

CopyPropertiesFrom(StorableItemDefinition)

Copies all properties from a source definition to the current definition.

protected override void CopyPropertiesFrom(StorableItemDefinition source)

Parameters

source StorableItemDefinition

The source definition to copy from.

CreateWrapper(StorableItemDefinition)

Creates a wrapper around the given item definition. Subclasses can override this to return a more specific wrapper type.

protected override StorableItemDefinition CreateWrapper(StorableItemDefinition definition)

Parameters

definition StorableItemDefinition

The item definition to wrap.

Returns

StorableItemDefinition

A wrapper around the given item definition.

WithDefaultQuality(Quality)

Assigns a default quality for this definition.

public QualityItemDefinitionBuilder WithDefaultQuality(Quality quality)

Parameters

quality Quality

The default quality to assign to items of this definition.

Returns

QualityItemDefinitionBuilder

The builder instance for fluent chaining.