Configuration
Every option accepted by RoStructure.init.
Options
| Option | Required | Meaning |
|---|---|---|
projectId | Yes | Your project ID. Sent as X-Project-Id and in every event. |
ingestionKey | Yes | Server-held key that authenticates your game. Not a dashboard credential. |
buildId | Yes | Identifies the version of your game. "v" .. game.PlaceVersion is a good default. |
endpoint | Yes | Base URL, for example https://api.rostructure.com. |
pseudonymSalt | No | Secret salt for anonymous player IDs. Defaults to the ingestion key. Keep it stable, or IDs change. |
enableInStudio | No | The SDK does nothing in Studio unless this is true. |
autoTrack | No | Toggle automatic events: { sessions, deaths, quits }, each on by default. |
sampling | No | Keep-probability per event name, for example { custom_event = 0.1 }. Use it only for noisy optional events. |
flushInterval | No | Seconds a partial batch waits before sending. Default 5. |
batchSize | No | Events per request, 1 to 100. Default 100. |
maxQueue | No | Events held in memory. Default 5,000. The oldest are dropped when full. |
maxRetries | No | Retries per batch before it is dropped. Default 5. |
debug | No | Prints one line per request. |