Appearance
K.Stats
Functions
K.Stats.Define
lua
K.Stats.Define(name: string, options: { [string]: any }?)K.Stats.Exists
lua
K.Stats.Exists(name: string): booleanK.Stats.Names
lua
K.Stats.Names(): { string }K.Stats.Get
lua
K.Stats.Get(...: any): numberServer: Get(owner, name). Client: Get(name) for yourself, or Get(otherPlayerOrNpc, name).
K.Stats.GetBase
lua
K.Stats.GetBase(target: Instance, name: string): numberThe value before formulas and modifiers.
K.Stats.SetBase
lua
K.Stats.SetBase(target: Instance, name: string, value: number)K.Stats.AddBase
lua
K.Stats.AddBase(target: Instance, name: string, amount: number)K.Stats.AddModifier
lua
K.Stats.AddModifier(target: Instance, name: string, options: { [string]: any }?): stringAdds a buff or debuff. Returns its Id, which K.Stats.RemoveModifier takes. If a hook cancels it, nothing is added (the Id is still returned).
K.Stats.RemoveModifier
lua
K.Stats.RemoveModifier(target: Instance, id: string): booleanRemoves every modifier with this Id (from all stats). Returns true if any was removed.
K.Stats.HasModifier
lua
K.Stats.HasModifier(target: Instance, id: string): booleanK.Stats.ClearModifiers
lua
K.Stats.ClearModifiers(target: Instance)K.Stats.OnChanged
lua
K.Stats.OnChanged(name: string, callback: (...any) -> ())Server: callback(owner, new, old). Client: callback(new, old) for your own stat.
K.Stats.Refresh
lua
K.Stats.Refresh(target: Instance?)Works every stat out again, for one player or NPC or for everyone. Call it when something a Compute hook reads changes (say a player becomes VIP).
Events
K.Stats.Changed
Server: fires with (owner, name, newValue, oldValue).
Generated from
src/Corode/Stats.luau.
