diff --git a/AUDIO/GetVariationChosenForScriptedLine.md b/AUDIO/GetVariationChosenForScriptedLine.md new file mode 100644 index 000000000..be81ee751 --- /dev/null +++ b/AUDIO/GetVariationChosenForScriptedLine.md @@ -0,0 +1,19 @@ +--- +ns: AUDIO +aliases: ["0xAA19F5572C38B564"] +--- +## GET_VARIATION_CHOSEN_FOR_SCRIPTED_LINE + +```c +// 0xAA19F5572C38B564 0xB58B8FF3 +int GET_VARIATION_CHOSEN_FOR_SCRIPTED_LINE(cs_type(AnyPtr) char* textLabel); +``` + +## Parameters +* **textLabel**: all the text labels for filenames in `AmericanDialogueFiles.txt` appear to end with the letter 'A', it is the script's responsibility to add this 'A' before calling `GET_VARIATION_CHOSEN_FOR_SCRIPTED_LINE`. + +## Return value +Returns the variation chosen for a given script speech line, or `0` if it hasn't been chosen yet. + +Returns `-1` if there is no conversation active or if the active conversation doesn't contain this line or if the text label can't be found in the currently loaded text blocks + diff --git a/AUDIO/GetVehicleDefaultHorn.md b/AUDIO/GetVehicleDefaultHorn.md index 001c36bec..eb028ecdc 100644 --- a/AUDIO/GetVehicleDefaultHorn.md +++ b/AUDIO/GetVehicleDefaultHorn.md @@ -8,12 +8,9 @@ ns: AUDIO Hash GET_VEHICLE_DEFAULT_HORN(Vehicle vehicle); ``` -``` -Returns hash of default vehicle horn -Hash is stored in audVehicleAudioEntity -``` ## Parameters -* **vehicle**: +* **vehicle**: ## Return value +Returns the horn sound hash diff --git a/AUDIO/GetVehicleDefaultHornIgnoreMods.md b/AUDIO/GetVehicleDefaultHornIgnoreMods.md index 122debf55..13e2e1aeb 100644 --- a/AUDIO/GetVehicleDefaultHornIgnoreMods.md +++ b/AUDIO/GetVehicleDefaultHornIgnoreMods.md @@ -10,6 +10,7 @@ Hash GET_VEHICLE_DEFAULT_HORN_IGNORE_MODS(Vehicle vehicle); ``` ## Parameters -* **vehicle**: +* **vehicle**: ## Return value +Returns the horn sound hash ignoring any horn mods applied to the car diff --git a/AUDIO/GetVehicleDefaultHornVariation.md b/AUDIO/GetVehicleDefaultHornVariation.md deleted file mode 100644 index 0b85c78e3..000000000 --- a/AUDIO/GetVehicleDefaultHornVariation.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -ns: AUDIO -aliases: ["0xD53F3A29BCE2580E","0x22FECB546C276A30"] ---- -## _GET_VEHICLE_DEFAULT_HORN_VARIATION - -```c -// 0xD53F3A29BCE2580E -int _GET_VEHICLE_DEFAULT_HORN_VARIATION(Vehicle vehicle); -``` - -``` -NativeDB Introduced: v1365 -``` - -## Parameters -* **vehicle**: diff --git a/AUDIO/GetVehicleHornSoundIndex.md b/AUDIO/GetVehicleHornSoundIndex.md new file mode 100644 index 000000000..f36aa4c7d --- /dev/null +++ b/AUDIO/GetVehicleHornSoundIndex.md @@ -0,0 +1,20 @@ +--- +ns: AUDIO +aliases: ["0xD53F3A29BCE2580E","0x22FECB546C276A30", "_GET_VEHICLE_DEFAULT_HORN_VARIATION"] +--- +## GET_VEHICLE_HORN_SOUND_INDEX + +```c +// 0xD53F3A29BCE2580E +int GET_VEHICLE_HORN_SOUND_INDEX(Vehicle vehicle); +``` + +``` +NativeDB Introduced: v1365 +``` + +## Parameters +* **vehicle**: + +## Return value +The current horn sound index being used by the given vehicle diff --git a/AUDIO/HasLoadedMpDataSet.md b/AUDIO/HasLoadedMpDataSet.md new file mode 100644 index 000000000..fb6bddf36 --- /dev/null +++ b/AUDIO/HasLoadedMpDataSet.md @@ -0,0 +1,13 @@ +--- +ns: AUDIO +aliases: ["0x544810ED9DB6BBE6", "_HAS_MULTIPLAYER_AUDIO_DATA_LOADED"] +--- +## HAS_LOADED_MP_DATA_SET + +```c +// 0x544810ED9DB6BBE6 +BOOL HAS_LOADED_MP_DATA_SET(); +``` + +## Return value +Returns true if the audio for the Multiplayer data set has loaded diff --git a/AUDIO/HasLoadedSpDataSet.md b/AUDIO/HasLoadedSpDataSet.md new file mode 100644 index 000000000..41d8f19d1 --- /dev/null +++ b/AUDIO/HasLoadedSpDataSet.md @@ -0,0 +1,14 @@ +--- +ns: AUDIO +aliases: ["0x5B50ABB1FE3746F4", "_HAS_MULTIPLAYER_AUDIO_DATA_UNLOADED"] +--- +## HAS_LOADED_SP_DATA_SET + +```c +// 0x5B50ABB1FE3746F4 +BOOL HAS_LOADED_SP_DATA_SET(); +``` + + +## Return value +Returns true if the audio for the Single Player data set has loaded diff --git a/AUDIO/HasMultiplayerAudioDataLoaded.md b/AUDIO/HasMultiplayerAudioDataLoaded.md deleted file mode 100644 index 3103ac8a6..000000000 --- a/AUDIO/HasMultiplayerAudioDataLoaded.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -ns: AUDIO -aliases: ["0x544810ED9DB6BBE6"] ---- -## _HAS_MULTIPLAYER_AUDIO_DATA_LOADED - -```c -// 0x544810ED9DB6BBE6 -BOOL _HAS_MULTIPLAYER_AUDIO_DATA_LOADED(); -``` - -``` -HAS_* -``` - -## Return value diff --git a/AUDIO/HasMultiplayerAudioDataUnloaded.md b/AUDIO/HasMultiplayerAudioDataUnloaded.md deleted file mode 100644 index 1e9e5aafc..000000000 --- a/AUDIO/HasMultiplayerAudioDataUnloaded.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -ns: AUDIO -aliases: ["0x5B50ABB1FE3746F4"] ---- -## _HAS_MULTIPLAYER_AUDIO_DATA_UNLOADED - -```c -// 0x5B50ABB1FE3746F4 -BOOL _HAS_MULTIPLAYER_AUDIO_DATA_UNLOADED(); -``` - -``` -HAS_* -``` - -## Return value diff --git a/AUDIO/HasSoundFinished.md b/AUDIO/HasSoundFinished.md index 8bad4efa6..33cbbb759 100644 --- a/AUDIO/HasSoundFinished.md +++ b/AUDIO/HasSoundFinished.md @@ -10,6 +10,7 @@ BOOL HAS_SOUND_FINISHED(int soundId); ## Parameters -* **soundId**: +* **soundId**: ## Return value +Returns true if the sound has finished playing, false otherwise. diff --git a/AUDIO/HintAmbientAudioBank.md b/AUDIO/HintAmbientAudioBank.md index e0cdfcbad..18a56cdd4 100644 --- a/AUDIO/HintAmbientAudioBank.md +++ b/AUDIO/HintAmbientAudioBank.md @@ -5,15 +5,13 @@ ns: AUDIO ```c // 0x8F8C0E370AE62F5C 0xF1850DDC -Any HINT_AMBIENT_AUDIO_BANK(Any p0, Any p1); +cs_type(Any) BOOL HINT_AMBIENT_AUDIO_BANK(cs_type(Any) char* bankName, cs_type(Any) BOOL bOverNetwork); ``` -``` -NativeDB Added Parameter 3: Any p2 -``` +This native is marked as a deprecated native internally, use [HINT_SCRIPT_AUDIO_BANK](#_0xFB380A29641EC31A) instead ## Parameters -* **p0**: -* **p1**: +* **bankName**: +* **bOverNetwork**: ## Return value diff --git a/AUDIO/HintMissionAudioBank.md b/AUDIO/HintMissionAudioBank.md new file mode 100644 index 000000000..79a7274d3 --- /dev/null +++ b/AUDIO/HintMissionAudioBank.md @@ -0,0 +1,19 @@ +--- +ns: AUDIO +aliases: ["0x40763EA7B9B783E7"] +--- +## HINT_MISSION_AUDIO_BANK + +```c +// 0x40763EA7B9B783E7 +cs_type(Any) BOOL HINT_MISSION_AUDIO_BANK(char* bankName, cs_type(int) BOOL bOverNetwork, int playerBits); +``` + +This is marked as a deprecated function internally, please use [HINT_SCRIPT_AUDIO_BANK](#_0xFB380A29641EC31A) instead. + +## Parameters +* **bankName**: +* **bOverNetwork**: +* **playerBits**: + +## Return value diff --git a/AUDIO/HintScriptAudioBank.md b/AUDIO/HintScriptAudioBank.md index b3a6b7c9f..b772cc383 100644 --- a/AUDIO/HintScriptAudioBank.md +++ b/AUDIO/HintScriptAudioBank.md @@ -5,15 +5,17 @@ ns: AUDIO ```c // 0xFB380A29641EC31A 0x41FA0E51 -Any HINT_SCRIPT_AUDIO_BANK(Any p0, int p1); +cs_type(Any) BOOL HINT_SCRIPT_AUDIO_BANK(cs_type(Any) char* bankName, cs_type(int) BOOL bOverNetwork); ``` -``` -NativeDB Added Parameter 3: Any p2 -``` +Hints that this bank would be good to load if there are free slots. +Does not guarentee loading of the bank, [REQUEST_SCRIPT_AUDIO_BANK](#_0xFE02FFBED8CA9D99) MUST be used as normal before triggering sounds" + +This native has a new argument on newer game builds: +* **playerBits**: likely used to specifiy players to sync to as a bit mask (1 << (0-128)) ## Parameters -* **p0**: -* **p1**: +* **bankName**: +* **bOverNetwork**: ## Return value diff --git a/AUDIO/N_0x40763ea7b9b783e7.md b/AUDIO/N_0x40763ea7b9b783e7.md deleted file mode 100644 index ab10c9cee..000000000 --- a/AUDIO/N_0x40763ea7b9b783e7.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -ns: AUDIO ---- -## _0x40763EA7B9B783E7 - -```c -// 0x40763EA7B9B783E7 -Any _0x40763EA7B9B783E7(char* p0, int p1, int p2); -``` - - -## Parameters -* **p0**: -* **p1**: -* **p2**: - -## Return value diff --git a/AUDIO/N_0xaa19f5572c38b564.md b/AUDIO/N_0xaa19f5572c38b564.md deleted file mode 100644 index 61f642b71..000000000 --- a/AUDIO/N_0xaa19f5572c38b564.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: AUDIO ---- -## _0xAA19F5572C38B564 - -```c -// 0xAA19F5572C38B564 0xB58B8FF3 -Any _0xAA19F5572C38B564(Any* p0); -``` - - -## Parameters -* **p0**: - -## Return value