Simba/Documentation: Add *Sound documentation.

This commit is contained in:
Merlijn Wajer 2011-05-29 12:57:59 +02:00
parent b1d8a010ad
commit 0bbf46c67d
4 changed files with 45 additions and 0 deletions

View File

@ -21,4 +21,5 @@ default (Pascal) engine.
scriptref/bitmaps.rst
scriptref/string.rst
scriptref/tpa.rst
scriptref/sound.rst

View File

@ -0,0 +1,38 @@
.. _scriptref_web:
Multimedia Functions
====================
Sound Functions
--------------
PlaySound
~~~~~~~~~
.. code-block:: pascal
procedure PlaySound(Sound : string);
PlaySound plays the sound file with the path *Sound*.
Supported formats: *.wav*. (Possibly others, if someone has time to figures
this out please let us know)
Example:
.. code-block:: pascal
PlaySound('C:\roar.wav');
StopSound
~~~~~~~~~
.. code-block:: pascal
procedure StopSound;
StopSound stops all currently playing sounds.

4
TODO.linux Normal file
View File

@ -0,0 +1,4 @@
TODO:
- Implement IsKeyDown properly.
- Implement KeyDown / KeyUp to work with multiple keyboard layouts.
Perhaps XTest already does this?

2
TODO.windows Normal file
View File

@ -0,0 +1,2 @@
TODO:
-