Skip to content

Opções do init ​

OpçãoTipoPadrãoIntervaloEfeito
keySecret | string—não vaziachave de ingestão do jogo. Obrigatória
endpointstring"https://ingest.rometrics.app"URL http(s)://host do ingest. Barras finais são removidas
flushIntervalnumber (s)101 – 300intervalo entre envios
maxBatchSizenumber1001 – 500eventos por envio. Inteiro
maxQueueSizenumber50001 – 100000, ≥ maxBatchSizeeventos em memória antes de descartar os mais antigos
heartbeatIntervalnumber (s)305 – 60intervalo do heartbeat do servidor (alimenta o CCU)
forwardToRobloxAnalyticsbooleanfalse—repassa cada Log* ao AnalyticsService nativo
debugbooleanfalse—logs detalhados no Output
enabledInStudiobooleanfalse—envia também durante o Play no Studio

Comportamento com valor inválido:

  • Tipo errado → aviso e valor padrão.
  • Fora do intervalo → aviso e o valor mais próximo permitido.
  • maxQueueSize menor que maxBatchSize → usa maxBatchSize.
  • endpoint que não é URL http(s) → aviso e endpoint padrão.
  • key ausente, vazia ou de tipo errado → o init falha com aviso e o SDK fica desligado (o jogo segue normal).

Tipo ​

lua
export type Options = {
	key: (string | Secret)?,
	endpoint: string?,
	flushInterval: number?,
	maxBatchSize: number?,
	maxQueueSize: number?,
	heartbeatInterval: number?,
	forwardToRobloxAnalytics: boolean?,
	debug: boolean?,
	enabledInStudio: boolean?,
}

Código sob licença MIT.