diff --git a/AUDIO/InitSynchSceneAudioWithEntity.md b/AUDIO/InitSynchSceneAudioWithEntity.md new file mode 100644 index 000000000..8899e1593 --- /dev/null +++ b/AUDIO/InitSynchSceneAudioWithEntity.md @@ -0,0 +1,16 @@ +--- +ns: AUDIO +aliases: ["0x950A154B8DAB6185", "_SET_SYNCHRONIZED_AUDIO_EVENT_POSITION_THIS_FRAME"] +--- +## INIT_SYNCH_SCENE_AUDIO_WITH_ENTITY + +```c +// 0x950A154B8DAB6185 0xA17F9AB0 +void INIT_SYNCH_SCENE_AUDIO_WITH_ENTITY(char* audioName, Entity entity); +``` + + +## Parameters +* **audioName**: +* **entity**: + diff --git a/AUDIO/InitSynchSceneAudioWithPosition.md b/AUDIO/InitSynchSceneAudioWithPosition.md new file mode 100644 index 000000000..da5bcc48e --- /dev/null +++ b/AUDIO/InitSynchSceneAudioWithPosition.md @@ -0,0 +1,18 @@ +--- +ns: AUDIO +aliases: ["0xC8EDE9BDBCCBA6D4"] +--- +## INIT_SYNCH_SCENE_AUDIO_WITH_POSITION + +```c +// 0xC8EDE9BDBCCBA6D4 0x55A21772 +void INIT_SYNCH_SCENE_AUDIO_WITH_POSITION(cs_type(AnyPtr) char* audioName, float x, float y, float z); +``` + + +## Parameters +* **audioName**: +* **x**: +* **y**: +* **z**: + diff --git a/AUDIO/InterruptConversation.md b/AUDIO/InterruptConversation.md index fdb36b923..5cba67288 100644 --- a/AUDIO/InterruptConversation.md +++ b/AUDIO/InterruptConversation.md @@ -5,12 +5,13 @@ ns: AUDIO ```c // 0xA018A12E5C5C2FA6 0xF3A67AF3 -void INTERRUPT_CONVERSATION(Any p0, Any* p1, Any* p2); +void INTERRUPT_CONVERSATION(Ped interrupterPed, cs_type(AnyPtr) char* context, cs_type(AnyPtr) char* voiceName); ``` +Handles conversation interrupts, using the code-side system for improved timing and to minimize unfriendly logic interactions. ## Parameters -* **p0**: -* **p1**: -* **p2**: +* **interrupterPed**: the ped speaking +* **context**: the line to use +* **voiceName**: the voicename for the audio asset diff --git a/AUDIO/InterruptConversationAndPause.md b/AUDIO/InterruptConversationAndPause.md index 727b46dc9..7bc36e69c 100644 --- a/AUDIO/InterruptConversationAndPause.md +++ b/AUDIO/InterruptConversationAndPause.md @@ -6,16 +6,13 @@ aliases: ["0x8A694D7A68F8DC38"] ```c // 0x8A694D7A68F8DC38 0xDD4A3F1F -void INTERRUPT_CONVERSATION_AND_PAUSE(Ped ped, char* p1, char* p2); +void INTERRUPT_CONVERSATION_AND_PAUSE(Ped interrupterPed, char* context, char* voiceName); ``` -``` -One call found in the b617d scripts: -AUDIO::_8A694D7A68F8DC38(NETWORK::NET_TO_PED(l_3989._f26F[0/*1*/]), "CONV_INTERRUPT_QUIT_IT", "LESTER"); -``` +Handles conversation interrupts and pauses, using the code-side system for improved timing and to minimize unfriendly logic interactions. ## Parameters -* **ped**: -* **p1**: -* **p2**: +* **interrupterPed**: the ped speaking +* **context**: the line to use +* **voiceName**: the voicename for the audio asset diff --git a/AUDIO/IsAlarmPlaying.md b/AUDIO/IsAlarmPlaying.md index fcda82232..f0da07f01 100644 --- a/AUDIO/IsAlarmPlaying.md +++ b/AUDIO/IsAlarmPlaying.md @@ -8,12 +8,13 @@ ns: AUDIO BOOL IS_ALARM_PLAYING(char* alarmName); ``` -``` -Example: -bool playing = AUDIO::IS_ALARM_PLAYING("PORT_OF_LS_HEIST_FORT_ZANCUDO_ALARMS"); -``` - ## Parameters -* **alarmName**: +* **alarmName**: ## Return value +Returns true if an alarm is currently playing with the specified name + +## Examples +```lua +local bAlarmPlaying = IsAlarmPlaying("PORT_OF_LS_HEIST_FORT_ZANCUDO_ALARMS") +``` diff --git a/AUDIO/IsAmbientSpeechDisabled.md b/AUDIO/IsAmbientSpeechDisabled.md index 73ee3c773..79364055d 100644 --- a/AUDIO/IsAmbientSpeechDisabled.md +++ b/AUDIO/IsAmbientSpeechDisabled.md @@ -8,12 +8,8 @@ ns: AUDIO BOOL IS_AMBIENT_SPEECH_DISABLED(Ped ped); ``` -``` -Common in the scripts: -AUDIO::IS_AMBIENT_SPEECH_DISABLED(PLAYER::PLAYER_PED_ID()); -``` - ## Parameters -* **ped**: +* **ped**: ## Return value +Returns true if ambient speech for the ped has been disabled diff --git a/AUDIO/IsAmbientSpeechPlaying.md b/AUDIO/IsAmbientSpeechPlaying.md index c25068d7e..68c69e6d4 100644 --- a/AUDIO/IsAmbientSpeechPlaying.md +++ b/AUDIO/IsAmbientSpeechPlaying.md @@ -10,6 +10,7 @@ BOOL IS_AMBIENT_SPEECH_PLAYING(Ped ped); ## Parameters -* **ped**: +* **ped**: ## Return value +Returns true if the ped is currently playing ambient speech diff --git a/AUDIO/IsAmbientZoneEnabled.md b/AUDIO/IsAmbientZoneEnabled.md index 2040df7a2..6b52d021d 100644 --- a/AUDIO/IsAmbientZoneEnabled.md +++ b/AUDIO/IsAmbientZoneEnabled.md @@ -10,6 +10,7 @@ BOOL IS_AMBIENT_ZONE_ENABLED(char* ambientZone); ## Parameters -* **ambientZone**: +* **ambientZone**: ## Return value +Returns true if the given ambient zone is allowed to be active diff --git a/AUDIO/IsAnimalVocalizationPlaying.md b/AUDIO/IsAnimalVocalizationPlaying.md index 0241978d2..b64f4bb6e 100644 --- a/AUDIO/IsAnimalVocalizationPlaying.md +++ b/AUDIO/IsAnimalVocalizationPlaying.md @@ -10,6 +10,7 @@ BOOL IS_ANIMAL_VOCALIZATION_PLAYING(Ped pedHandle); ``` ## Parameters -* **pedHandle**: +* **pedHandle**: ## Return value +Returns true of the ped is currently playing animal sounds diff --git a/AUDIO/IsAnyPositionalSpeechPlaying.md b/AUDIO/IsAnyPositionalSpeechPlaying.md new file mode 100644 index 000000000..2867cd662 --- /dev/null +++ b/AUDIO/IsAnyPositionalSpeechPlaying.md @@ -0,0 +1,17 @@ +--- +ns: AUDIO +aliases: ["0x30CA2EF91D15ADF8"] +--- +## IS_ANY_POSITIONAL_SPEECH_PLAYING + +```c +// 0x30CA2EF91D15ADF8 +cs_type(Any) BOOL IS_ANY_POSITIONAL_SPEECH_PLAYING(); +``` + +``` +NativeDB Introduced: v2189 +``` + +## Return value +Returns true if any ped-independent positional scripted speech (ie. triggered using [PLAY_AMBIENT_SPEECH_FROM_POSITION_NATIVE](#_0xED640017ED337E45)) is currently playing diff --git a/AUDIO/N_0x30ca2ef91d15adf8.md b/AUDIO/N_0x30ca2ef91d15adf8.md deleted file mode 100644 index 97988a73e..000000000 --- a/AUDIO/N_0x30ca2ef91d15adf8.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -ns: AUDIO ---- -## _0x30CA2EF91D15ADF8 - -```c -// 0x30CA2EF91D15ADF8 -Any _0x30CA2EF91D15ADF8(); -``` - -``` -NativeDB Introduced: v2189 -``` - diff --git a/AUDIO/N_0xc8ede9bdbccba6d4.md b/AUDIO/N_0xc8ede9bdbccba6d4.md deleted file mode 100644 index 1c8a3dc8f..000000000 --- a/AUDIO/N_0xc8ede9bdbccba6d4.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -ns: AUDIO ---- -## _0xC8EDE9BDBCCBA6D4 - -```c -// 0xC8EDE9BDBCCBA6D4 0x55A21772 -void _0xC8EDE9BDBCCBA6D4(Any* p0, float p1, float p2, float p3); -``` - - -## Parameters -* **p0**: -* **p1**: -* **p2**: -* **p3**: - diff --git a/AUDIO/SetSynchronizedAudioEventPositionThisFrame.md b/AUDIO/SetSynchronizedAudioEventPositionThisFrame.md deleted file mode 100644 index 419a35688..000000000 --- a/AUDIO/SetSynchronizedAudioEventPositionThisFrame.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -ns: AUDIO -aliases: ["0x950A154B8DAB6185"] ---- -## _SET_SYNCHRONIZED_AUDIO_EVENT_POSITION_THIS_FRAME - -```c -// 0x950A154B8DAB6185 0xA17F9AB0 -void _SET_SYNCHRONIZED_AUDIO_EVENT_POSITION_THIS_FRAME(char* p0, Entity p1); -``` - -``` -Sets the position of the audio event to the entity's position for one frame(?) -if (l_8C3 == 0) { - sub_27fd1(0, -1, 1); - if (PED::IS_SYNCHRONIZED_SCENE_RUNNING(l_87D)) { - AUDIO::STOP_SYNCHRONIZED_AUDIO_EVENT(l_87D); - } - if (sub_7dd(l_A00)) { - AUDIO::_950A154B8DAB6185("PAP2_IG1_POPPYSEX", l_A00); - } - sub_91c("TK************ SETTING SYNCH SCENE AUDIO POSITION THIS FRAME ************TK"); - l_8C3 = 1; -} --- -Found in the b617d scripts, duplicates removed: -AUDIO::_950A154B8DAB6185("CAR_5_IG_6", l_7FE[1/*1*/]); -AUDIO::_950A154B8DAB6185("EX03_TRAIN_BIKE_LAND", PLAYER::PLAYER_PED_ID()); -AUDIO::_950A154B8DAB6185("FBI_2_MCS_1_LeadIn", l_40[2/*1*/]); -AUDIO::_950A154B8DAB6185("FIN_C2_MCS_1", l_24C[0/*1*/]); -AUDIO::_950A154B8DAB6185("MNT_DNC", l_5F); -AUDIO::_950A154B8DAB6185("PAP2_IG1_POPPYSEX", l_A00); -``` - -## Parameters -* **p0**: -* **p1**: -