Skip to main content

AnalyticsDelegate

A class that manages the analytics system. This class is responsible for writing events to the event queue and managing the trackers that collect certain information about the game.

Functions​

RegisterTracker​

</>
AnalyticsDelegate:RegisterTracker(
trackerId: string,
tracker: any
) → ()

Registers a tracker with the analytics delegate. This allows the tracker to write events to the event queue.

AnalyticsDelegate:RegisterTracker("PlayerTracker", PlayerTracker.new({
    EventQueue = self._eventQueue,
    Debug = self._eventQueue.Debug
}))

GetTracker​

</>
AnalyticsDelegate:GetTracker(trackerId: string) → ()

Fetches a tracker with the given trackerId.

WriteEvent​

</>
AnalyticsDelegate:WriteEvent(
eventName: string,
eventData: {[string]: any}
) → ()

Writes an event to the event queue.

WritePlayerEvent​

</>
AnalyticsDelegate:WritePlayerEvent(
eventName: string,
player: Player,
eventData: {[string]: any}
) → ()

Writes a player event to the event queue.

SetDebugEnabled​

</>
AnalyticsDelegate:SetDebugEnabled(enabled: boolean) → ()

Sets whether debug messages should be printed. Useful to tie into CMDR

Show raw api
{
    "functions": [
        {
            "name": "RegisterTracker",
            "desc": "Registers a tracker with the analytics delegate. This allows the tracker to write events to the event queue.\n\n```lua\nAnalyticsDelegate:RegisterTracker(\"PlayerTracker\", PlayerTracker.new({\n    EventQueue = self._eventQueue,\n    Debug = self._eventQueue.Debug\n}))\n```",
            "params": [
                {
                    "name": "trackerId",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "tracker",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 83,
                "path": "src/orionanalytics/src/Server/AnalyticsDelegate/init.lua"
            }
        },
        {
            "name": "GetTracker",
            "desc": "Fetches a tracker with the given trackerId.",
            "params": [
                {
                    "name": "trackerId",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 98,
                "path": "src/orionanalytics/src/Server/AnalyticsDelegate/init.lua"
            }
        },
        {
            "name": "WriteEvent",
            "desc": "Writes an event to the event queue.",
            "params": [
                {
                    "name": "eventName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "eventData",
                    "desc": "",
                    "lua_type": "{ [string]: any}"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 107,
                "path": "src/orionanalytics/src/Server/AnalyticsDelegate/init.lua"
            }
        },
        {
            "name": "WritePlayerEvent",
            "desc": "Writes a player event to the event queue.",
            "params": [
                {
                    "name": "eventName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "eventData",
                    "desc": "",
                    "lua_type": "{ [string]: any }"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 128,
                "path": "src/orionanalytics/src/Server/AnalyticsDelegate/init.lua"
            }
        },
        {
            "name": "SetDebugEnabled",
            "desc": "Sets whether debug messages should be printed. Useful to tie into CMDR",
            "params": [
                {
                    "name": "enabled",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 147,
                "path": "src/orionanalytics/src/Server/AnalyticsDelegate/init.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AnalyticsDelegate",
    "desc": "A class that manages the analytics system. This class is responsible for writing events to the event queue and managing the trackers that collect certain information about the game.",
    "source": {
        "line": 8,
        "path": "src/orionanalytics/src/Server/AnalyticsDelegate/init.lua"
    }
}