GetControlState - Revision history

FileEX: This function is shared

2024-04-30T00:00:45Z

This function is shared

← Older revision		Revision as of 00:00, 30 April 2024
Line 1:		Line 1:
	{{~~Server~~ function}}		{{Shared function}}
	__NOTOC__		__NOTOC__
	This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.		This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.

Tracer: Undo revision 77352 by Tracer (talk)

2023-08-07T14:32:07Z

Undo revision 77352 by Tracer (talk)

← Older revision		Revision as of 14:32, 7 August 2023
Line 1:		Line 1:
	{{~~Shared_function~~}}		{{Server function}}
	__NOTOC__		__NOTOC__
	This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.		This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.

Tracer: This is a shared function, not a server one

2023-08-07T14:27:40Z

This is a shared function, not a server one

← Older revision		Revision as of 14:27, 7 August 2023
Line 1:		Line 1:
	{{~~Server function~~}}		{{Shared_function}}
	__NOTOC__		__NOTOC__
	This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.		This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.

ArtyomHead at 19:36, 13 May 2021

2021-05-13T19:36:00Z

← Older revision		Revision as of 19:36, 13 May 2021
Line 1:		Line 1:
	{{~~Shared~~ function}}		{{Server function}}
	__NOTOC__		__NOTOC__
	This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.		This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.

ArtyomHead: chaged "Server-only" to "Shared"

2021-05-13T19:31:04Z

chaged "Server-only" to "Shared"

← Older revision		Revision as of 19:31, 13 May 2021
Line 1:		Line 1:
	{{~~Server~~ function}}		{{Shared function}}
	__NOTOC__		__NOTOC__
	This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.		This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.

Myonlake at 21:10, 8 July 2018

2018-07-08T21:10:14Z

← Older revision		Revision as of 21:10, 8 July 2018
Line 1:		Line 1:
	{{Server ~~client~~ function}}		{{Server function}}
	__NOTOC__		__NOTOC__
	This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.		This function will check if a player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use [[bindKey]] and a command function.
Line 6:		Line 6:

	==Syntax==		==Syntax==
	~~<section name="Server" class="server" show="true">~~
	<syntaxhighlight lang="lua">bool getControlState ( player thePlayer, string controlName )</syntaxhighlight>		<syntaxhighlight lang="lua">bool getControlState ( player thePlayer, string controlName )</syntaxhighlight>

Line 32:		Line 31:
	*vehicle_mouse_look		*vehicle_mouse_look
	special_control_		special_control_
	~~</section>~~

	~~<section name="Client" class="client" show="true">~~
	~~<syntaxhighlight lang="lua">bool getControlState ( string controlName ) </syntaxhighlight>~~

	~~===Required Arguments===~~
	*'''controlName:''' The control that you want to get the state of. See [[control names]] for a list of possible controls.
	~~</section>~~

	===Returns===		===Returns===
Line 45:		Line 36:

	==Example==		==Example==
	~~<section name="Server" class="server" show="true">~~
	This example starts a repeating check when a player spawns, if a player presses the fire key, they'll be killed.		This example starts a repeating check when a player spawns, if a player presses the fire key, they'll be killed.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 62:		Line 52:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~
			==Changelog==
			{{ChangelogHeader}}
			{{ChangelogItem\|1.5.5-3.11427\|Deprecated client-side. Use [[setPedControlState]] and [[getPedControlState]] client-side.}}

	==See Also==		==See Also==
	{{Input functions}}		{{Input functions}}

Arran Fortuna at 11:37, 21 November 2014

2014-11-21T11:37:58Z

← Older revision		Revision as of 11:37, 21 November 2014
Line 42:		Line 42:

	===Returns===		===Returns===
	Returns the state of the control ~~if found~~, ''false'' ~~otherwise~~.		Returns the state of the control, ''false'' if the control doesn't exist or if the player is dead.

	==Example==		==Example==

Jaysds: /* Example */ killPlayer doesn't exist

2012-08-01T03:30:22Z

Example: killPlayer doesn't exist

← Older revision		Revision as of 03:30, 1 August 2012
Line 56:		Line 56:
	if ( getControlState ( thePlayer, key ) ) then -- if they're pressing the fire key		if ( getControlState ( thePlayer, key ) ) then -- if they're pressing the fire key
	outputChatBox ( "Violence will not be tolerated!", thePlayer )		outputChatBox ( "Violence will not be tolerated!", thePlayer )
	~~killPlayer~~ ( thePlayer ) -- kill them		killPed ( thePlayer ) -- kill them
	else -- otherwise..		else -- otherwise..
	setTimer ( killPlayerIfTheyPressThisKey, 500, 1, thePlayer, key ) -- call this function again in 500ms		setTimer ( killPlayerIfTheyPressThisKey, 500, 1, thePlayer, key ) -- call this function again in 500ms

EAi: /* Syntax */

2010-11-29T17:44:03Z

Syntax

← Older revision		Revision as of 17:44, 29 November 2010
Line 12:		Line 12:
	*'''thePlayer:''' The player you wish to get the control state of. Do not use this parameter when scripting for client.		*'''thePlayer:''' The player you wish to get the control state of. Do not use this parameter when scripting for client.
	*'''controlName:''' The control that you want to get the state of. See [[control names]] for a list of possible controls.		*'''controlName:''' The control that you want to get the state of. See [[control names]] for a list of possible controls.
	'''Note:''' several controls are not synched with the server, therefore the function will always return ''false'' for these controls serverside. ~~The~~ controls are:		'''Note:''' several controls are not synched with the server, therefore the function will always return ''false'' for these controls serverside. These controls are:
	*next_weapon		*next_weapon
	*previous_weapon		*previous_weapon
Line 24:		Line 24:
	*group_control_forwards		*group_control_forwards
	*group_control_back		*group_control_back

	*sub_mission		*sub_mission
	*radio_next		*radio_next

EAi: /* Syntax */

2010-11-29T17:43:10Z

Syntax

← Older revision		Revision as of 17:43, 29 November 2010
Line 12:		Line 12:
	*'''thePlayer:''' The player you wish to get the control state of. Do not use this parameter when scripting for client.		*'''thePlayer:''' The player you wish to get the control state of. Do not use this parameter when scripting for client.
	*'''controlName:''' The control that you want to get the state of. See [[control names]] for a list of possible controls.		*'''controlName:''' The control that you want to get the state of. See [[control names]] for a list of possible controls.
	'''Note:''' several controls are not synched with the server, therefore the function will always return ''false'' for these controls serverside. The ~~nonsynched~~ controls are:		'''Note:''' several controls are not synched with the server, therefore the function will always return ''false'' for these controls serverside. The controls are:
	*next_weapon		*next_weapon
	*previous_weapon		*previous_weapon