Class CustomAbilityDefinition

Namespace

FTK2.ModAPI.Content.Abilities

Assembly

FTK2.ModAPI.dll

Immutable, namespaced ability recipe derived from a compatible native FTK2 template.

public sealed class CustomAbilityDefinition

Inheritance

object

CustomAbilityDefinition

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Remarks

The definition contains ability behavior and presentation/localization identity. Accuracy, governing stat, roll count, and damage scaling are supplied by the granting item's ItemSkillRoll.

Properties

Description

public ContentId? Description { get; }

Property Value

ContentId

GameplayOverrides

public AbilityGameplayOverrides GameplayOverrides { get; }

Property Value

AbilityGameplayOverrides

Id

public ContentId Id { get; }

Property Value

ContentId

Name

public ContentId? Name { get; }

Property Value

ContentId

TemplateAbilityId

public string TemplateAbilityId { get; }

Property Value

string

TemplateGameplay

public AbilityGameplayProperties? TemplateGameplay { get; }

Property Value

AbilityGameplayProperties

TemplateGeneration

public int TemplateGeneration { get; }

Property Value

int

Methods

WithGameplay(AbilityGameplayOverrides)

Returns a new definition with the specified supported gameplay overrides.

public CustomAbilityDefinition WithGameplay(AbilityGameplayOverrides gameplay)

Parameters

gameplay AbilityGameplayOverrides

Returns

CustomAbilityDefinition

WithLocalization(ContentId, ContentId)

Returns a new definition with owned name and description localization IDs.

public CustomAbilityDefinition WithLocalization(ContentId name, ContentId description)

Parameters

name ContentId

description ContentId

Returns

CustomAbilityDefinition