ToggleControl: Difference between revisions
Jump to navigation
Jump to search
Dmitry7zip (talk | contribs) m (Fixed arg name in "Required Arguments") |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | {{Server client function}} | ||
Enables or disables the use of a GTA control for a specific player. | Enables or disables the use of a GTA control for a specific player. | ||
{{Note| If you want to disable weapons fire, remember to also disable the control '''action''' in addition to the control '''fire'''.}} | |||
==Syntax== | ==Syntax== | ||
| Line 35: | Line 35: | ||
end | end | ||
end | end | ||
addEventHandler ( "onPlayerVehicleEnter", | addEventHandler ( "onPlayerVehicleEnter", root, disableFireForHydra ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
| Line 48: | Line 48: | ||
end | end | ||
end | end | ||
addEventHandler ( "onClientPlayerVehicleEnter", | addEventHandler ( "onClientPlayerVehicleEnter", localPlayer, disableFireForHydra ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
Latest revision as of 08:43, 4 November 2020
Enables or disables the use of a GTA control for a specific player.
Syntax
Click to collapse [-]
Serverbool toggleControl ( player thePlayer, string control, bool enabled )
Required Arguments
- thePlayer: The player you wish to toggle the control ability of.
- control: The control that you want to toggle the ability of. See control names for a list of possible controls.
- enabled: A boolean value representing whether or not the key will be usable or not.
Click to collapse [-]
Clientbool toggleControl ( string control, bool enabled )
Required Arguments
- control: The control that you want to toggle the ability of. See control names for a list of possible controls.
- enabled: A boolean value representing whether or not the key will be usable or not.
Returns
This function true if the control was set successfully, false otherwise.
Example
Click to collapse [-]
Example 1This function will disable the use of the vehicle secondary-fire key for anyone in a Hydra, consequently removing the ability to fire rockets.
function disableFireForHydra ( theVehicle, seat, jacked )
if ( getElementModel ( theVehicle ) == 520 ) then -- if they entered a hydra
toggleControl ( source, "vehicle_secondary_fire", false ) -- disable their fire key
else -- if they entered another vehicle
toggleControl ( source, "vehicle_secondary_fire", true ) -- enable their fire key
end
end
addEventHandler ( "onPlayerVehicleEnter", root, disableFireForHydra )
Click to collapse [-]
Example 2This function will disable the use of the vehicle secondary-fire key for anyone in a Hydra, consequently removing the ability to fire rockets.
function disableFireForHydra ( theVehicle, seat )
if ( getElementModel ( theVehicle ) == 520 ) then -- if they entered a hydra
toggleControl ( "vehicle_secondary_fire", false ) -- disable their fire key
else -- if they entered another vehicle
toggleControl ( "vehicle_secondary_fire", true ) -- enable their fire key
end
end
addEventHandler ( "onClientPlayerVehicleEnter", localPlayer, disableFireForHydra )
See Also
- addCommandHandler
- bindKey
- executeCommandHandler
- getCommandHandlers
- getFunctionsBoundToKey
- getKeyBoundToFunction
- isControlEnabled
- removeCommandHandler
- toggleAllControls
- toggleControl
- unbindKey