Class ConsumableTemplate

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Abstract base class for consumable item templates, defining type, charge cost, and cooldown behavior. Provides logic for consuming items and applying cooldowns.

public abstract class ConsumableTemplate : BaseItemTemplate, ICachedObject, ITooltip

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<BaseItemTemplate>

BaseItemTemplate

ConsumableTemplate

Implements

ICachedObject

ITooltip

Derived

ScrollConsumableTemplate

Inherited Members

BaseItemTemplate.IsIdentifiable

BaseItemTemplate.Generate

BaseItemTemplate.MaxStackSize

BaseItemTemplate.Price

BaseItemTemplate.IconPools

BaseItemTemplate.icon

BaseItemTemplate.MeshReference

BaseItemTemplate.Attributes

BaseItemTemplate.Name

BaseItemTemplate.IsStackable

BaseItemTemplate.Icon

BaseItemTemplate.Mesh

BaseItemTemplate.Tooltip()

BaseItemTemplate.BuildTooltip(TooltipBuilder)

BaseItemTemplate.OnLoad(string, string, int)

BaseItemTemplate.OnUnload(string, string, int)

CachedScriptableObject<BaseItemTemplate>.ID

CachedScriptableObject<BaseItemTemplate>.AddToCache(string)

CachedScriptableObject<BaseItemTemplate>.RemoveFromCache()

CachedScriptableObject<BaseItemTemplate>.Get<U>(int)

CachedScriptableObject<BaseItemTemplate>.GetFirst<U>()

CachedScriptableObject<BaseItemTemplate>.GetCache<U>()

CachedScriptableObject<BaseItemTemplate>.Get<U>(HashSet<int>)

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)

Fields

ActivationTime

The time required to activate this consumable (in seconds). A value of 0 means instant activation.

public float ActivationTime

Field Value

float

ChargeCost

The number of charges consumed per use.

public uint ChargeCost

Field Value

uint

ConsumableType

The type of consumable (e.g., potion, scroll).

public ConsumableType ConsumableType

Field Value

ConsumableType

Cooldown

The cooldown duration (in seconds) applied after consumption.

public float Cooldown

Field Value

float

Methods

CanConsume(IPlayerCharacter, Item, uint)

Determines if the specified character can consume the given item. Checks for valid character, item, stackable status, sufficient charges, and cooldown.

public bool CanConsume(IPlayerCharacter character, Item item, uint currentTick)

Parameters

character IPlayerCharacter

The player character attempting to consume.

item Item

The item to be consumed.

currentTick uint

The current network tick for cooldown evaluation.

Returns

bool

True if the item can be consumed, false otherwise.

Invoke(IPlayerCharacter, Item, uint)

Attempts to consume the item, applying cooldown and reducing charges as needed. Destroys the item if charges are depleted.

public virtual bool Invoke(IPlayerCharacter character, Item item, uint currentTick)

Parameters

character IPlayerCharacter

The player character consuming the item.

item Item

The item to be consumed.

currentTick uint

The current network tick for cooldown creation.

Returns

bool

True if the item was successfully consumed, false otherwise.