Skip to main content

FunnelStepTracker

Functions​

new​

</>
FunnelStepTracker.new() → FunnelStepTracker

Constructs a new FunnelStepTracker

LogStep​

</>
FunnelStepTracker.LogStep(
stepNumber: number,
stepName: string
) → ()

Logs a step

IsStepComplete​

</>
FunnelStepTracker.IsStepComplete(
stepNumber: number
) → string?

Returns true if the step is complete

GetLoggedSteps​

</>
FunnelStepTracker.GetLoggedSteps(self: FunnelStepTracker) → {[number]: string}

Gets the logged steps

ClearLoggedSteps​

</>
FunnelStepTracker.ClearLoggedSteps(self: FunnelStepTracker) → ()

Clears all logged steps

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new FunnelStepTracker",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "FunnelStepTracker"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 30,
                "path": "src/funnels/src/Shared/Steps/FunnelStepTracker.lua"
            }
        },
        {
            "name": "LogStep",
            "desc": "Logs a step",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FunnelStepTracker"
                },
                {
                    "name": "stepNumber",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "stepName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "src/funnels/src/Shared/Steps/FunnelStepTracker.lua"
            }
        },
        {
            "name": "IsStepComplete",
            "desc": "Returns true if the step is complete",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FunnelStepTracker"
                },
                {
                    "name": "stepNumber",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 72,
                "path": "src/funnels/src/Shared/Steps/FunnelStepTracker.lua"
            }
        },
        {
            "name": "GetLoggedSteps",
            "desc": "Gets the logged steps",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FunnelStepTracker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ [number]: string }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 83,
                "path": "src/funnels/src/Shared/Steps/FunnelStepTracker.lua"
            }
        },
        {
            "name": "ClearLoggedSteps",
            "desc": "Clears all logged steps",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FunnelStepTracker"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 90,
                "path": "src/funnels/src/Shared/Steps/FunnelStepTracker.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "FunnelStepTracker",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/funnels/src/Shared/Steps/FunnelStepTracker.lua"
    }
}