StartSound

From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 18:47, 8 March 2013 by AFRLme (talk)

Command History

Available since v3.8


Allows you to play sound files; with optional property values!

Additional Info

Currently available properties:
  • volume (allows you to set volume level)
  • balance (allows you to set left/right balance)
  • offset (allows you to start audio file from x time; in ms)
  • loop (allows you to loop the audio file)


Syntax:

startSound("filename", {flags=1, properties})


Example 1: basic play audio file method

n/a

Example 2: ...

n/a


Arguments

filename: path
The path to the audio file to be played! ("path/filename.type")


Flags

properties

  • volume: allows you to set volume level via an integer value
  • balance: allows you to set the left/right audio balance via an integer value (-1000/0/1000)
  • offset: allows you to start audio file from x time via an integer value (in ms)
  • loop: allows you to declare if audio file should loop via a boolean value (true/false)


Return

visionaireObject
The visionaire object representing the active action!