OnPlayerWeaponSwitch - Revision history

Srslyyyy: Fix example

2023-11-16T09:44:48Z

Fix example

← Older revision		Revision as of 09:44, 16 November 2023
Line 18:		Line 18:

	==Example==		==Example==
	This example ~~disables use of the minigun upon switch. It~~ should be noted that ~~this can~~ be done ~~more efficiently clientside~~.		This example allows you to disable shoot ability for certain weapons, it should be noted that it will be more efficient if done on client-side.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local ~~weaponID~~ = {		local weaponsToBlock = {
	~~[31] = true,~~		[38] = true, -- minigun
	~~[36] = true,~~
	[38] = true,
	}		}

	~~--add an event handler for onPlayerWeaponSwitch~~		function onPlayerWeaponSwitch(previousWeaponID, currentWeaponID)
	~~addEventHandler('~~onPlayerWeaponSwitch~~', root, function~~(~~prevWeapon~~, ~~curWeapon~~)		local blockFire = (not weaponsToBlock[currentWeaponID]) -- reverse bool, true/worthy will give us false, and false/unworthy will give us true
	~~if weaponID~~[~~curWeapon~~] ~~then~~
	~~toggleControl(source~~, ~~'fire'~~, false~~) -- disable the fire button~~		toggleControl(source, "fire", blockFire) -- toggle player control to fire weapon
	~~else~~		end
	toggleControl(source, 'fire', ~~true~~) -- ~~enable it~~		addEventHandler("onPlayerWeaponSwitch", root, onPlayerWeaponSwitch)
	end
	~~end~~)
	</syntaxhighlight>		</syntaxhighlight>

	{{See also/Server event\|Player events}}		{{See also/Server event\|Player events}}

2023-06-14T20:12:15Z

Fixed typo

← Older revision		Revision as of 20:12, 14 June 2023
Line 29:		Line 29:
	--add an event handler for onPlayerWeaponSwitch		--add an event handler for onPlayerWeaponSwitch
	addEventHandler('onPlayerWeaponSwitch', root, function(prevWeapon, curWeapon)		addEventHandler('onPlayerWeaponSwitch', root, function(prevWeapon, curWeapon)
	if weaponID[~~currentWeaponID~~] then		if weaponID[curWeapon] then
	toggleControl(source, 'fire', false) -- disable the fire button		toggleControl(source, 'fire', false) -- disable the fire button
	else		else

2023-06-14T20:11:59Z

Replace to predefined variables

← Older revision		Revision as of 20:11, 14 June 2023
Line 21:		Line 21:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~WeaponID~~ = {		local weaponID = {
	[31] = true,		[31] = true,
	[36] = true,		[36] = true,
Line 28:		Line 28:

	--add an event handler for onPlayerWeaponSwitch		--add an event handler for onPlayerWeaponSwitch
	addEventHandler ( 'onPlayerWeaponSwitch', ~~getRootElement ( )~~,		addEventHandler('onPlayerWeaponSwitch', root, function(prevWeapon, curWeapon)
	function ( ~~previousWeaponID~~, ~~currentWeaponID~~ )		if weaponID[currentWeaponID] then
	if ~~( WeaponID~~[currentWeaponID] ) then		toggleControl(source, 'fire', false) -- disable the fire button
	toggleControl ( source, 'fire', false ) --disable the fire button		else
	else		toggleControl(source, 'fire', true) -- enable it
	toggleControl ( source, 'fire', true ) --enable it
	~~end~~
	end		end
	)		end)
	</syntaxhighlight>		</syntaxhighlight>

	{{See also/Server event\|Player events}}		{{See also/Server event\|Player events}}

2023-06-14T15:57:31Z

"Cancel effect" before "Example"

← Older revision		Revision as of 15:57, 14 June 2023
Line 13:		Line 13:
	==Source==		==Source==
	The [[event system#Event source\|source]] of this event is the [[player]] that switched his weapon.		The [[event system#Event source\|source]] of this event is the [[player]] that switched his weapon.

			==Cancel effect==
			If this event is [[Event system#Canceling\|canceled]], then the player's weapon won't be switched.

	==Example==		==Example==
	This example disables use of the minigun upon switch. It should be noted that this can be done more efficiently clientside.		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 [[Event system#Canceling\|canceled]], then the player's weapon won't be switched.~~

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

2023-06-14T15:51:58Z

Fix mistake

← Older revision		Revision as of 15:51, 14 June 2023
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">

2023-06-14T15:46:50Z

Adding [Cancel Effect]

← Older revision		Revision as of 15:46, 14 June 2023
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server event}}		{{Server event}}
	This event is triggered whenever a 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 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==		==Parameters==
Line 16:		Line 16:
	==Example==		==Example==
	This example disables use of the minigun upon switch. It should be noted that this can be done more efficiently clientside.		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 [[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.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	WeaponID = {		WeaponID = {

2018-09-27T03:03:38Z

← Older revision		Revision as of 03:03, 27 September 2018
Line 35:		Line 35:
	</syntaxhighlight>		</syntaxhighlight>

	==See ~~Also==~~		{{See also/Server event\|Player events}}
	~~===~~Player events~~===~~
	~~{{Player_events}}~~
	~~===Event functions===~~
	~~{{Event functions~~}}

2018-09-27T02:18:40Z

← Older revision		Revision as of 02:18, 27 September 2018
Line 35:		Line 35:
	</syntaxhighlight>		</syntaxhighlight>

	{{See ~~also/Server event\|~~Player events}}		==See Also==
			===Player events===
			{{Player_events}}
			===Event functions===
			{{Event functions}}

2018-04-02T21:35:38Z

← Older revision		Revision as of 21:35, 2 April 2018
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server event}}		{{Server event}}
	This event is triggered whenever a 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 a player's equipped weapon '''slot''' changes. This means [[giveWeapon]] and [[takeWeapon]] will trigger this function if the equipped slot is forced to change.

	==Parameters==		==Parameters==

2018-04-02T21:35:12Z

Parameters

← Older revision		Revision as of 21:35, 2 April 2018
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>

	*'''previousWeaponID''': An [[int\|integer]] representing the [[weapons\|weapon]] that was switched from		*'''previousWeaponID''': An [[int\|integer]] representing the [[weapons\|weapon]] that was switched from.
	*'''currentWeaponID''': An [[int\|integer]] representing the [[weapons\|weapon]] that was switched to		*'''currentWeaponID''': An [[int\|integer]] representing the [[weapons\|weapon]] that was switched to.

	==Source==		==Source==