Class ScrollConsumableTemplate

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Abstract base class for scroll consumable templates, which grant abilities when consumed. Inherits from ConsumableTemplate and adds ability learning logic.

public abstract class ScrollConsumableTemplate : ConsumableTemplate, ICachedObject, ITooltip

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<BaseItemTemplate>

BaseItemTemplate

ConsumableTemplate

ScrollConsumableTemplate

Implements

ICachedObject

ITooltip

Derived

KnowledgeScrollTemplate

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)

Fields

AbilityEvents

The ability EVENTS learned when the scroll is consumed.

public List<AbilityEvent> AbilityEvents

Field Value

List<AbilityEvent>

Remarks

Knowledge comes in two kinds and crafting needs both: a base ability is the core, an effect is what configures it. A scroll could only ever teach the first, so half the crafting vocabulary had no way into a player's hands but a merchant.

AbilityTemplates

The list of ability templates that will be learned when the scroll is consumed.

public List<BaseAbilityTemplate> AbilityTemplates

Field Value

List<BaseAbilityTemplate>

Methods

BuildTooltip(TooltipContent, bool)

Describes the scroll, and names what reading it teaches.

public override void BuildTooltip(TooltipContent content, bool describingInstance)

Parameters

content TooltipContent

The content being assembled.

describingInstance bool

Invoke(IPlayerCharacter, Item, uint)

Invokes the scroll consumption logic, granting abilities to the character if successful. Calls base Invoke to handle cooldown and charge logic.

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

Parameters

character IPlayerCharacter

The player character consuming the scroll.

item Item

The scroll item being consumed.

currentTick uint

Returns

bool

True if the scroll was successfully consumed and abilities granted, false otherwise.