summaryrefslogtreecommitdiff
path: root/src/code/z_lib.c
diff options
context:
space:
mode:
authorengineer124 <47598039+engineer124@users.noreply.github.com>2023-08-15 15:44:20 +1000
committerGitHub <noreply@github.com>2023-08-15 01:44:20 -0400
commitb8aa2a251e38c4ca31d2e0ab5042a8ea84fd4be5 (patch)
treede84ab742daf5200d0f47d7c0f2078b16a30e96c /src/code/z_lib.c
parent18d609c1a3006c242d10b12e6937f467c2a1f1eb (diff)
Document z_lib Sfx Functions (#1470)
* document lib sfx * rename functions
Diffstat (limited to 'src/code/z_lib.c')
-rw-r--r--src/code/z_lib.c18
1 files changed, 14 insertions, 4 deletions
diff --git a/src/code/z_lib.c b/src/code/z_lib.c
index ac5220ab0..2e00bcd59 100644
--- a/src/code/z_lib.c
+++ b/src/code/z_lib.c
@@ -590,16 +590,26 @@ void Color_RGBA8_Copy(Color_RGBA8* dst, Color_RGBA8* src) {
dst->a = src->a;
}
-void func_80078884(u16 sfxId) {
+/**
+ * Play a sound effect at the center of the screen.
+ */
+void Sfx_PlaySfxCentered(u16 sfxId) {
Audio_PlaySfxGeneral(sfxId, &gSfxDefaultPos, 4, &gSfxDefaultFreqAndVolScale, &gSfxDefaultFreqAndVolScale,
&gSfxDefaultReverb);
}
-void func_800788CC(u16 sfxId) {
+/**
+ * Play a sound effect at the center of the screen. Identical to `Sfx_PlaySfxCentered`.
+ */
+void Sfx_PlaySfxCentered2(u16 sfxId) {
Audio_PlaySfxGeneral(sfxId, &gSfxDefaultPos, 4, &gSfxDefaultFreqAndVolScale, &gSfxDefaultFreqAndVolScale,
&gSfxDefaultReverb);
}
-void func_80078914(Vec3f* arg0, u16 sfxId) {
- Audio_PlaySfxGeneral(sfxId, arg0, 4, &gSfxDefaultFreqAndVolScale, &gSfxDefaultFreqAndVolScale, &gSfxDefaultReverb);
+/**
+ * Play a sound effect at the requested position.
+ */
+void Sfx_PlaySfxAtPos(Vec3f* projectedPos, u16 sfxId) {
+ Audio_PlaySfxGeneral(sfxId, projectedPos, 4, &gSfxDefaultFreqAndVolScale, &gSfxDefaultFreqAndVolScale,
+ &gSfxDefaultReverb);
}