Class PremadeAbilityTemplate

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

A complete, ready-to-use ability a merchant sells: a base AbilityTemplate with its events already chosen, at a price of its own.

[CreateAssetMenu(fileName = "New Premade Ability", menuName = "FishMMO/Character/Merchant/Premade Ability", order = 2)]
public class PremadeAbilityTemplate : ScriptableObject, ITooltip

Inheritance

object

Object

ScriptableObject

PremadeAbilityTemplate

Implements

ITooltip

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsByType<T>()

Object.FindObjectsByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

TooltipExtensions.BuildContent(ITooltip)

TooltipExtensions.TooltipText(ITooltip)

Remarks

The ordinary route to a usable ability is two steps — buy the template and the effects from a merchant, then combine them at an Ability Crafter. This is the one-step alternative: the buyer receives the finished Ability straight into their usable set, exactly as if they had crafted it, and never needs to know the template. Content decides the trade-off; a premade combination will usually be weaker or plainer than what a player could build.

A plain ScriptableObject rather than a cached template. Nothing ever looks one of these up by ID: the purchase names a merchant and an index into that merchant's list, the server reads the recipe from its own copy of the asset, and the client renders it from the copy that loaded with the merchant template. It therefore needs no addressable label and no place in the cache.

The recipe is held to the crafting rules — at most AdditionalEventSlots events and at most one type override — so a premade ability can never be something a player could not have built. Validate(out string) is the single statement of those rules; the server runs it before selling and the inspector runs it on edit.

Fields

Ability

The base ability the finished ability is built from.

[Tooltip("The base ability. The buyer receives a finished ability built from it; they do not learn the template itself.")]
public AbilityTemplate Ability

Field Value

AbilityTemplate

Events

Events attached to the ability, as a crafter would attach them.

[Tooltip("Events baked into the ability. Bound by the base ability's Additional Event Slots.")]
public List<AbilityEvent> Events

Field Value

List<AbilityEvent>

Price

What the merchant charges. Zero is free; the template and event prices are not summed.

[Tooltip("The merchant's price for the finished ability. Zero is free. Component prices are not added on top.")]
[Min(0)]
public int Price

Field Value

int

TypeOverride

Optional ability-type override, as a crafter would attach one.

[Tooltip("Optional type override. Counts as one event slot, like it does at the crafter.")]
public AbilityTypeOverrideEventType TypeOverride

Field Value

AbilityTypeOverrideEventType

Properties

AssetName

Human-readable name of the offer, for logs and the inspector.

public string AssetName { get; }

Property Value

string

Icon

Gets the icon sprite to display in the tooltip.

public Sprite Icon { get; }

Property Value

Sprite

Name

Gets the display name for the tooltip.

public string Name { get; }

Property Value

string

Methods

BuildEventIDs()

The event IDs a crafted Ability is constructed with: the events, then the type override, in that order. The same shape the crafter sends and the database stores.

public List<int> BuildEventIDs()

Returns

List<int>

BuildTooltip(TooltipContent)

Describes the finished ability this offer sells, at the price it sells for.

public void BuildTooltip(TooltipContent content)

Parameters

content TooltipContent

The content being assembled.

Remarks

The composition is the one a crafter would produce from the same parts, so the offer cannot advertise numbers the bought ability will not have. The craft cost is suppressed: this is sold at its own price and two price lines would defeat the point of showing one.

Validate(out string)

Checks the recipe against the crafting rules.

public bool Validate(out string reason)

Parameters

reason string

Why the recipe is not sellable, or null when it is.

Returns

bool

True when a crafter would have accepted this exact combination.

Remarks

Written once and used on both sides so an asset the inspector accepts is one the server will sell. Duplicate events are tolerated here and collapsed by BuildEventIDs(), because a duplicated inspector row is a slip rather than an attempt to double an effect.