Skip to content

WIP: Add new event onClientWorldSound #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

WIP: Add new event onClientWorldSound #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
db9d5dd
Added onClientWorldSound event
May 8, 2017
268bbc8
Restrict world sounds to Ped/Player
May 11, 2017
93c5b40
Revert "Restrict world sounds to Ped/Player"
May 13, 2017
d2ca755
Restrict onClientWorldSound to ped and player
May 13, 2017
b08eb79
Merge branch 'master' into feature/world-sound-event
Feb 27, 2018
d164604
Update CAESoundManagerSAInterface
Feb 28, 2018
92f0a99
Add CAudioZones
Mar 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions Client/game_sa/Audio/CAudioZonesSA.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*****************************************************************************
*
* PROJECT: Multi Theft Auto
* LICENSE: See LICENSE in the top level directory
* FILE: game_sa/Audio/CAudioZonesSA.cpp
* PURPOSE: Source file for audio zones class
*
* Multi Theft Auto is available from https://www.multitheftauto.com/
*
*****************************************************************************/
#include "StdInc.h"
#include "CAudioZonesSA.h"

// 0xB6DC6C CAudioZones::m_aActiveBoxes
// 0xB6DC94 CAudioZones::m_aActiveSpheres
// 0xB6DCBC CAudioZones::m_NumActiveBoxes
// 0xB6DCC0 CAudioZones::m_NumActiveSpheres
// 0xB6DCC4 CAudioZones::m_NumBoxes
// 0xB6DCC8 CAudioZones::m_NumSpheres
// 0xB6EBB0 CAudioZones::m_aSpheres

#define VAR_CAudioZonesSA__m_aBoxes 0xB6DCD0

CAudioZoneBoxSAInterface ( * CAudioZonesSA::m_aBoxes ) [100] = reinterpret_cast < decltype ( CAudioZonesSA::m_aBoxes ) > ( VAR_CAudioZonesSA__m_aBoxes );

void CAudioZonesSA::Init ( void )
{
// 0x5081A0 void __cdecl CAudioZones::Init(void)
}

void CAudioZonesSA::RegisterAudioBox ( const char * szZoneName, int16_t wBank, bool bEnabled, float minX, float minY, float minZ, float maxX, float maxY, float maxZ )
{
// 0x508240 void __cdecl CAudioZones::RegisterAudioBox(const char *, int16_t, bool, float, float, float, float, float, float)
}

void CAudioZonesSA::RegisterAudioSphere ( const char * szZoneName, int16_t wBank, bool bEnabled, float centerX, float centerY, float centerZ )
{
// 0x5081C0 void __cdecl CAudioZones::RegisterAudioSphere(const char *, in16_t, bool, float, float, float, float)
}

void CAudioZonesSA::SwitchAudioZone ( const char * szZoneName, bool bEnabled )
{
// 0x508320 void __cdecl CAudioZones::SwitchAudioZone(const char *, bool)
}

void CAudioZonesSA::Update ( bool bForced )
{
// 0x5083C0 CAudioZones::Update(bool)
}
47 changes: 47 additions & 0 deletions Client/game_sa/Audio/CAudioZonesSA.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/*****************************************************************************
*
* PROJECT: Multi Theft Auto
* LICENSE: See LICENSE in the top level directory
* FILE: game_sa/Audio/CAudioZonesSA.h
* PURPOSE: Header file for audio zones class
*
* Multi Theft Auto is available from https://www.multitheftauto.com/
*
*****************************************************************************/
#pragma once

#include <cstdint>

struct CAudioZoneBoxSAInterface
{
char szName[8]; // + 0x00
int16_t wBank; // + 0x08
bool bEnabled; // + 0x0A
int8_t field_B;
uint16_t wMinX; // + 0x0C
uint16_t wMinY; // + 0x0E
uint16_t wMinZ; // + 0x10
uint16_t wMaxX; // + 0x12
uint16_t wMaxY; // + 0x14
uint16_t wMaxZ; // + 0x16
};
static_assert(sizeof(CAudioZoneBoxSAInterface) == 0x18, "Invalid size of CAudioZoneBoxSAInterface");

struct CAudioZoneSphereSAInterface
{

};
// static_assert(sizeof(CAudioZoneSphereSAInterface) == 0x18, "Invalid size of CAudioZoneSphereSAInterface");

class CAudioZonesSA
{
public:
static void Init ( void );
static void RegisterAudioBox ( const char * szZoneName, int16_t wBank, bool bEnabled, float minX, float minY, float minZ, float maxX, float maxY, float maxZ );
static void RegisterAudioSphere ( const char * szZoneName, int16_t wBank, bool bEnabled, float centerX, float centerY, float centerZ );
static void SwitchAudioZone ( const char * szZoneName, bool bEnabled );
static void Update ( bool bForced );

public:
static CAudioZoneBoxSAInterface ( *m_aBoxes ) [100];
};
18 changes: 17 additions & 1 deletion Client/game_sa/CAESoundManagerSA.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,26 @@

#define CLASS_CAESoundManager 0xB62CB0

#pragma pack(push, 1)
class CAESoundManagerSAInterface
{

int16_t m_wNumAvailableChannels; // + 0x0000 // = CAEAudioHardware::GetNumAvailableChannels(...), [10, 300]
int16_t m_wChannel; // + 0x0002 // = CAEAudioHardware::AllocateChannels(...), could be -1
CAESound m_aSound [300]; // + 0x0004
int16_t * m_aChannelSoundTable; // + 0x87F4 // = new short[m_wNumAvailableChannels]
int16_t * m_aChannelSoundPosition; // + 0x87F8 // = new short[m_wNumAvailableChannels]
int16_t * m_aChannelSoundUncancellable; // + 0x87FC // = new short[m_wNumAvailableChannels]
int16_t m_wSoundLength [300]; // + 0x8800 // = -1 (0xFFFF) when initialized
int16_t m_wSoundLoopStartTime [300]; // + 0x8A58 // = -1 (0xFFFF) when initialized
uint32_t m_uiUpdateTime; // + 0x8CB0
int8_t m_bPauseTimeInUse; // + 0x8CB4
int8_t m_bPaused; // + 0x8CB5
int8_t field_8CB6;
int8_t field_8CB7;
uint32_t m_uiPauseUpdateTime; // + 0x8CB8
};
#pragma pack(pop)
static_assert(sizeof(CAESoundManagerSAInterface) == 0x8CBC, "Invalid size for CAESoundManagerSAInterface");

class CAESoundManagerSA : public CAESoundManager
{
Expand Down
11 changes: 8 additions & 3 deletions Client/game_sa/CAudioEngineSA.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,7 @@ void CAudioEngineSA::ResetWorldSounds ( void )
m_DisabledWorldSounds = CRanges ();
}

void CAudioEngineSA::SetWorldSoundHandler ( WorldSoundHandler * pHandler )
void CAudioEngineSA::SetWorldSoundHandler ( WorldSoundHandler pHandler )
{
m_pWorldSoundHandler = pHandler;
}
Expand All @@ -502,8 +502,13 @@ bool CAudioEngineSA::OnWorldSound ( CAESound* pAESound )
if ( !IsWorldSoundEnabled ( pAESound->usGroup, pAESound->usIndex ) )
return false;

if ( m_pWorldSoundHandler )
m_pWorldSoundHandler ( pAESound->usGroup, pAESound->usIndex );
if ( m_pWorldSoundHandler ) {
bool bCanceled = !m_pWorldSoundHandler ( pAESound->usGroup, pAESound->usIndex, pAESound->pGameEntity, pAESound->m_vCurrPosn );

if ( bCanceled ) {
return false;
}
}

return true;
}
Expand Down
20 changes: 10 additions & 10 deletions Client/game_sa/CAudioEngineSA.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ class CAESound
short m_wPlayingState; // +104
char unk6[2]; // +106
float m_fSoundHeadRoom; // +108
short unk7; // +112
short m_wSoundLength; // +112
short unk8; // +114

};
Expand Down Expand Up @@ -145,22 +145,22 @@ class CAudioEngineSA : public CAudioEngine
VOID SetWorldSoundEnabled ( uint uiGroup, uint uiIndex, bool bEnabled, bool bImmediate );
bool IsWorldSoundEnabled ( uint uiGroup, uint uiIndex );
void ResetWorldSounds ( void );
void SetWorldSoundHandler ( WorldSoundHandler * pHandler );
void SetWorldSoundHandler ( WorldSoundHandler pHandler );
void ReportBulletHit ( CEntity * pEntity, unsigned char ucSurfaceType, CVector * pvecPosition, float f_2 );
void ReportWeaponEvent ( int iEvent, eWeaponType weaponType, CPhysical * pPhysical );

void UpdateAmbientSoundSettings ( void );
bool OnWorldSound ( CAESound* pAESound );

private:
bool m_bRadioOn;
bool m_bRadioMuted;
unsigned char m_ucRadioChannel;
bool m_bAmbientSoundsPaused;
bool m_bAmbientGeneralEnabled;
bool m_bAmbientGunfireEnabled;
CRanges m_DisabledWorldSounds;
WorldSoundHandler* m_pWorldSoundHandler;
bool m_bRadioOn;
bool m_bRadioMuted;
unsigned char m_ucRadioChannel;
bool m_bAmbientSoundsPaused;
bool m_bAmbientGeneralEnabled;
bool m_bAmbientGunfireEnabled;
CRanges m_DisabledWorldSounds;
WorldSoundHandler m_pWorldSoundHandler;

CAudioEngineSAInterface * m_pInterface;
};
Expand Down
36 changes: 27 additions & 9 deletions Client/mods/deathmatch/logic/CClientGame.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ CClientGame::CClientGame ( bool bLocalPlay )
g_pGame->SetPreWeaponFireHandler ( CClientGame::PreWeaponFire );
g_pGame->SetPostWeaponFireHandler ( CClientGame::PostWeaponFire );
g_pGame->SetTaskSimpleBeHitHandler ( CClientGame::StaticTaskSimpleBeHitHandler );
g_pGame->GetAudio ()->SetWorldSoundHandler ( CClientGame::StaticWorldSoundHandler );
g_pCore->SetMessageProcessor ( CClientGame::StaticProcessMessage );
g_pCore->GetKeyBinds ()->SetKeyStrokeHandler ( CClientGame::StaticKeyStrokeHandler );
g_pCore->GetKeyBinds ()->SetCharacterKeyHandler ( CClientGame::StaticCharacterKeyHandler );
Expand Down Expand Up @@ -2925,8 +2926,10 @@ void CClientGame::AddBuiltInEvents ( void )

// Misc events
m_Events.AddEvent ( "onClientFileDownloadComplete", "fileName, success", NULL, false );

m_Events.AddEvent ( "onClientWeaponFire", "ped, x, y, z", NULL, false );

m_Events.AddEvent ( "onClientWorldSound", "group, index, x, y, z", NULL, false );
}


Expand Down Expand Up @@ -6370,11 +6373,6 @@ void CClientGame::SetDevelopmentMode ( bool bEnable, bool bEnableWeb )
{
m_bDevelopmentMode = bEnable;

if ( m_bDevelopmentMode )
g_pGame->GetAudio ()->SetWorldSoundHandler ( CClientGame::StaticWorldSoundHandler );
else
g_pGame->GetAudio ()->SetWorldSoundHandler ( NULL );

if ( g_pCore->IsWebCoreLoaded() )
g_pCore->GetWebCore()->SetTestModeEnabled ( bEnableWeb );
}
Expand All @@ -6387,9 +6385,9 @@ void CClientGame::SetDevelopmentMode ( bool bEnable, bool bEnableWeb )
// Handle callback from CAudioSA when a world sound is played
//
//////////////////////////////////////////////////////////////////
void CClientGame::StaticWorldSoundHandler ( uint uiGroup, uint uiIndex )
bool CClientGame::StaticWorldSoundHandler ( uint uiGroup, uint uiIndex, CEntitySAInterface* pEntityInterface, const CVector& vecPosition )
{
g_pClientGame->WorldSoundHandler ( uiGroup, uiIndex );
return g_pClientGame->WorldSoundHandler ( uiGroup, uiIndex, pEntityInterface, vecPosition );
}


Expand All @@ -6400,10 +6398,30 @@ void CClientGame::StaticWorldSoundHandler ( uint uiGroup, uint uiIndex )
// Handle callback from CAudioSA when a world sound is played
//
//////////////////////////////////////////////////////////////////
void CClientGame::WorldSoundHandler ( uint uiGroup, uint uiIndex )
bool CClientGame::WorldSoundHandler ( uint uiGroup, uint uiIndex, CEntitySAInterface* pEntityInterface, const CVector& vecPosition )
{
if ( m_bShowSound )
m_pScriptDebugging->LogInformation ( NULL, "%s - World sound group:%d index:%d", *GetLocalTimeString ( false, true ), uiGroup, uiIndex );

if ( pEntityInterface ) {
CClientEntity* pEntity = g_pClientGame->GetGameEntityXRefManager()->FindClientEntity( pEntityInterface );

if ( pEntity && ( pEntity->GetType() == CCLIENTPED || pEntity->GetType() == CCLIENTPLAYER ) ) {
Copy link

@CrosRoad95 CrosRoad95 May 13, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sound can be from example: vehicles, explosion vehicle/barrels/gas station etc, weapons, destroyed objects
so, if element isnt ped/player then source=nil

Copy link
Author

@Necktrox Necktrox May 13, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • The pull request description tackles this issue: The hooked GTA:SA function doesn't handle a lot of sounds and that's why it is restricted to player/ped entities, because you can only cancel these.
  • The source element can never be nil, it's either the source element or root

CLuaArguments Arguments;
Arguments.PushNumber( uiGroup );
Arguments.PushNumber( uiIndex );
Arguments.PushNumber( vecPosition.fX );
Arguments.PushNumber( vecPosition.fY );
Arguments.PushNumber( vecPosition.fZ );
bool bCanceled = !pEntity->CallEvent( "onClientWorldSound", Arguments, pEntity != m_pRootEntity );

if ( bCanceled ) {
return false;
}
}
}

return true;
}


Expand Down
4 changes: 2 additions & 2 deletions Client/mods/deathmatch/logic/CClientGame.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ class CClientGame
static void StaticGamePlayerDestructHandler ( CEntitySAInterface* pPlayer );
static void StaticGameProjectileDestructHandler ( CEntitySAInterface* pProjectile );
static void StaticGameModelRemoveHandler ( ushort usModelId );
static void StaticWorldSoundHandler ( uint uiGroup, uint uiIndex );
static bool StaticWorldSoundHandler ( uint uiGroup, uint uiIndex, CEntitySAInterface* pEntityInterface, const CVector& vecPosition );
static void StaticGameEntityRenderHandler ( CEntitySAInterface* pEntity );
static void StaticTaskSimpleBeHitHandler ( CPedSAInterface* pPedAttacker, ePedPieceTypes hitBodyPart, int hitBodySide, int weaponId );
static void StaticFxSystemDestructionHandler ( void * pFxSAInterface );
Expand Down Expand Up @@ -548,7 +548,7 @@ class CClientGame
void GamePlayerDestructHandler ( CEntitySAInterface* pPlayer );
void GameProjectileDestructHandler ( CEntitySAInterface* pProjectile );
void GameModelRemoveHandler ( ushort usModelId );
void WorldSoundHandler ( uint uiGroup, uint uiIndex );
bool WorldSoundHandler ( uint uiGroup, uint uiIndex, CEntitySAInterface* pEntityInterface, const CVector& vecPosition );
void TaskSimpleBeHitHandler ( CPedSAInterface* pPedAttacker, ePedPieceTypes hitBodyPart, int hitBodySide, int weaponId );
AnimationId DrivebyAnimationHandler ( AnimationId animGroup, AssocGroupId animId );

Expand Down
9 changes: 3 additions & 6 deletions Client/sdk/game/CAudioEngine.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,12 @@
*
*****************************************************************************/

#ifndef __CGAME_AUDIOENGINE
#define __CGAME_AUDIOENGINE
#pragma once

#include <windows.h>
#include "CVehicle.h"

typedef void ( WorldSoundHandler ) ( uint uiGroup, uint uiIndex );
using WorldSoundHandler = bool (*) ( uint uiGroup, uint uiIndex, CEntitySAInterface* pEntityInterface, const CVector& vecPosition );

enum eSurfaceType
{
Expand Down Expand Up @@ -60,9 +59,7 @@ class CAudioEngine
virtual VOID SetWorldSoundEnabled ( uint uiGroup, uint uiIndex, bool bEnabled, bool bForceCancel ) = 0;
virtual bool IsWorldSoundEnabled ( uint uiGroup, uint uiIndex ) = 0;
virtual void ResetWorldSounds ( void ) = 0;
virtual void SetWorldSoundHandler ( WorldSoundHandler * pHandler ) = 0;
virtual void SetWorldSoundHandler ( WorldSoundHandler pHandler ) = 0;
virtual void ReportBulletHit ( CEntity * pEntity, unsigned char ucSurfaceType, CVector * pvecPosition, float f_2 ) = 0;
virtual void ReportWeaponEvent ( int iEvent, eWeaponType weaponType, CPhysical * pPhysical ) = 0;
};

#endif