feat(audio): batch 12 of native updates (#1008)

* feat(audio): batch 12 of native updates * Update ReleaseWeaponAudio.md Re-add old nativedb introduced comment. --------- Co-authored-by: ammonia-cfx <[email protected]>
citizenfx · Feb 20, 2024 · 0a2e2fe · 0a2e2fe
1 parent 535599d
commit 0a2e2fe
Show file tree

Hide file tree

Showing 10 changed files with 30 additions and 25 deletions.
diff --git a/AUDIO/N_0x5d2bfaab8d956e0e.md b/AUDIO/N_0x5d2bfaab8d956e0e.md
diff --git a/AUDIO/PrepareSynchronizedAudioEventForScene.md b/AUDIO/PrepareSynchronizedAudioEventForScene.md
@@ -5,12 +5,13 @@ ns: AUDIO
 
 ```c
 // 0x029FE7CD1B7E2E75 0x7652DD49
-BOOL PREPARE_SYNCHRONIZED_AUDIO_EVENT_FOR_SCENE(Any p0, Any* p1);
+BOOL PREPARE_SYNCHRONIZED_AUDIO_EVENT_FOR_SCENE(int sceneId, cs_type(AnyPtr) char* audioEvent);
 ```
 
 
 ## Parameters
-* **p0**: 
-* **p1**: 
+* **sceneId**:
+* **audioEvent**:
 
 ## Return value
+Returns true if prepared, false otherwise
diff --git a/AUDIO/RecordBrokenGlass.md b/AUDIO/RecordBrokenGlass.md
@@ -9,10 +9,11 @@ aliases: ["0xFBE20329593DEC9D"]
 void RECORD_BROKEN_GLASS(float x, float y, float z, float radius);
 ```
 
+Creates a broken glass area
 
 ## Parameters
-* **x**: 
-* **y**: 
-* **z**: 
-* **radius**: 
+* **x**:
+* **y**:
+* **z**:
+* **radius**:
 
diff --git a/AUDIO/RefreshClosestOceanShoreline.md b/AUDIO/RefreshClosestOceanShoreline.md
@@ -0,0 +1,12 @@
+---
+ns: AUDIO
+aliases: ["0x5D2BFAAB8D956E0E"]
+---
+## REFRESH_CLOSEST_OCEAN_SHORELINE
+
+```c
+// 0x5D2BFAAB8D956E0E
+void REFRESH_CLOSEST_OCEAN_SHORELINE();
+```
+
+Refreshes the closest shoreline using the nearest road position.
diff --git a/AUDIO/RegisterScriptWithAudio.md b/AUDIO/RegisterScriptWithAudio.md
@@ -5,11 +5,11 @@ ns: AUDIO
 
 ```c
 // 0xC6ED9D5092438D91 0xA6203643
-void REGISTER_SCRIPT_WITH_AUDIO(int p0);
+void REGISTER_SCRIPT_WITH_AUDIO(cs_type(int) BOOL inChargeOfAudio);
 ```
 
 **This native does absolutely nothing, just a nullsub**
 
 ## Parameters
-* **p0**: 
+* **inChargeOfAudio**:
 
diff --git a/AUDIO/ReleaseAmbientAudioBank.md b/AUDIO/ReleaseAmbientAudioBank.md
@@ -8,4 +8,4 @@ ns: AUDIO
 void RELEASE_AMBIENT_AUDIO_BANK();
 ```
 
-
+This native has been marked as deprecated internally, please use [RELEASE_SCRIPT_AUDIO_BANK](#_0x7A2D8AD0A9EB9C3F) instead.
diff --git a/AUDIO/ReleaseMissionAudioBank.md b/AUDIO/ReleaseMissionAudioBank.md
@@ -8,4 +8,4 @@ ns: AUDIO
 void RELEASE_MISSION_AUDIO_BANK();
 ```
 
-
+This native has been marked as deprecated internally, please use [RELEASE_SCRIPT_AUDIO_BANK](#_0x7A2D8AD0A9EB9C3F) instead.
diff --git a/AUDIO/ReleaseNamedScriptAudioBank.md b/AUDIO/ReleaseNamedScriptAudioBank.md
@@ -8,7 +8,8 @@ ns: AUDIO
 void RELEASE_NAMED_SCRIPT_AUDIO_BANK(char* audioBank);
 ```
 
+Unloads the specified audioBank
 
 ## Parameters
-* **audioBank**: 
+* **audioBank**:
 
diff --git a/AUDIO/ReleaseScriptAudioBank.md b/AUDIO/ReleaseScriptAudioBank.md
@@ -8,4 +8,4 @@ ns: AUDIO
 void RELEASE_SCRIPT_AUDIO_BANK();
 ```
 
-
+Unloads all audio banks requested by this script.
diff --git a/AUDIO/ReleaseSoundId.md b/AUDIO/ReleaseSoundId.md
@@ -8,7 +8,8 @@ ns: AUDIO
 void RELEASE_SOUND_ID(int soundId);
 ```
 
+This should be called once a sound has finished being manipulated by the script so that its SoundId can be released and re-used.
 
 ## Parameters
-* **soundId**: 
+* **soundId**:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ ns: AUDIO
		void RELEASE_AMBIENT_AUDIO_BANK();
		```


		This native has been marked as deprecated internally, please use [RELEASE_SCRIPT_AUDIO_BANK](#_0x7A2D8AD0A9EB9C3F) instead.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ ns: AUDIO
		void RELEASE_MISSION_AUDIO_BANK();
		```


		This native has been marked as deprecated internally, please use [RELEASE_SCRIPT_AUDIO_BANK](#_0x7A2D8AD0A9EB9C3F) instead.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ ns: AUDIO
		void RELEASE_SCRIPT_AUDIO_BANK();
		```


		Unloads all audio banks requested by this script.