Unity SDK

Installation

Add package from git URL: https://github.com/PlayFi-Labs/unity-plugin.git

Setup

  1. Open your start scene in the Unity editor

  2. Right-click on the Hierarchy view and press “Add PlayFiScreenshotsCollector”. Alternatively, you can drag “PlayFiScreenshotsCollector” prefab into the start scene Hierarchy view. The game object “PlayFiScreenshotsCollector” will appear in the Hierarchy view.

  3. In the “ScreenshotsCollector” script need to set the “ModelId” parameter for your project

Controlling plugin from the Editor

Select the game object “PlayFiScreenshotsCollector” in the Hierarchy view

  • “IsEnabled” parameter turns on/off automatic screenshots

  • “ScreenshotsTimeoutInSec” parameter adjusts the frequency of the automatic screenshots

  • “IsDebugMode” parameter turns on/off logging of debugging information

Controlling plugin from the code

  • “PlayFi.ScreenshotsCollector.Instance.IsEnabled” is used to set/get turn on/off automatic screenshots

  • “PlayFi.ScreenshotsCollector.Instance.ScreenshotTimeoutInSec” is used to set/get the frequency of the automatic screenshots

  • “PlayFi.ScreenshotsCollector.Instance.PayloadJson” is used to set/get JSON payload that will be sent with the next screenshot

  • “PlayFi.ScreenshotsCollector.Instance.IsMakingScreenshot” is used to check if the screenshot is currently in progress

  • “PlayFi.ScreenshotsCollector.Instance.ModelId” is used to set/get ModelId parameter

  • “PlayFi.ScreenshotsCollector.Instance.ProcessScreenshot” is used to make screenshots manually

Last updated