Class MerchantTemplate

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

[CreateAssetMenu(fileName = "New Merchant", menuName = "FishMMO/Character/Merchant/Merchant", order = 1)]
public class MerchantTemplate : CachedScriptableObject<MerchantTemplate>, ICachedObject

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<MerchantTemplate>

MerchantTemplate

Implements

ICachedObject

Inherited Members

CachedScriptableObject<MerchantTemplate>.ID

CachedScriptableObject<MerchantTemplate>.AddToCache(string)

CachedScriptableObject<MerchantTemplate>.RemoveFromCache()

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

CachedScriptableObject<MerchantTemplate>.GetFirst<U>()

CachedScriptableObject<MerchantTemplate>.GetCache<U>()

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

Abilities

List of abilities that this merchant can offer or use.

public List<AbilityTemplate> Abilities

Field Value

List<AbilityTemplate>

AbilityEvents

List of ability events associated with this merchant (e.g., triggers for special actions).

public List<AbilityEvent> AbilityEvents

Field Value

List<AbilityEvent>

BuysItems

Whether this merchant buys items from the player.

public bool BuysItems

Field Value

bool

Remarks

Off by default so adding the sell path does not silently turn every existing merchant — including quest givers and trainers that happen to use a merchant template — into a general fence. Content opts in.

Description

Description of the merchant, used for tooltips and UI.

public string Description

Field Value

string

Items

List of items available for sale by this merchant.

public List<BaseItemTemplate> Items

Field Value

List<BaseItemTemplate>

PremadeAbilities

Complete, ready-to-use abilities this merchant sells. See PremadeAbilityTemplate.

public List<PremadeAbilityTemplate> PremadeAbilities

Field Value

List<PremadeAbilityTemplate>

Remarks

Distinct from Abilities, which sells TEMPLATES that must still be crafted. A player who buys from this list can use the ability at once; a player who buys from that one has to visit an Ability Crafter first, which is the step issue #247 reported as the UI giving no hint about.

SellPriceMultiplier

Fraction of an item's template price the merchant pays for it.

[Range(0, 1)]
public float SellPriceMultiplier

Field Value

float

Remarks

Lives on the template, and therefore on the server, because it is half of the sale price and the client is never allowed to contribute to a price. The payout is floor(Template.Price * SellPriceMultiplier) * quantity, computed server-side from the item actually found in the named slot.

icon

Addressable reference to the icon sprite for this merchant.

public AssetReferenceSprite icon

Field Value

AssetReferenceSprite

Properties

Icon

The icon representing this merchant in the UI (loaded at runtime on client).

public Sprite Icon { get; }

Property Value

Sprite

Name

The display name of the merchant (from the ScriptableObject's name).

public string Name { get; }

Property Value

string

Methods

OnLoad(string, string, int)

Called when the merchant 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 merchant 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