OnPlayerWeaponSwitch: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Adding [Cancel Effect])
m (Fix mistake)
Line 18: Line 18:


==Cancel effect==
==Cancel effect==
If this event is [[Event system#Canceling|canceled]], then the player's weapon won't be switched. If this event has been caused by [[giveWeapon]] or [[takeWeapon]], then the player won't receive/lose the weapon.
If this event is [[Event system#Canceling|canceled]], then the player's weapon won't be switched.


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">

Revision as of 15:51, 14 June 2023

This event is triggered whenever a 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 previousWeaponID, int currentWeaponID
  • previousWeaponID: An integer representing the weapon that was switched from.
  • currentWeaponID: An integer representing the weapon that was switched to.

Source

The source of this event is the player that switched his weapon.

Example

This example disables use of the minigun upon switch. It should be noted that this can be done more efficiently clientside.

Cancel effect

If this event is canceled, then the player's weapon won't be switched. 

WeaponID = {
	[31] = true,
	[36] = true,
	[38] = true,
}

--add an event handler for onPlayerWeaponSwitch
addEventHandler ( 'onPlayerWeaponSwitch', getRootElement ( ),
	function ( previousWeaponID, currentWeaponID )
		if ( WeaponID[currentWeaponID] ) then
			toggleControl ( source, 'fire', false ) --disable the fire button
		else
			toggleControl ( source, 'fire', true ) --enable it
		end
	end
)

See Also

Player events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerWeaponSwitch?oldid=76997"