Class ItemDefinition

Namespace

FTK2.ModAPI.Content.Items

Assembly

FTK2.ModAPI.dll

Immutable custom-item recipe. Template metadata is resolved when game data is available.

public sealed class ItemDefinition

Inheritance

object

ItemDefinition

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

Description

public ContentId? Description { get; }

Property Value

ContentId

GameplayOverrides

public ItemGameplayOverrides GameplayOverrides { get; }

Property Value

ItemGameplayOverrides

Id

public ContentId Id { get; }

Property Value

ContentId

IsTemplateResolved

public bool IsTemplateResolved { get; }

Property Value

bool

Name

public ContentId? Name { get; }

Property Value

ContentId

TemplateClass

public string TemplateClass { get; }

Property Value

string

TemplateGameplay

public ItemGameplayProperties? TemplateGameplay { get; }

Property Value

ItemGameplayProperties

TemplateGeneration

public int TemplateGeneration { get; }

Property Value

int

TemplateItemId

public string TemplateItemId { get; }

Property Value

string

TemplateValue

public int TemplateValue { get; }

Property Value

int

Value

public int Value { get; }

Property Value

int

ValueOverride

public int? ValueOverride { get; }

Property Value

int?

Methods

WithGameplay(ItemGameplayOverrides)

Returns a new definition with supported gameplay overrides.

public ItemDefinition WithGameplay(ItemGameplayOverrides gameplay)

Parameters

gameplay ItemGameplayOverrides

Returns

ItemDefinition

WithLocalization(ContentId, ContentId)

Returns a new definition with name and description keys owned by the item's namespace.

public ItemDefinition WithLocalization(ContentId name, ContentId description)

Parameters

name ContentId

description ContentId

Returns

ItemDefinition

WithValue(int)

Returns a new definition with an explicit nonnegative base economic value.

public ItemDefinition WithValue(int value)

Parameters

value int

Returns

ItemDefinition