Skip to content

Analytics

Functions

Function Name Usage Description Notes
SendTelemetry Analytics.SendTelemetry(Entity entity, string type, table parametersTable) Send an type of telemetry event to the telemetry server with the given entity and parametersTable for later analysis. (Note: Currently specific telemetry analytics are not available to creators)
SendTelemetry Analytics.SendTelemetry(string type, table parametersTable) Send an type of telemetry event to the telemetry server with the given parametersTable for later analysis. (Note: Currently specific telemetry analytics are not available to creators)
MatchStarted AnalyticsHandle Analytics.MatchStarted() Send a MatchStarted event for later analysis. It is up to the game to define what a match is, for example a single round of a game might be defined as a match. Returns a handle that can be passed to MatchEnded to define the match start and end. (Note: Currently specific telemetry analytics are not available to creators)
MatchEnded Analytics.MatchEnded(AnalyticsHandle matchHandle) Send a MatchEnded event for later analysis. (Note: Currently specific telemetry analytics are not available to creators)
MatchEnded Analytics.MatchEnded(AnalyticsHandle matchHandle, table userEntriesTable) Send a MatchEnded event for later analysis. Takes a table with an entry per user with a 'user' and 'rank' value (Note: Currently specific telemetry analytics are not available to creators)
Attacked Analytics.Attacked(Entity attacker, Entity victim) Send an Attacked event for later analysis. When an attack entity attack another victim entity. Should be recorded when an attack makes contact or impacts a player or entity. (Note: Currently specific telemetry analytics are not available to creators)
Attacked Analytics.Attacked(Entity attacker, Entity victim, Entity weapon) Send an Attacked event for later analysis. When an attack entity attack another victim entity. Should be recorded when an attack makes contact or impacts a player or entity. (Note: Currently specific telemetry analytics are not available to creators)
Defeated Analytics.Defeated(Entity attacker, Entity victim) Send a Defeated event for later analysis. When a player or entity is defeated. (Note: Currently specific telemetry analytics are not available to creators)
PlayerHealthCritical Analytics.PlayerHealthCritical(Entity playerOrUser) Send a PlayerHealthCritical event for later analysis. When a players health is critically low. (Note: Currently specific telemetry analytics are not available to creators)