Class InsightsKit
InsightsKit allows you to get some insight to how the game is running.
Inheritance
Namespace: Trail
Assembly: Trail.dll
Syntax
public static class InsightsKit : objectFields
MaxCustomEventNameLength
Declaration
public const int MaxCustomEventNameLength = nullField Value
| Type | Description |
|---|---|
| System.Int32 |
MaxQualityLevelNameLength
Declaration
public const int MaxQualityLevelNameLength = nullField Value
| Type | Description |
|---|---|
| System.Int32 |
MaxSceneIDLength
Declaration
public const int MaxSceneIDLength = nullField Value
| Type | Description |
|---|---|
| System.Int32 |
MaxSceneNameLength
Declaration
public const int MaxSceneNameLength = nullField Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
ReportFirstGameplayEvent()
Reports that the user has started playing.
Declaration
public static Result ReportFirstGameplayEvent()Returns
| Type | Description |
|---|---|
| Result |
ReportQualityLevelChanged(Int32, String)
Reports that the quality level has changed.
Declaration
public static Result ReportQualityLevelChanged(Int32 level, string name = null)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | level | New quality level |
| System.String | name | Name of new quality level. (Optional). |
Returns
| Type | Description |
|---|---|
| Result | Returns whether succeeded or not to report. |
ReportResolutionChanged(Resolution)
Reports that the resolution has changed.
Declaration
public static Result ReportResolutionChanged(Resolution resolution)Parameters
| Type | Name | Description |
|---|---|---|
| Resolution | resolution | Resolution value to provide in the report. |
Returns
| Type | Description |
|---|---|
| Result | Returns whether it succeeded or not to report. |
ReportResolutionChanged(UnityEngine.Resolution)
Reports that the resolution has changed.
Declaration
public static Result ReportResolutionChanged(UnityEngine.Resolution resolution)Parameters
| Type | Name | Description |
|---|---|---|
| UnityEngine.Resolution | resolution | Resolution value to provide in the report. |
Returns
| Type | Description |
|---|---|
| Result | Returns whether it succeeded or not to report. |
ReportSceneChanged(String, String)
Reports that the scene has changed.
Declaration
public static Result ReportSceneChanged(string id, string name = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The scene id |
| System.String | name | The scene name |
Returns
| Type | Description |
|---|---|
| Result | Returns whether succeeded or not to report the scene change. |
ReportSceneChanged(UnityEngine.SceneManagement.Scene)
Reports that the scene has changed.
Declaration
public static Result ReportSceneChanged(UnityEngine.SceneManagement.Scene scene)Parameters
| Type | Name | Description |
|---|---|---|
| UnityEngine.SceneManagement.Scene | scene | The unity scene to report change to. |
Returns
| Type | Description |
|---|---|
| Result | Returns whether succeeded or not to report the scene change. |
SendCustomEvent(String, String)
Sends a custom insights event to Trail.
Declaration
public static Result SendCustomEvent(string name, string payloadJSON = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | Name of event. |
| System.String | payloadJSON | JSON payload with any extra event properties. (Optional) |
Returns
| Type | Description |
|---|---|
| Result |