Sandbox: Lua: Sound - ov-studio/Vital.sandbox GitHub Wiki

━ What's the Objective?

Advanced audio simulation utilizing the power, limits & capabilities of industry standard audio engine: FMOD.

Bring your sandbox to life by utilizing our straightforward higher level scripting APIs provided by audio module.

Want to build a game/server focusing heavily on music? footpath sound for your character? material sounds? or just an awesome environment ambience? Don't hold your breathe, FMOD best suits all your audio needs.

━ APIs

━ sound.create() (Client)

@Objective: Creates a sound entity.

local userdata: sound* = sound.create(
  string: path
)

━ sound.destroy() (Client)

@Objective: Destroys an existing sound entity.

local bool: result = sound.destroy(
  userdata: sound*
)

━ sound.play() (Client)

@Objective: Plays an existing sound entity.

local bool: result = sound.play(
  userdata: sound*
)

━ sound.stop() (Client)

@Objective: Stops an existing sound entity.

local bool: result = sound.stop(
  userdata: sound*
)