Skip to content

Commit 0bbf46c

Browse files
committed
Simba/Documentation: Add *Sound documentation.
1 parent b1d8a01 commit 0bbf46c

File tree

4 files changed

+45
-0
lines changed

4 files changed

+45
-0
lines changed

Doc/sphinx/referencescript.rst

+1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@ default (Pascal) engine.
2121
scriptref/bitmaps.rst
2222
scriptref/string.rst
2323
scriptref/tpa.rst
24+
scriptref/sound.rst
2425

Doc/sphinx/scriptref/sound.rst

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
.. _scriptref_web:
3+
4+
Multimedia Functions
5+
====================
6+
7+
8+
Sound Functions
9+
--------------
10+
11+
PlaySound
12+
~~~~~~~~~
13+
14+
.. code-block:: pascal
15+
16+
procedure PlaySound(Sound : string);
17+
18+
PlaySound plays the sound file with the path *Sound*.
19+
20+
Supported formats: *.wav*. (Possibly others, if someone has time to figures
21+
this out please let us know)
22+
23+
Example:
24+
25+
.. code-block:: pascal
26+
27+
PlaySound('C:\roar.wav');
28+
29+
30+
StopSound
31+
~~~~~~~~~
32+
33+
34+
.. code-block:: pascal
35+
36+
procedure StopSound;
37+
38+
StopSound stops all currently playing sounds.

TODO.linux

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

TODO.windows

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
TODO:
2+
-

0 commit comments

Comments
 (0)