Unity Playworks Plugin

https://docs.lunalabs.io/docs/
Admin
Unity Playworks Plugin is a Unity extension that enables developers to create high-quality playable...
Tokens:191,205
Snippets:1,684
Trust Score:8.4
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install .NET SDK via Homebrew

Source: https://docs.lunalabs.io/docs/playable/quickstart/

Run this command in the terminal to install the .NET SDK using Homebrew on macOS. This is an alternative to installing .NET through Visual Studio for Mac.

```bash
brew install --cask dotnet-sdk
```

--------------------------------

### Example: Scripting Define for Unity 2017.1 or newer

Source: https://docs.lunalabs.io/docs/playable/code/scripting-defines/

Wrap code in a scripting define to conditionally compile it for specific Unity versions. This example uses UNITY_2017_1_OR_NEWER. The code inside will only be compiled when the define is present.

```csharp
#if  UNITY_2017_1_OR_NEWER
//...Your Awesome Code...//
#endif
```

--------------------------------

### Subscribe to luna:build event

Source: https://docs.lunalabs.io/docs/playable/javascript-playables/setup/

Subscribe to the luna:build event, which fires right after the 'load' event of the window. The example logs a message when the playable is about to start.

```javascript
// Subscribe to luna:build event – will be fired right after 'load' event of the window.
window.addEventListener('luna:build', function () {
  log('Playable is about to start');
});
```

--------------------------------

### Deploy project with parameters

Source: https://docs.lunalabs.io/docs/playable/command-line/

Deploys with user email, token, and target platform. The user token is found under Settings → Account via the Copy token button.

```bash
./jake project:deploy USER_EMAIL=your.email@domain.com USER_TOKEN=%yourToken% TARGET_PLATFORM=playground
```

--------------------------------

### Log AppLovin challenge events with Luna.Unity.Analytics.Applovin

Source: https://docs.lunalabs.io/docs/playable/ad-networks/applovin/

Include the Luna.Unity.Analytics namespace and call the Applovin challenge event methods at the appropriate points in your game flow. The example shows methods for challenge start, progress thresholds (25%, 50%, 75%), and completion.

```csharp
using Luna.Unity.Analytics;

void OnChallengeStart() {
    Applovin.LogChallengeStarted();
}

void OnChallengeProgress(float progress) {
    if (progress >= 0.25f) Applovin.LogChallengePass25();
    if (progress >= 0.50f) Applovin.LogChallengePass50();
    if (progress >= 0.75f) Applovin.LogChallengePass75();
}

void OnChallengeComplete() {
    Applovin.LogChallengeSolved();
}
```

--------------------------------

### Luna.Unity.Playable.InstallFullGame()

Source: https://docs.lunalabs.io/docs/playable/playable-setup/playable-api/

Call this API to direct the user to the app store, typically after clicking an in-game CTA button or end card.

```APIDOC
## Luna.Unity.Playable.InstallFullGame()

### Description
Directs the user to the app store for the playable ad. Should be called when the user clicks the in-game CTA button or end card.

### Method
C# Method Call

### Endpoint
Luna.Unity.Playable.InstallFullGame()

### Parameters
None

### Request Example
```cs
Luna.Unity.Playable.InstallFullGame();
```

### Response
No return value.
```

--------------------------------

### Deploy project

Source: https://docs.lunalabs.io/docs/playable/command-line/

Runs the full project build and can upload directly to Unity Playworks with parameters.

```bash
./jake project:deploy
```

--------------------------------

### Inline out parameter example causing the error

Source: https://docs.lunalabs.io/docs/playable/common-issues/code/unexpected-token-name/

An example of C# code using an inline out parameter, which Bridge.NET cannot compile and triggers the error.

```cs
if (int.TryParse(value, out int i) {...}
```

--------------------------------

### Trigger app store click with Luna.Unity.Playable.InstallFullGame()

Source: https://docs.lunalabs.io/docs/playable/playable-setup/playable-api/

Call this API to direct the user to the app store, for example after clicking an in-game CTA button or end card.

```csharp
Luna.Unity.Playable.InstallFullGame();
```

--------------------------------

### LunaPlaygroundField and LunaPlaygroundAsset example

Source: https://docs.lunalabs.io/docs/playable/playable-setup/configure-game-variables/

Example of using LunaPlaygroundField and LunaPlaygroundAsset attributes to expose fields and assets in Unity Playworks. The attributes specify the field title, order, and group. The example shows fields for player color, speed, game levels, difficulty, and assets for game icon and video clip.

```csharp
[Header("Playable Ad Settings")]
[SerializeField]
[LunaPlaygroundField("Color of the player", 1, "Player Controls")]
private Color playerColor = Color.blue;

[SerializeField]
[LunaPlaygroundField("Speed of the player", 2, "Player Controls")]
private float playerSpeed = 1f;

[SerializeField]
[LunaPlaygroundField("Number of levels", 3, "Game Controls")]
private int gameLevels = 1;

[SerializeField]
[LunaPlaygroundField("Relative game difficulty", 4, "Game Controls")]
private int gameDifficulty = 3;

[SerializeField]
[LunaPlaygroundAsset("Game Icon", 5, "End Card")]
private Texture gameIconTexture;

[SerializeField]
[LunaPlaygroundAsset("Video Clip", 6, "End Card")]
private VideoClip videoClip;
```

--------------------------------

### playground.json example

Source: https://docs.lunalabs.io/docs/playable/javascript-playables/setup/

Example of playground.json with title, icon, and fields objects. The icon field takes a Data URL. The fields object can be populated with editable settings.

```json
{
  "title": "Basic Playable",
  "icon": "", // Icon next to the playable in Unity Playworks, takes a Data URL.

  "fields": {} // You can populate this with any settings you wish to be editable in Unity Playworks
}
```

--------------------------------

### Create a Size Breakdown report on Windows

Source: https://docs.lunalabs.io/docs/playable/command-line/

Generate a size breakdown on Windows by including STATS=1 in the build command. STATS=1 gives a shortened report, STATS=2 gives a full report.

```text
>  tools\node\win64\node.exe pipeline\node_modules\jake\bin\cli.js -f pipeline\Jakefile.js project:build STATS=1
```
Tokens:
Raw