Analytics | CraytaKit
Skip to main content

Analytics

Class Functions

Class Function NameReturn TypeDescriptionTag
Analytics.SendTelemetry(Entity entity, string type, table parameters)NoneSend an type of telemetry event to the telemetry server with the given entity and parametersTable for later analysisNone
Analytics.SendTelemetry(string type, table parameters)NoneSend an type of telemetry event to the telemetry server with the given parametersTable for later analysisNone
Analytics.MatchStarted()AnalyticsHandleSend 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 endNone
Analytics.MatchEnded(AnalyticsHandle matchHandle)NoneSend a MatchEnded event for later analysisNone
Analytics.MatchEnded(AnalyticsHandle matchHandle, table userEntries)NoneSend a MatchEnded event for later analysis. Takes a table with an entry per user with a 'user' and 'rank' valueNone
Analytics.Attacked(Entity attacked, Entity victim)NoneSend 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 entityNone
Analytics.Attacked(Entity attacker, Entity victim, Entity weapon)NoneSend 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 entityNone
Analytics.Defeated(Entity attacker, Entity victim)NoneSend a Defeated event for later analysis. When a player or entity is defeatedNone
Analytics.PlayerHealthCritical(Entity playerOrUser)NoneSend a PlayerHealthCritical event for later analysis. When a players health is critically lowNone

Examples

© 2021 CraytaKit