GetAnalogControlState - Revision history

LosFaul: /* Optional Arguments */

2020-11-21T11:56:23Z

Optional Arguments

← Older revision		Revision as of 11:56, 21 November 2020
Line 13:		Line 13:
	===Optional Arguments===		===Optional Arguments===
	{{New feature/item\|3.0157\|1.5.7\|20383\|		{{New feature/item\|3.0157\|1.5.7\|20383\|
	*'''rawValue:''' A bool indicating ~~whether to poll for~~ raw ~~controller state, which ignores keyboard~~ input ~~and any overrides from [[setAnalogControlState]] and others. When set to true, and a controller is not used, the function will always return 0~~.		*'''rawValue:''' A bool indicating if it should return the raw player input value.
	}}		}}

2020-11-20T21:49:31Z

fix ver

← Older revision		Revision as of 21:49, 20 November 2020
Line 12:		Line 12:

	===Optional Arguments===		===Optional Arguments===
	{{New feature/item\|3.~~0160~~\|1.5.7\|20383\|		{{New feature/item\|3.0157\|1.5.7\|20383\|
	*'''rawValue:''' A bool indicating whether to poll for raw controller state, which ignores keyboard input and any overrides from [[setAnalogControlState]] and others. When set to true, and a controller is not used, the function will always return 0.		*'''rawValue:''' A bool indicating whether to poll for raw controller state, which ignores keyboard input and any overrides from [[setAnalogControlState]] and others. When set to true, and a controller is not used, the function will always return 0.
	}}		}}

2020-01-16T20:12:44Z

fix typo

← Older revision		Revision as of 20:12, 16 January 2020
Line 12:		Line 12:

	===Optional Arguments===		===Optional Arguments===
	{{New feature/item\|3.~~0157~~\|1.5.7\|20383\|		{{New feature/item\|3.0160\|1.5.7\|20383\|
	*'''rawValue:''' A bool indicating whether to poll for raw controller state, which ignores keyboard input and any overrides from [[setAnalogControlState]] and others. When set to true, and a controller is not used, the function will always return 0.		*'''rawValue:''' A bool indicating whether to poll for raw controller state, which ignores keyboard input and any overrides from [[setAnalogControlState]] and others. When set to true, and a controller is not used, the function will always return 0.
	}}		}}

2020-01-16T12:45:16Z

Function arguments updated as pull #1165 was merged

← Older revision		Revision as of 12:45, 16 January 2020
Line 6:		Line 6:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">float getAnalogControlState ( string control )</syntaxhighlight>		<syntaxhighlight lang="lua">float getAnalogControlState ( string control [, bool rawValue ] )</syntaxhighlight>

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

			===Optional Arguments===
			{{New feature/item\|3.0157\|1.5.7\|20383\|
			*'''rawValue:''' A bool indicating whether to poll for raw controller state, which ignores keyboard input and any overrides from [[setAnalogControlState]] and others. When set to true, and a controller is not used, the function will always return 0.
			}}

	===Returns===		===Returns===

2018-07-08T21:14:38Z

Required Arguments

← Older revision		Revision as of 21:14, 8 July 2018
Line 9:		Line 9:

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

	===Returns===		===Returns===

2018-07-08T21:14:27Z

Returns

← Older revision		Revision as of 21:14, 8 July 2018
Line 12:		Line 12:

	===Returns===		===Returns===
	Returns a float between 0 and 1 indicating the amount the control is pressed.		Returns a [[float]] between 0 and 1 indicating the amount the control is pressed.

	==Example==		==Example==

2018-07-08T21:14:04Z

← Older revision		Revision as of 21:14, 8 July 2018
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This retrieves the analog control state of a control. This is useful for detecting sensitive controls, such as those used on a joypad.		This retrieves the analog control state of a control. This is useful for detecting sensitive controls, such as those used on a joypad.

			To get the analog control state for a [[ped]], please use [[getPedAnalogControlState]].

	==Syntax==		==Syntax==

2018-07-08T21:13:42Z

← Older revision		Revision as of 21:13, 8 July 2018
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">float getAnalogControlState ( string ~~controlName~~ )</syntaxhighlight>		<syntaxhighlight lang="lua">float getAnalogControlState ( string control )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~controlName~~ :''' ~~the name of the~~ control you ~~wish~~ to ~~get~~ the ~~analog~~ state of. ~~Possible values are:~~		*'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls.
	**'''left'''
	**'''right'''
	**'''forwards'''
	**'''backwards'''
	**'''vehicle_left'''
	**'''vehicle_right'''
	**'''steer_forward'''
	**'''steer_back'''
	**'''accelerate'''
	**'''brake_reverse'''
	**'''special_control_left'''
	**'''special_control_right'''
	**'''special_control_up'''
	**'''special_control_down'''

	===Returns===		===Returns===

2018-07-08T21:12:41Z

Example

← Older revision		Revision as of 21:12, 8 July 2018
Line 27:		Line 27:

	==Example==		==Example==
	/~~analog~~ command ~~starts to go forward control state if you are not~~, ~~if you are going forward by~~ control state ~~then you will stop~~.		This creates an ''/forwards'' command, which toggles your ''forwards'' control state between 0 and 1.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~analog~~( )		addCommandHandler( "forwards",
	if ( getAnalogControlState( "forwards" ) == 0 ) then		function( )
	setAnalogControlState( "forwards", 1 )		if ( getAnalogControlState( "forwards" ) == 0 ) then
	else		setAnalogControlState( "forwards", 1 )
	setAnalogControlState( "forwards", 0 )		else
			setAnalogControlState( "forwards", 0 )
			end
	end		end
	~~end~~		)
	~~addCommandHandler( "analog", analog~~ )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Client input functions}}		{{Client input functions}}

2018-07-08T21:12:12Z

Example

← Older revision		Revision as of 21:12, 8 July 2018
Line 29:		Line 29:
	/analog command starts to go forward control state if you are not, if you are going forward by control state then you will stop.		/analog command starts to go forward control state if you are not, if you are going forward by control state then you will stop.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function analog()		function analog( )
	if (getAnalogControlState("forwards") == 0) then		if ( getAnalogControlState( "forwards" ) == 0 ) then
	setAnalogControlState ("forwards",1)		setAnalogControlState( "forwards", 1 )
	else		else
	setAnalogControlState ("forwards",0)		setAnalogControlState( "forwards", 0 )
			end
	end		end
	~~end~~		addCommandHandler( "analog", analog )
	addCommandHandler("analog",analog)
	</syntaxhighlight>		</syntaxhighlight>
	~~This example written by '''Samurai'''~~

	==See Also==		==See Also==
	{{Client input functions}}		{{Client input functions}}