From b4e53e83c98be7c8f4a81f93c7ddc18e9766042e Mon Sep 17 00:00:00 2001 From: AvarianKnight Date: Fri, 16 Feb 2024 09:37:53 -0600 Subject: [PATCH] feat(audio): batch 7 of native updates --- AUDIO/IsAnySpeechPlaying.md | 3 ++- AUDIO/IsAudioSceneActive.md | 3 ++- AUDIO/IsHornActive.md | 7 ++----- AUDIO/IsMissionCompletePlaying.md | 2 +- AUDIO/IsMissionCompleteReadyForUi.md | 2 +- AUDIO/IsMissionNewsStoryUnlocked.md | 3 ++- AUDIO/IsMobileInterferenceActive.md | 13 +++++++++++++ AUDIO/IsMobilePhoneCallOngoing.md | 2 +- AUDIO/IsMobilePhoneRadioActive.md | 1 + AUDIO/IsMusicOneshotPlaying.md | 1 + AUDIO/IsPedInCurrentConversation.md | 3 ++- AUDIO/IsPedRingtonePlaying.md | 3 ++- AUDIO/IsRadioFadedOut.md | 2 +- AUDIO/IsRadioRetuning.md | 1 + AUDIO/N_0xc8b1b2425604cdd0.md | 15 --------------- 15 files changed, 32 insertions(+), 29 deletions(-) create mode 100644 AUDIO/IsMobileInterferenceActive.md delete mode 100644 AUDIO/N_0xc8b1b2425604cdd0.md diff --git a/AUDIO/IsAnySpeechPlaying.md b/AUDIO/IsAnySpeechPlaying.md index 54e61a078..85445c3c6 100644 --- a/AUDIO/IsAnySpeechPlaying.md +++ b/AUDIO/IsAnySpeechPlaying.md @@ -10,6 +10,7 @@ BOOL IS_ANY_SPEECH_PLAYING(Ped ped); ## Parameters -* **ped**: +* **ped**: ## Return value +Returns true if the specified ped is playing any speech diff --git a/AUDIO/IsAudioSceneActive.md b/AUDIO/IsAudioSceneActive.md index 316bcc0da..a4868be14 100644 --- a/AUDIO/IsAudioSceneActive.md +++ b/AUDIO/IsAudioSceneActive.md @@ -10,6 +10,7 @@ BOOL IS_AUDIO_SCENE_ACTIVE(char* scene); ## Parameters -* **scene**: +* **scene**: the name of the scene ## Return value +Returns true if the script is already running the named scene, false otherwise diff --git a/AUDIO/IsHornActive.md b/AUDIO/IsHornActive.md index 9a3285dd7..753f9cd50 100644 --- a/AUDIO/IsHornActive.md +++ b/AUDIO/IsHornActive.md @@ -8,11 +8,8 @@ ns: AUDIO BOOL IS_HORN_ACTIVE(Vehicle vehicle); ``` -``` -Checks whether the horn of a vehicle is currently played. -``` - ## Parameters -* **vehicle**: +* **vehicle**: ## Return value +Returns true if the vehicle is currently playing a horn sound diff --git a/AUDIO/IsMissionCompletePlaying.md b/AUDIO/IsMissionCompletePlaying.md index 48ac84fc8..909983eef 100644 --- a/AUDIO/IsMissionCompletePlaying.md +++ b/AUDIO/IsMissionCompletePlaying.md @@ -8,5 +8,5 @@ ns: AUDIO BOOL IS_MISSION_COMPLETE_PLAYING(); ``` - ## Return value +Returns true if the mission complete audio is playing diff --git a/AUDIO/IsMissionCompleteReadyForUi.md b/AUDIO/IsMissionCompleteReadyForUi.md index df23d53f0..a66b81401 100644 --- a/AUDIO/IsMissionCompleteReadyForUi.md +++ b/AUDIO/IsMissionCompleteReadyForUi.md @@ -9,5 +9,5 @@ aliases: ["0x6F259F82D873B8B8"] BOOL IS_MISSION_COMPLETE_READY_FOR_UI(); ``` - ## Return value +Returns true if the script should draw the mission complete UI to be in sync with audio. diff --git a/AUDIO/IsMissionNewsStoryUnlocked.md b/AUDIO/IsMissionNewsStoryUnlocked.md index f0c5e5709..7adfb3e3f 100644 --- a/AUDIO/IsMissionNewsStoryUnlocked.md +++ b/AUDIO/IsMissionNewsStoryUnlocked.md @@ -10,6 +10,7 @@ cs_type(int) BOOL IS_MISSION_NEWS_STORY_UNLOCKED(int newsStory); ``` ## Parameters -* **newsStory**: +* **newsStory**: ## Return value +Returns true of the specific story is available to be played back diff --git a/AUDIO/IsMobileInterferenceActive.md b/AUDIO/IsMobileInterferenceActive.md new file mode 100644 index 000000000..d99588ca2 --- /dev/null +++ b/AUDIO/IsMobileInterferenceActive.md @@ -0,0 +1,13 @@ +--- +ns: AUDIO +aliases: ["0xC8B1B2425604CDD0"] +--- +## IS_MOBILE_INTERFERENCE_ACTIVE + +```c +// 0xC8B1B2425604CDD0 0x16FB88B5 +BOOL IS_MOBILE_INTERFERENCE_ACTIVE(); +``` + +## Return value +Returns true of mobile phone interference is currently happening diff --git a/AUDIO/IsMobilePhoneCallOngoing.md b/AUDIO/IsMobilePhoneCallOngoing.md index af449b611..5b60abff8 100644 --- a/AUDIO/IsMobilePhoneCallOngoing.md +++ b/AUDIO/IsMobilePhoneCallOngoing.md @@ -8,5 +8,5 @@ ns: AUDIO BOOL IS_MOBILE_PHONE_CALL_ONGOING(); ``` - ## Return value +Returns true of a mobile phone call is currently happening. diff --git a/AUDIO/IsMobilePhoneRadioActive.md b/AUDIO/IsMobilePhoneRadioActive.md index a3ce3c787..70f02b2c4 100644 --- a/AUDIO/IsMobilePhoneRadioActive.md +++ b/AUDIO/IsMobilePhoneRadioActive.md @@ -10,3 +10,4 @@ BOOL IS_MOBILE_PHONE_RADIO_ACTIVE(); ## Return value +Returns true if the mobile phone radio is active diff --git a/AUDIO/IsMusicOneshotPlaying.md b/AUDIO/IsMusicOneshotPlaying.md index b23b94356..6be0fe4d8 100644 --- a/AUDIO/IsMusicOneshotPlaying.md +++ b/AUDIO/IsMusicOneshotPlaying.md @@ -11,3 +11,4 @@ BOOL IS_MUSIC_ONESHOT_PLAYING(); ## Return value +Returns true if a one shot is currently playing or prepared diff --git a/AUDIO/IsPedInCurrentConversation.md b/AUDIO/IsPedInCurrentConversation.md index 8da71d1e2..61ffd887d 100644 --- a/AUDIO/IsPedInCurrentConversation.md +++ b/AUDIO/IsPedInCurrentConversation.md @@ -10,6 +10,7 @@ BOOL IS_PED_IN_CURRENT_CONVERSATION(Ped ped); ## Parameters -* **ped**: +* **ped**: ## Return value +Returns true if the ped is in the currently playing conversation diff --git a/AUDIO/IsPedRingtonePlaying.md b/AUDIO/IsPedRingtonePlaying.md index 506b92abf..3eb25ccec 100644 --- a/AUDIO/IsPedRingtonePlaying.md +++ b/AUDIO/IsPedRingtonePlaying.md @@ -10,6 +10,7 @@ BOOL IS_PED_RINGTONE_PLAYING(Ped ped); ## Parameters -* **ped**: +* **ped**: ## Return value +Returns true if the peds ringtone is currently playing diff --git a/AUDIO/IsRadioFadedOut.md b/AUDIO/IsRadioFadedOut.md index c147f799c..eb5473f22 100644 --- a/AUDIO/IsRadioFadedOut.md +++ b/AUDIO/IsRadioFadedOut.md @@ -9,5 +9,5 @@ aliases: ["0x0626A247D2405330"] BOOL IS_RADIO_FADED_OUT(); ``` - ## Return value +Returns true if the radio is currently faded out diff --git a/AUDIO/IsRadioRetuning.md b/AUDIO/IsRadioRetuning.md index d1ef36aab..3c84f81d7 100644 --- a/AUDIO/IsRadioRetuning.md +++ b/AUDIO/IsRadioRetuning.md @@ -10,3 +10,4 @@ BOOL IS_RADIO_RETUNING(); ## Return value +Returns true if the radio is tuning to a station diff --git a/AUDIO/N_0xc8b1b2425604cdd0.md b/AUDIO/N_0xc8b1b2425604cdd0.md deleted file mode 100644 index f8a5ee94c..000000000 --- a/AUDIO/N_0xc8b1b2425604cdd0.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: AUDIO ---- -## _0xC8B1B2425604CDD0 - -```c -// 0xC8B1B2425604CDD0 0x16FB88B5 -BOOL _0xC8B1B2425604CDD0(); -``` - -``` -IS_MOBILE_PHONE_* -``` - -## Return value