Class StateBuffTemplate

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Buff template that enables CharacterFlags on apply and disables them on remove. Used for crowd-control effects such as Frozen, Stunned, and Mesmerized. Flags are additive per stack: each stack enables the same flag (idempotent via bitwise OR), but removal only clears the flag when the last stack (and base) are removed.

[CreateAssetMenu(fileName = "New State Buff Template", menuName = "FishMMO/Character/Buff/State Buff", order = 2)]
public class StateBuffTemplate : BaseBuffTemplate, ICachedObject, ITooltip

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<BaseBuffTemplate>

BaseBuffTemplate

StateBuffTemplate

Implements

ICachedObject

ITooltip

Inherited Members

BaseBuffTemplate.FXPrefabReference

BaseBuffTemplate.Description

BaseBuffTemplate.Duration

BaseBuffTemplate.TickRate

BaseBuffTemplate.OnTickEvents

BaseBuffTemplate.MaxStacks

BaseBuffTemplate.IsPermanent

BaseBuffTemplate.IsDebuff

BaseBuffTemplate.Name

BaseBuffTemplate.Icon

BaseBuffTemplate.Tooltip()

BaseBuffTemplate.BuildTooltip(TooltipBuilder)

BaseBuffTemplate.OnLoad(string, string, int)

BaseBuffTemplate.OnUnload(string, string, int)

BaseBuffTemplate.OnApplyFX(Buff, ICharacter)

BaseBuffTemplate.OnRemoveFX(GameObject, ICharacter)

BaseBuffTemplate.OnTick(Buff, ICharacter)

BaseBuffTemplate.InvokeTickEvents(Buff, ICharacter)

BaseBuffTemplate.ApplyResourceTick(Buff, ICharacter, List<BuffAttributeTemplate>, DamageAttributeTemplate)

CachedScriptableObject<BaseBuffTemplate>.ID

CachedScriptableObject<BaseBuffTemplate>.AddToCache(string)

CachedScriptableObject<BaseBuffTemplate>.RemoveFromCache()

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

CachedScriptableObject<BaseBuffTemplate>.GetFirst<U>()

CachedScriptableObject<BaseBuffTemplate>.GetCache<U>()

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

Flag

The character flag to enable while this buff is active (e.g., IsFrozen, IsStunned, IsMesmerized).

[Tooltip("The CharacterFlag to enable while this buff is active.")]
public CharacterFlags Flag

Field Value

CharacterFlags

Methods

OnApply(Buff, ICharacter)

Enables the configured CharacterFlag on the target.

public override void OnApply(Buff buff, ICharacter target)

Parameters

buff Buff

The buff instance being applied.

target ICharacter

The character receiving the buff.

OnApplyStack(Buff, ICharacter)

Stacking is idempotent for flags — the flag is already enabled. No additional action needed on stack add.

public override void OnApplyStack(Buff buff, ICharacter target)

Parameters

buff Buff

The buff instance being stacked.

target ICharacter

The character receiving the stack.

OnRemove(Buff, ICharacter)

Disables the configured CharacterFlag on the target.

public override void OnRemove(Buff buff, ICharacter target)

Parameters

buff Buff

The buff instance being removed.

target ICharacter

The character losing the buff.

OnRemoveStack(Buff, ICharacter)

Stack removal does not disable the flag until the final removal via OnRemove.

public override void OnRemoveStack(Buff buff, ICharacter target)

Parameters

buff Buff

The buff instance being unstacked.

target ICharacter

The character losing the stack.

SecondaryTooltip(TooltipBuilder)

Appends a secondary tooltip describing the state effect.

public override void SecondaryTooltip(TooltipBuilder builder)

Parameters

builder TooltipBuilder

The tooltip builder to populate.