OnClientPlayerWeaponSwitch: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Fix example, since it accepts root)
m (grammar)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client event}}
{{Client event}}
This event is triggered whenever the local player's equipped weapon '''slot''' changes. This means giveWeapon and takeWeapon will trigger this function if the equipped slot is forced to change.
This event is triggered whenever the local player's equipped '''[[weapon|weapon slot]]''' changes. This means giveWeapon and takeWeapon will trigger this event if the equipped slot is forced to change.


==Parameters==
==Parameters==
Line 8: Line 8:
</syntaxhighlight>  
</syntaxhighlight>  


*'''previousWeaponSlot''': An integer representing the previous weapon slot the player had before he switched.
*'''previousWeaponSlot''': An integer representing the previous [[weapon|weapon slot]] the player had before he switched.
*'''currentWeaponSlot''': An integer representing the new weapon slot the player has.
*'''currentWeaponSlot''': An integer representing the new [[weapon|weapon slot]] the player has after he switched.


==Source==
==Source==
The [[event system#Event source|source]] of this event is the [[player]] who changed his weapon. (Local player only)
The [[event system#Event source|source]] of this event is the [[player]] who switched their weapon (Local player only)


==Cancel effect==
==Cancel effect==
Line 20: Line 20:
This example disables the use of aiming for the minigun.
This example disables the use of aiming for the minigun.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function disableMinigunOnSwitch ( prevSlot, newSlot )
function disableMinigunOnSwitch(prevSlot, curSlot)
if getPedWeapon(getLocalPlayer(),newSlot) == 38 then --if the switched weapon is the minigun
if getPedWeapon(localPlayer, curSlot) == 38 then --if the switched weapon is the minigun
toggleControl ( "aim_weapon", false ) --disable the aim button
toggleControl("aim_weapon", false) --disable the aim button
else --if it isnt the minigun
else --if it isnt the minigun
toggleControl ( "aim_weapon", true ) --renable the aim button
toggleControl("aim_weapon", true) --renable the aim button
end
end
end
end
addEventHandler ( "onClientPlayerWeaponSwitch", localPlayer, disableMinigunOnSwitch )
addEventHandler("onClientPlayerWeaponSwitch", localPlayer, disableMinigunOnSwitch)
</syntaxhighlight>
</syntaxhighlight>


Latest revision as of 07:48, 1 March 2021

This event is triggered whenever the local player's equipped weapon slot changes. This means giveWeapon and takeWeapon will trigger this event if the equipped slot is forced to change.

Parameters

int previousWeaponSlot, int currentWeaponSlot
  • previousWeaponSlot: An integer representing the previous weapon slot the player had before he switched.
  • currentWeaponSlot: An integer representing the new weapon slot the player has after he switched.

Source

The source of this event is the player who switched their weapon (Local player only)

Cancel effect

If this event is canceled, then the weapon will not be switched.

Example

This example disables the use of aiming for the minigun. 

function disableMinigunOnSwitch(prevSlot, curSlot)
	if getPedWeapon(localPlayer, curSlot) == 38 then --if the switched weapon is the minigun
		toggleControl("aim_weapon", false) --disable the aim button
	else --if it isnt the minigun
		toggleControl("aim_weapon", true) --renable the aim button
	end
end
addEventHandler("onClientPlayerWeaponSwitch", localPlayer, disableMinigunOnSwitch)

See Also

Client player events


Client event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnClientPlayerWeaponSwitch?oldid=69541"