Scenes

A cutscene playing system, best used with the event tools.

Functions

impulse.Scenes.Play(stage, sceneData, onDone, skipPVS, preLoad)
Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

View source »

Plays a singular scene.

Parameters

  • stage int

    Stage of the set that is currently playing.

  • sceneData table

    Data used to play the scene

  • onDone function default: true

    Callback function when done.

  • skipPVS boolean

    Skips adding the Scene's PVS to clients.

  • preLoad

    should preload

impulse.Scenes.PlaySet(set, music, onDone)

 View source »

Plays a set of scenes.

Parameters

  • set table

    Set of scenes to play.

  • music string

    Can be a sound file path OR a CDN URL (Content Download Network).

  • onDone function

    Callback func.