PlaySound
From MaratisWiki
(Difference between revisions)
(Created page with "Simply play a sound. Note : If you enable "loop" in the sound object proprieties, the sound will play even if there's no script applied to it. Example 1 (WRONG example) : Th...") |
|||
(6 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | {{lua-function|playSound|object}} | |
− | + | Play a sound. | |
− | + | {{lua-function-param|object|object to operate on}} | |
− | + | ||
− | |||
− | |||
− | |||
− | |||
− | + | * The '''Loop''' option will play and loop the sound even if there's no script applied to it. | |
+ | * If the '''Relative''' option is checked, the sound will play on 'global' mode (won't be affected by position) | ||
− | + | ||
− | soundplay = 0 | + | '''Example 1 :''' Play a sound on key press. will work fine only with onKeyDown. if you try with isKeyPressed, sound will be played 1 time every frames, so you must use example 2 or 3 method instead. |
− | + | ||
− | + | <nowiki>Sound0 = getObject("Sound0") | |
− | + | function onSceneUpdate() | |
− | + | if onKeyDown("SPACE") then playSound(Sound0) end | |
− | + | end</nowiki> | |
− | + | ||
− | + | ||
+ | '''Example 2:''' Play a sound on key press. the sound will stop playing after 1 time | ||
+ | |||
+ | <nowiki>Sound0 = getObject("Sound0") | ||
+ | soundplay = 0 | ||
+ | function onSceneUpdate() | ||
+ | if isKeyPressed("SPACE") then | ||
+ | if soundplay == 0 then playSound(Sound0) end | ||
+ | soundplay = 1 | ||
+ | else | ||
+ | soundplay = 0 | ||
end | end | ||
+ | end</nowiki> | ||
− | |||
− | + | '''Example 3:''' Same example as above, but used with functions (for easy re-using) | |
+ | |||
+ | <nowiki>Sound0 = getObject("Sound0") | ||
+ | soundplay = 0 | ||
+ | |||
+ | function playmysound() | ||
+ | if soundplay == 0 then playSound(Sound0) end | ||
+ | soundplay = 1 | ||
+ | end | ||
+ | |||
+ | function stopmysound() | ||
soundplay = 0 | soundplay = 0 | ||
− | + | end | |
− | + | ||
− | + | function onSceneUpdate() | |
− | + | if isKeyPressed("SPACE") then | |
− | + | playmysound() | |
− | + | else | |
− | + | stopmysound() | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
end | end | ||
+ | end</nowiki> | ||
+ | |||
+ | [[Category:Lua scripting]] | ||
+ | [[Category:Lua function]] | ||
+ | [[Category:Sound]] |
Latest revision as of 17:00, 15 February 2014
playSound(object)
Play a sound.
-
object
: object to operate on
- The Loop option will play and loop the sound even if there's no script applied to it.
- If the Relative option is checked, the sound will play on 'global' mode (won't be affected by position)
Example 1 : Play a sound on key press. will work fine only with onKeyDown. if you try with isKeyPressed, sound will be played 1 time every frames, so you must use example 2 or 3 method instead.
Sound0 = getObject("Sound0") function onSceneUpdate() if onKeyDown("SPACE") then playSound(Sound0) end end
Example 2: Play a sound on key press. the sound will stop playing after 1 time
Sound0 = getObject("Sound0") soundplay = 0 function onSceneUpdate() if isKeyPressed("SPACE") then if soundplay == 0 then playSound(Sound0) end soundplay = 1 else soundplay = 0 end end
Example 3: Same example as above, but used with functions (for easy re-using)
Sound0 = getObject("Sound0") soundplay = 0 function playmysound() if soundplay == 0 then playSound(Sound0) end soundplay = 1 end function stopmysound() soundplay = 0 end function onSceneUpdate() if isKeyPressed("SPACE") then playmysound() else stopmysound() end end