aboutsummaryrefslogtreecommitdiff
path: root/src/doc/feature/sfx.dox
blob: 2a5c9cc9b7605b8d36e5997ae2f2a523d709564e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// vim:ft=doxygen
namespace crepe {
/**

\defgroup feature_sfx Playing sound effects
\ingroup feature
\brief Fire a sound effect using the AudioSource component

This page shows how to implement one-shot sound effects using the AudioSource
component's 'fire and forget'-style API.

\see AudioSource

\par Example

\note This example assumes you already have a GameObject to attach the
AudioSource component to, and uses a Script to control the AudioSource instance.
Separate pages describing these features in more detail can be found at \"\ref
feature_gameobject\" and \"\ref feature_script\" respectively.

\todo Merge #60

*/
}