OnClientPlayerWeaponFire - Revision history

Srslyyyy: /* Example */

2025-06-05T05:19:34Z

Example

← Older revision		Revision as of 05:19, 5 June 2025
Line 51:		Line 51:
	local playerWeaponSound = playSound3D(playerWeaponSoundPath, playerMuzzleX, playerMuzzleY, playerMuzzleZ)		local playerWeaponSound = playSound3D(playerWeaponSoundPath, playerMuzzleX, playerMuzzleY, playerMuzzleZ)

	if (not ~~playerWeaponCustomSoundPath~~) then		if (not playerWeaponSound) then
	return false		return false
	end		end

Srslyyyy: /* Example */

2025-06-05T05:19:05Z

Example

← Older revision		Revision as of 05:19, 5 June 2025
Line 27:		Line 27:
	This example implements custom gunshot sounds.		This example implements custom gunshot sounds.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~function playGunfireSound(weaponID)~~		local playerWeaponSounds = {
	~~local muzzleX~~, ~~muzzleY~~, ~~muzzleZ~~ = ~~getPedWeaponMuzzlePosition(source)~~		[22] = "sounds/weap/colt45.wav",
	~~local dim~~ = ~~getElementDimension(source)~~		[23] = "sounds/weap/silenced.wav",
	~~local int~~ = ~~getElementInterior(source)~~		[24] = "sounds/weap/deagle.wav",
	~~setAmbientSoundEnabled (~~"~~gunfire~~", ~~false)~~		[25] = "sounds/weap/shotgun.wav",
			[26] = "sounds/weap/sawed-off.wav",
			[27] = "sounds/weap/combat shotgun.wav",
			[28] = "sounds/weap/uzi.wav",
			[30] = "sounds/weap/ak-47.wav",
			[31] = "sounds/weap/m4.wav",
			[32] = "sounds/weap/tec9.wav",
			[34] = "sounds/weap/sniper.wav",
			}

	local ~~weaponSounds = {~~		local function playCustomWeaponSound(weaponID)
	~~[22] = "sounds/weap/colt45.ogg",~~		local playerWeaponSoundPath = playerWeaponSounds[weaponID]
	~~[23] = "sounds/weap/silenced.ogg",~~
	~~[24] = "sounds/weap/deagle.ogg",~~
	~~[25] = "sounds/weap/shotgun.ogg",~~
	~~[26] = "sounds/weap/sawed-off.ogg",~~
	~~[27] = "sounds/weap/combat shotgun.ogg",~~
	~~[28] = "sounds/weap/uzi.ogg",~~
	~~[30]~~ = ~~"sounds/weap/ak-47.ogg",~~
	[31] ~~= "sounds/weap/m4.ogg",~~
	~~[32] = "sounds/weap/tec9.ogg",~~
	~~[34] = "sounds/weap/sniper.ogg",~~
	}

	if ~~weaponSounds[weaponID] then~~		if (not playerWeaponSoundPath) then
	~~sound = playSound3D~~(~~weaponSounds[weaponID], muzzleX, muzzleY, muzzleZ)~~		return false
	~~setSoundMaxDistance(sound, 90)~~
	~~setElementDimension(sound, dim~~)
	~~setElementInterior(sound, int)~~
	~~setSoundVolume(sound, 0.6)~~
	end		end

			local playerMuzzleX, playerMuzzleY, playerMuzzleZ = getPedWeaponMuzzlePosition(source)
			local playerWeaponSound = playSound3D(playerWeaponSoundPath, playerMuzzleX, playerMuzzleY, playerMuzzleZ)

			if (not playerWeaponCustomSoundPath) then
			return false
			end

			setSoundMaxDistance(playerWeaponSound, 90)
			setSoundVolume(playerWeaponSound, 0.6)
	end		end
	addEventHandler("onClientPlayerWeaponFire", root, ~~playGunfireSound~~)		addEventHandler("onClientPlayerWeaponFire", root, playCustomWeaponSound)
	</syntaxhighlight>		</syntaxhighlight>

Fernando187: /* Parameters */

2025-06-01T15:19:48Z

Parameters

← Older revision		Revision as of 15:19, 1 June 2025
Line 11:		Line 11:
	*'''ammo''': an [[int]] amount of ammo left for this weapon type.		*'''ammo''': an [[int]] amount of ammo left for this weapon type.
	*'''ammoInClip''': an [[int]] amount of ammo left for this weapon type in clip.		*'''ammoInClip''': an [[int]] amount of ammo left for this weapon type in clip.
	*'''hitX''', '''hitY''', '''hitZ''': [[float]] world ~~coordinates~~ representing a hit point.		*'''hitX''': [[float]] world X coordinate representing the hit point.
			*'''hitY''': [[float]] world Y coordinate representing the hit point.
			*'''hitZ''': [[float]] world Z coordinate representing the hit point.
	*'''hitElement''': an [[element]] which was hit by a shot.		*'''hitElement''': an [[element]] which was hit by a shot.
	{{New feature/item\|3.0131\|1.3.1\|4311\|		{{New feature/item\|3.0131\|1.3.1\|4311\|

Fernando187: p

2025-06-01T15:19:17Z

← Older revision		Revision as of 15:19, 1 June 2025
Line 14:		Line 14:
	*'''hitElement''': an [[element]] which was hit by a shot.		*'''hitElement''': an [[element]] which was hit by a shot.
	{{New feature/item\|3.0131\|1.3.1\|4311\|		{{New feature/item\|3.0131\|1.3.1\|4311\|
	*'''startX''', '''startY''', '''startZ''': [[float]] world ~~coordinates~~ representing the start of the bullet~~. Note: This is not the gun muzzle~~.		*'''startX''': [[float]] world X coordinate representing the start of the bullet. Note: This is not the gun muzzle.
			*'''startY''': [[float]] world Y coordinate representing the start of the bullet.
			*'''startZ''': [[float]] world Z coordinate representing the start of the bullet.
	}}		}}

Dragon: corrected info to reflect that the local player's projectile weapons or the camera will indeed correctly trigger the event

2024-04-25T03:37:36Z

corrected info to reflect that the local player's projectile weapons or the camera will indeed correctly trigger the event

← Older revision		Revision as of 03:37, 25 April 2024
Line 1:		Line 1:
	{{Client event}}		{{Client event}}
	__NOTOC__		__NOTOC__
	This event is called when a player fires a weapon. This does not trigger for ~~projectiles,~~ melee weapons, or camera.		This event is called when a player fires a weapon. This event does not trigger for melee weapons. Projectile weapons or the camera will only trigger the event if fired by the local player.
	{{Note\|This event is only triggered for players that are streamed in}}		{{Note\|This event is only triggered for players that are streamed in}}
	{{Note\|This does not trigger for ~~projectiles,~~ melee weapons, or ~~camera.~~}}		{{Note\|This does not trigger for any player's melee weapons or for remote player's projectile weapons or cameras}}
	==Parameters==		==Parameters==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Srslyyyy: Replace to localPlayer.

2022-10-22T14:12:42Z

Replace to localPlayer.

← Older revision		Revision as of 14:12, 22 October 2022
Line 63:		Line 63:
	end		end
	-- Add this as a handler so that the function will be triggered every time the local player fires.		-- Add this as a handler so that the function will be triggered every time the local player fires.
	addEventHandler ( "onClientPlayerWeaponFire", ~~getLocalPlayer()~~, onClientPlayerWeaponFireFunc )		addEventHandler ( "onClientPlayerWeaponFire", localPlayer, onClientPlayerWeaponFireFunc )
	</syntaxhighlight>		</syntaxhighlight>

Zangomangu: Removed fixed issue

2022-01-30T10:33:40Z

Removed fixed issue

← Older revision		Revision as of 10:33, 30 January 2022
Line 76:		Line 76:
	addEventHandler("onClientPlayerWeaponFire", root, onClientPlayerWeaponFireFunc)		addEventHandler("onClientPlayerWeaponFire", root, onClientPlayerWeaponFireFunc)
	</syntaxhighlight>		</syntaxhighlight>

	~~==Issues==~~
	~~{{Issues\|~~
	~~{{Issue\|7459\|[Fixed in 1.3.1-4916] onClientPlayerWeaponFire hitElement being nil sometimes with shotgun}}~~
	}}

	==See Also==		==See Also==

Dutchman101: typo

2019-01-15T23:33:04Z

typo

← Older revision		Revision as of 23:33, 15 January 2019
Line 8:		Line 8:
	int weapon, int ammo, int ammoInClip, float hitX, float hitY, float hitZ, element hitElement, float startX, float startY, float startZ		int weapon, int ammo, int ammoInClip, float hitX, float hitY, float hitZ, element hitElement, float startX, float startY, float startZ
	</syntaxhighlight>		</syntaxhighlight>
	*'''weapon''': an [[int]] representing [[weapons\|weapon]] used for ~~making~~ a shot.		*'''weapon''': an [[int]] representing [[weapons\|weapon]] used for firing a shot.
	*'''ammo''': an [[int]] amount of ammo left for this weapon type.		*'''ammo''': an [[int]] amount of ammo left for this weapon type.
	*'''ammoInClip''': an [[int]] amount of ammo left for this weapon type in clip.		*'''ammoInClip''': an [[int]] amount of ammo left for this weapon type in clip.

Dutchman101: /* Example */

2018-10-14T02:56:51Z

Example

← Older revision		Revision as of 02:56, 14 October 2018
Line 49:		Line 49:
	setElementInterior(sound, int)		setElementInterior(sound, int)
	setSoundVolume(sound, 0.6)		setSoundVolume(sound, 0.6)
	end		end
	end		end
	addEventHandler("onClientPlayerWeaponFire", root, playGunfireSound)		addEventHandler("onClientPlayerWeaponFire", root, playGunfireSound)

Dutchman101: /* Example */ -> additional example

2018-10-14T02:55:44Z

Example: -> additional example

@@ Line 21: / Line 21: @@
 ==Example==
 This example sends a warning to the local player if they shoot another player with a minigun.
 <syntaxhighlight lang="lua">
@@ Line 32: / Line 65: @@
 addEventHandler ( "onClientPlayerWeaponFire", getLocalPlayer(), onClientPlayerWeaponFireFunc )
 </syntaxhighlight>
 This example makes the Shotgun fire explosive rounds.
 <syntaxhighlight lang="lua">