PlayVlay Game SDK

https://playvlay.com/creators
Admin
PlayVlay Game SDK allows creators to build and host self-contained HTML5 games on the PlayVlay...
Tokens:2,973
Snippets:24
Trust Score:2.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### PlayVlay.onInit(fn)

Source: https://playvlay.com/creators

Host-to-game event handler. Called once before start, providing context with level, difficultyParams, muted, and seed.

```APIDOC
## PlayVlay.onInit(fn)

### Description
Registers a handler for the init event, called once before the game starts.

### Parameters
- **fn** (function) - Required - Callback that receives a context object with properties: level, difficultyParams, muted, seed.

### Returns
None
```

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

### PlayVlay.ready()

Source: https://playvlay.com/creators

Required. Tells the host that the game has loaded and registered its handlers, allowing the host to start the game.

```APIDOC
## PlayVlay.ready()

### Description
Required. Called after registering all event handlers to signal the host that the game is ready to start.

### Method
ready

### Parameters
None

### Returns
None
```

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

### PlayVlay.onRestart(fn)

Source: https://playvlay.com/creators

Host-to-game event handler. Called to reset and start the game again.

```APIDOC
## PlayVlay.onRestart(fn)

### Description
Registers a handler for the restart event, called to reset and start the game again.

### Parameters
- **fn** (function) - Required - Callback to execute on restart.

### Returns
None
```

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

### PlayVlay.onStart(fn)

Source: https://playvlay.com/creators

Host-to-game event handler. Called when the run begins.

```APIDOC
## PlayVlay.onStart(fn)

### Description
Registers a handler for the start event, called when the run begins.

### Parameters
- **fn** (function) - Required - Callback to execute on start.

### Returns
None
```

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

### Minimal PlayVlay Starter Template

Source: https://playvlay.com/creators

A complete HTML/JS template for a tap-to-score game. It includes basic styling, game logic, and integration with the PlayVlay API for reporting scores and managing game states.

```html
<!doctype html>
<html>
<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
  <meta name="description" content="A PlayVlay starter game — tap to score." />
  <title>My PlayVlay Game</title>
  <style>
    html,body{margin:0;height:100%;background:#0b0b14;overflow:hidden;
      font-family:-apple-system,system-ui,sans-serif;color:#fff;-webkit-user-select:none;user-select:none}
    #wrap{position:fixed;inset:0;display:flex;align-items:center;justify-content:center;flex-direction:column}
    #score{font-size:64px;font-weight:800}
    #hint{margin-top:8px;opacity:.6;font-size:16px}
    #tap{position:fixed;inset:0}
  </style>
</head>
<body>
  <div id="wrap"><div id="score">0</div><div id="hint">Tap anywhere to score</div></div>
  <div id="tap"></div>
  <script>
    var score = 0, running = false, timeLeft = 30, timer = null;
    var scoreEl = document.getElementById("score");
    var hintEl = document.getElementById("hint");
    function start(){ score=0; timeLeft=30; running=true; scoreEl.textContent="0";
      hintEl.textContent="Tap! 30s"; clearInterval(timer);
      timer=setInterval(function(){ timeLeft--; hintEl.textContent="Tap! "+timeLeft+"s";
        if(timeLeft<=0) end(); },1000); }
    function end(){ running=false; clearInterval(timer);
      hintEl.textContent="Game over — score "+score;
      if(window.PlayVlay) PlayVlay.gameOver(score); }
    document.getElementById("tap").addEventListener("pointerdown",function(){
      if(!running) return; score++; scoreEl.textContent=String(score);
      if(window.PlayVlay) PlayVlay.reportScore(score); });
    if(window.PlayVlay){
      PlayVlay.onStart(start); PlayVlay.onRestart(start);
      PlayVlay.onPause(function(){ running=false; clearInterval(timer); });
      PlayVlay.onResume(function(){ if(timeLeft>0) start(); });
      PlayVlay.ready();
    } else { start(); }
  </script>
</body>
</html>
```

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

### PlayVlay.haptic('success')

Source: https://playvlay.com/creators

Optional. Triggers a haptic feedback effect on the host device.

```APIDOC
## PlayVlay.haptic('success')

### Description
Optional. Requests haptic feedback from the host device.

### Parameters
- **type** (string) - Required - The type of haptic effect (e.g., 'success').

### Returns
None
```

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

### PlayVlay.onPause(fn) / onResume(fn)

Source: https://playvlay.com/creators

Host-to-game event handlers. Called to freeze or unfreeze the game.

```APIDOC
## PlayVlay.onPause(fn) / onResume(fn)

### Description
Registers handlers for pause and resume events, used to freeze or unfreeze the game.

### Parameters
- **fn** (function) - Required - Callback to execute on pause or resume.

### Returns
None
```

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

### PlayVlay.onSetMuted(fn)

Source: https://playvlay.com/creators

Host-to-game event handler. Called to mute or unmute audio.

```APIDOC
## PlayVlay.onSetMuted(fn)

### Description
Registers a handler for the setMuted event, called to mute or unmute audio.

### Parameters
- **fn** (function) - Required - Callback that receives a boolean `muted`.

### Returns
None
```

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

### PlayVlay.track(name, props)

Source: https://playvlay.com/creators

Optional. Sends an analytics event to the host.

```APIDOC
## PlayVlay.track(name, props)

### Description
Optional. Sends an analytics event with a name and properties.

### Parameters
- **name** (string) - Required - The event name.
- **props** (object) - Required - Additional properties for the event.

### Returns
None
```

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

### PlayVlay.reachedLevel(n)

Source: https://playvlay.com/creators

Optional. Tells the host that the player unlocked a level without ending the run. Advances the user's per-game Rank.

```APIDOC
## PlayVlay.reachedLevel(n)

### Description
Optional. Notifies the host that the player reached a new level, advancing the user's rank.

### Parameters
- **n** (integer) - Required - The level number that was unlocked.

### Returns
None
```

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

### PlayVlay.gameOver(n)

Source: https://playvlay.com/creators

Required. Called exactly once when the run ends, passing the final score.

```APIDOC
## PlayVlay.gameOver(n)

### Description
Required. Signals the end of the game run with the final score.

### Parameters
- **n** (integer) - Required - The final score.

### Returns
None
```

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

### PlayVlay.reportScore(n)

Source: https://playvlay.com/creators

Required. Called whenever the score changes. The score must be a plain integer.

```APIDOC
## PlayVlay.reportScore(n)

### Description
Required. Reports the current score to the host. Should be called whenever the score changes.

### Parameters
- **n** (integer) - Required - The current score value.

### Returns
None
```

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

### PlayVlay.reportHighScore(n)

Source: https://playvlay.com/creators

Optional. Submits a high-score attempt without ending the run. Safe to call repeatedly for endless or continuous games.

```APIDOC
## PlayVlay.reportHighScore(n)

### Description
Optional. Submits a high-score attempt without ending the run. The host records it against the user's best and the game continues.

### Parameters
- **n** (integer) - Required - The high-score value to report.

### Returns
None
```
Tokens:
Raw