PlaySound

(Difference between revisions)
Jump to: navigation, search
m
Line 3: Line 3:
 
Play a sound.
 
Play a sound.
  
{{lua-function-param|object|object to operaqte on}}
+
{{lua-function-param|object|object to operate on}}
  
 
'''Note:''' If you enable "loop" in the sound object proprieties, the sound will play even if there's no script applied to it.
 
'''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):''' This is probably what you will try. But this won't work as expected because the sound will  
+
 
reinitialize all the time while you press SPACE.
+
'''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")
 
     Sound0 = getObject("Sound0")
 
     function onSceneUpdate()
 
     function onSceneUpdate()
         if isKeyPressed("SPACE") then playSound(Sound0) end  
+
         if onKeyDown("SPACE") then playSound(Sound0) end  
 
     end
 
     end
 +
  
 
'''Example 2:''' Play a sound on key press. the sound will stop playing after 1 time
 
'''Example 2:''' Play a sound on key press. the sound will stop playing after 1 time
Line 27: Line 29:
 
         end
 
         end
 
     end
 
     end
 +
  
 
'''Example 3:''' Same example as above, but used with functions (for easy re-using)
 
'''Example 3:''' Same example as above, but used with functions (for easy re-using)

Revision as of 13:08, 11 February 2014

playSound(object)

Play a sound.

  • object : object to operate on

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 : 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
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox