Class LoreObjectTemplate

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Template defining a lore object's display text and optional immediate unlocks. When interacted with, the lore text is displayed in a UILore window. Abilities, ability events, and items listed here are granted immediately on interaction. Abilities and events are idempotent (already-known entries are skipped).

[CreateAssetMenu(fileName = "New Lore Object", menuName = "FishMMO/Interactable/Lore Object", order = 1)]
public class LoreObjectTemplate : CachedScriptableObject<LoreObjectTemplate>, ICachedObject

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<LoreObjectTemplate>

LoreObjectTemplate

Implements

ICachedObject

Inherited Members

CachedScriptableObject<LoreObjectTemplate>.ID

CachedScriptableObject<LoreObjectTemplate>.AddToCache(string)

CachedScriptableObject<LoreObjectTemplate>.RemoveFromCache()

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

CachedScriptableObject<LoreObjectTemplate>.GetFirst<U>()

CachedScriptableObject<LoreObjectTemplate>.GetCache<U>()

CachedScriptableObject<LoreObjectTemplate>.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

GrantAbilities

[Header("Optional Grants")]
public List<BaseAbilityTemplate> GrantAbilities

Field Value

List<BaseAbilityTemplate>

GrantAbilityEvents

Ability events immediately learned on interaction. Already-known events are skipped.

public List<AbilityEvent> GrantAbilityEvents

Field Value

List<AbilityEvent>

GrantItems

Items immediately added to the player's inventory on interaction.

public List<BaseItemTemplate> GrantItems

Field Value

List<BaseItemTemplate>

IconReference

Addressable reference to the icon sprite for this lore object.

public AssetReferenceSprite IconReference

Field Value

AssetReferenceSprite

LoreText

The lore text displayed to the player.

[TextArea(5, 20)]
public string LoreText

Field Value

string

Title

Display title for the lore window header.

public string Title

Field Value

string

Properties

Icon

The icon for this lore object (loaded at runtime on client).

public Sprite Icon { get; }

Property Value

Sprite

Name

The display name of this lore object template.

public string Name { get; }

Property Value

string

Methods

OnLoad(string, string, int)

Called when the lore object template is loaded into cache. Loads the icon on the client.

public override void OnLoad(string typeName, string resourceName, int resourceID)

Parameters

typeName string

resourceName string

resourceID int

OnUnload(string, string, int)

Called when the lore object template is unloaded from cache. Releases the icon on the client.

public override void OnUnload(string typeName, string resourceName, int resourceID)

Parameters

typeName string

resourceName string

resourceID int