Class NPCGuildTemplate

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

ScriptableObject template for defining NPC guilds, their icon, description, archetypes, and requirements.

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

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<NPCGuildTemplate>

NPCGuildTemplate

Implements

ICachedObject

Inherited Members

CachedScriptableObject<NPCGuildTemplate>.ID

CachedScriptableObject<NPCGuildTemplate>.AddToCache(string)

CachedScriptableObject<NPCGuildTemplate>.RemoveFromCache()

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

CachedScriptableObject<NPCGuildTemplate>.GetFirst<U>()

CachedScriptableObject<NPCGuildTemplate>.GetCache<U>()

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

Archetypes

List of archetypes associated with this guild.

public List<ArchetypeTemplate> Archetypes

Field Value

List<ArchetypeTemplate>

Description

Description of the guild and its purpose.

public string Description

Field Value

string

GuildRequirements

Requirements that a player must meet to join or interact with this guild.

public BaseCondition GuildRequirements

Field Value

BaseCondition

IconReference

Addressable reference to the icon sprite for this guild.

public AssetReferenceSprite IconReference

Field Value

AssetReferenceSprite

Properties

Icon

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

public Sprite Icon { get; }

Property Value

Sprite

Name

The name of the guild, derived from the asset name.

public string Name { get; }

Property Value

string

Methods

MeetsRequirements(IPlayerCharacter)

Returns true if requirements are met or if no requirements are set.

public bool MeetsRequirements(IPlayerCharacter playerCharacter)

Parameters

playerCharacter IPlayerCharacter

The player character to evaluate.

Returns

bool

True if requirements are met, false otherwise.

OnLoad(string, string, int)

Called when the NPC guild 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 NPC guild 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