Skip to content

K.Analytics ​

Functions ​

K.Analytics.Enable ​

lua
K.Analytics.Enable(options: { Economy: boolean?, Quests: boolean?, Print: boolean? }?)

Turns on automatic tracking. Options: Economy, Quests (both true), Print (false).

K.Analytics.Funnel ​

lua
K.Analytics.Funnel(name: string, steps: { string }, options: { Onboarding: boolean?, ClientSteps: boolean? }?)

Defines the steps of a funnel, in order. Options: Onboarding (the one funnel that tracks new players; each step counts once per player), ClientSteps (LocalScripts may log steps).

K.Analytics.CheckStep ​

lua
K.Analytics.CheckStep(name: string, step: string)

Raises a helpful error if the funnel or step doesn't exist (used to catch typos early).

K.Analytics.Step ​

lua
K.Analytics.Step(...: any)

Logs a funnel step. Server: Step(player, funnel, step). Client: Step(funnel, step) for funnels with ClientSteps = true.

K.Analytics.Progression ​

lua
K.Analytics.Progression(player: Player, path: string, level: number, status: string?)

Logs progress along a path of levels. status: "Start", "Complete" or "Fail" (nil: just reached).

K.Analytics.Event ​

lua
K.Analytics.Event(player: Player, name: string, value: number?, fields: { any }?)

Logs a custom event: Event(player, name, value?, { up to 3 breakdown values }).

K.Analytics.Experiment ​

lua
K.Analytics.Experiment(name: string, groups: { [any]: any })

An A/B test. Groups: a list (equal shares) or { GroupName = weight }.

K.Analytics.Group ​

lua
K.Analytics.Group(...: any): string?

The player's group in an experiment. Server: Group(player, name). Client: Group(name).

Generated from src/Corode/Analytics.luau.

Corode 0.13.0 · MIT License