Class ResourceConsumableTemplate

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

A consumable that restores resources: a healing potion, a mana draught, a ration.

[CreateAssetMenu(fileName = "New Resource Consumable", menuName = "FishMMO/Character/Item/Consumable/Resource Consumable", order = 1)]
public class ResourceConsumableTemplate : ConsumableTemplate, ICachedObject, ITooltip

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<BaseItemTemplate>

BaseItemTemplate

ConsumableTemplate

ResourceConsumableTemplate

Implements

ICachedObject

ITooltip

Inherited Members

ConsumableTemplate.ConsumableType

ConsumableTemplate.ChargeCost

ConsumableTemplate.Cooldown

ConsumableTemplate.ActivationTime

ConsumableTemplate.CanConsume(IPlayerCharacter, Item, uint)

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.BuildTooltip(TooltipContent)

BaseItemTemplate.AddAttributeRange(TooltipContent, string, ItemAttributeTemplate, int, bool)

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)

Extension Methods

TooltipExtensions.BuildContent(ITooltip)

TooltipExtensions.TooltipText(ITooltip)

Remarks

The first concrete consumable in the project. ConsumableTemplate and ScrollConsumableTemplate are both abstract and nothing derived from either, so no consumable item could exist at all — the charge, cooldown and destroy machinery was written and had nothing to run on.

Health goes through ICharacterDamageController.Heal rather than straight onto the attribute, so a potion behaves like every other heal in the game: it is refused on a dead character, it draws a combat number, and it counts toward healing achievements. Every other resource is a plain Gain(float), which clamps at the maximum so an overfill tops the bar up rather than pushing past full.

The base class has already taken the charge and applied the cooldown by the time this runs, so a restoration that finds no controller still consumes: the item was drunk either way.

Fields

Restores

What this restores. More than one entry restores several resources from one use.

[Tooltip("The resources this restores, and by how much.")]
public List<ResourceRestoration> Restores

Field Value

List<ResourceRestoration>

Methods

BuildTooltip(TooltipContent, bool)

Describes what drinking it gives back.

public override void BuildTooltip(TooltipContent content, bool describingInstance)

Parameters

content TooltipContent

The content being assembled.

describingInstance bool

Invoke(IPlayerCharacter, Item, uint)

Consumes the item and restores its resources.

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

Parameters

character IPlayerCharacter

The character drinking it.

item Item

The item being consumed.

currentTick uint

The tick the use happened on.

Returns

bool

True when the item was consumed.