Class BaseItemTemplate

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Abstract base class for item templates, providing common properties and tooltip logic for all items. Implements ITooltip for UI display and ICachedObject for template caching.

public abstract class BaseItemTemplate : CachedScriptableObject<BaseItemTemplate>, ICachedObject, ITooltip

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<BaseItemTemplate>

BaseItemTemplate

Implements

ICachedObject

ITooltip

Derived

ConsumableTemplate

EquippableItemTemplate

Inherited Members

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

Attributes

The base attributes added to the item after generation.

[Tooltip("The base attributes that are added to the item after the ItemGenerator has completed.")]
public List<ItemAttributeTemplate> Attributes

Field Value

List<ItemAttributeTemplate>

Generate

Indicates if the item should be generated (used in item generation systems).

public bool Generate

Field Value

bool

IconPools

Pools of icons for item generation and randomization.

public int[] IconPools

Field Value

int[]

IsIdentifiable

Indicates if the item can be identified (e.g., has hidden stats).

public bool IsIdentifiable

Field Value

bool

MaxStackSize

The maximum stack size for this item (if greater than 1, item is stackable).

public uint MaxStackSize

Field Value

uint

MeshReference

Addressable reference to the mesh for 3D representation of the item.

public AssetReference MeshReference

Field Value

AssetReference

Price

The price of the item, used for buying/selling.

public int Price

Field Value

int

icon

Addressable reference to the icon sprite for this item.

public AssetReferenceSprite icon

Field Value

AssetReferenceSprite

Properties

Icon

Gets the icon sprite for this item (loaded at runtime on client).

public Sprite Icon { get; }

Property Value

Sprite

IsStackable

Returns true if the item is stackable (MaxStackSize > 1).

public bool IsStackable { get; }

Property Value

bool

Mesh

Gets the mesh for this item (loaded at runtime on client).

public Mesh Mesh { get; }

Property Value

Mesh

Name

Gets the name of this item template (defaults to the asset name).

public string Name { get; }

Property Value

string

Methods

BuildTooltip(TooltipBuilder)

Populates the tooltip builder with this item's tooltip lines. Override in derived types to add additional lines.

public virtual void BuildTooltip(TooltipBuilder builder)

Parameters

builder TooltipBuilder

The tooltip builder to populate.

OnLoad(string, string, int)

Called when the item template is loaded into cache. Loads the icon and mesh on the client.

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

Parameters

typeName string

The type name of the resource.

resourceName string

The resource name.

resourceID int

The resource ID.

OnUnload(string, string, int)

Called when the item template is unloaded from cache. Releases the icon and mesh on the client.

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

Parameters

typeName string

The type name of the resource.

resourceName string

The resource name.

resourceID int

The resource ID.

Tooltip()

Returns the formatted tooltip string for this item, including name and price.

public virtual string Tooltip()

Returns

string

The formatted tooltip string.