mirror of
https://github.com/moparisthebest/Simba
synced 2024-12-22 07:18:51 -05:00
Simba/Documentation: Add *Sound documentation.
This commit is contained in:
parent
b1d8a010ad
commit
0bbf46c67d
@ -21,4 +21,5 @@ default (Pascal) engine.
|
||||
scriptref/bitmaps.rst
|
||||
scriptref/string.rst
|
||||
scriptref/tpa.rst
|
||||
scriptref/sound.rst
|
||||
|
||||
|
38
Doc/sphinx/scriptref/sound.rst
Normal file
38
Doc/sphinx/scriptref/sound.rst
Normal 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
4
TODO.linux
Normal 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
2
TODO.windows
Normal file
@ -0,0 +1,2 @@
|
||||
TODO:
|
||||
-
|
Loading…
Reference in New Issue
Block a user