SetAnalogControlState - Revision history

Lvrent at 21:06, 23 September 2021

2021-09-23T21:06:29Z

← Older revision		Revision as of 21:06, 23 September 2021
Line 10:		Line 10:
	===Optional Arguments===		===Optional Arguments===
	*'''state:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.		*'''state:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.
	{{Added feature/item~~\|3.0160~~\|1.5.9\|1.5.8\|20756\|		{{Added feature/item\|1.5.9\|1.5.8\|20756\|
	*'''forceOverrideNextFrame: ''' A [[bool]] indicating if the player input should force fully overriden for the next frame.		*'''forceOverrideNextFrame: ''' A [[bool]] indicating if the player input should force fully overriden for the next frame.
	}}		}}

Lvrent at 13:15, 23 September 2021

2021-09-23T13:15:55Z

← Older revision		Revision as of 13:15, 23 September 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This sets the analog control state of a control for the local player.		This sets the analog control state of a control for the local player. To change the analog controls for a [[ped]], please use [[setPedAnalogControlState]].

	To change the analog controls for a [[ped]], please use [[setPedAnalogControlState]].

	==Syntax==		==Syntax==
Line 12:		Line 10:
	===Optional Arguments===		===Optional Arguments===
	*'''state:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.		*'''state:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.
	~~<noinclude>~~{{Added feature/item\|3.~~0300~~\|1.5.9\|1.5.8\|20756\|		{{Added feature/item\|3.0160\|1.5.9\|1.5.8\|20756\|
	*'''forceOverrideNextFrame: ''' A [[bool]] indicating if the player input should force fully overriden for the next frame.		*'''forceOverrideNextFrame: ''' A [[bool]] indicating if the player input should force fully overriden for the next frame.
	}}~~</noinclude>~~		}}


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

Lvrent at 11:19, 20 September 2021

2021-09-20T11:19:14Z

← Older revision		Revision as of 11:19, 20 September 2021
Line 12:		Line 12:
	===Optional Arguments===		===Optional Arguments===
	*'''state:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.		*'''state:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.
	<noinclude>{{~~New~~ feature/item\|3.0300\|1.5.8\|20756\|		<noinclude>{{Added feature/item\|3.0300\|1.5.9\|1.5.8\|20756\|
	*'''forceOverrideNextFrame: ''' A [[bool]] indicating if the player input should force fully overriden for the next frame.		*'''forceOverrideNextFrame: ''' A [[bool]] indicating if the player input should force fully overriden for the next frame.
	}}</noinclude>		}}</noinclude>

LosFaul: /* Example */

2020-12-13T18:02:37Z

Example

@@ Line 29: / Line 29: @@
          else
              setAnalogControlState( "forwards", 0 )
          end
      end

LosFaul: /* Syntax */

2020-12-13T17:59:13Z

Syntax

← Older revision		Revision as of 17:59, 13 December 2020
Line 6:		Line 6:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool setAnalogControlState ( string control [, float state ] ) </syntaxhighlight>		<syntaxhighlight lang="lua">bool setAnalogControlState ( string control [, float state, bool forceOverrideNextFrame = false ] ) </syntaxhighlight>
	===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 set the state of. See [[control names]] for a list of possible controls.
Line 12:		Line 12:
	===Optional Arguments===		===Optional Arguments===
	*'''state:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.		*'''state:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.
			<noinclude>{{New feature/item\|3.0300\|1.5.8\|20756\|
			*'''forceOverrideNextFrame: ''' A [[bool]] indicating if the player input should force fully overriden for the next frame.
			}}</noinclude>


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

Myonlake: /* Required Arguement */

2018-07-08T21:13:06Z

Required Arguement

← Older revision		Revision as of 21:13, 8 July 2018
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool setAnalogControlState ( string control [, float state ] ) </syntaxhighlight>		<syntaxhighlight lang="lua">bool setAnalogControlState ( string control [, float state ] ) </syntaxhighlight>
	===Required ~~Arguement~~===		===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 set the state of. See [[control names]] for a list of possible controls.

Myonlake at 00:57, 8 July 2018

2018-07-08T00:57:32Z

← Older revision		Revision as of 00:57, 8 July 2018
Line 3:		Line 3:
	This sets the analog control state of a control for the local player.		This sets the analog control state of a control for the local player.

	To change the analog controls for a ped, please use [[setPedAnalogControlState]].		To change the analog controls for a [[ped]], please use [[setPedAnalogControlState]].

	==Syntax==		==Syntax==

Myonlake: /* Syntax */

2018-07-08T00:54:35Z

Syntax

← Older revision		Revision as of 00:54, 8 July 2018
Line 6:		Line 6:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua"> bool setAnalogControlState ( string control [, float state ] ) </syntaxhighlight>		<syntaxhighlight lang="lua">bool setAnalogControlState ( string control [, float state ] ) </syntaxhighlight>
	===Required Arguement===		===Required Arguement===
	*'''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 set the state of. See [[control names]] for a list of possible controls.

Myonlake at 00:49, 8 July 2018

2018-07-08T00:49:22Z

← Older revision		Revision as of 00:49, 8 July 2018
Line 6:		Line 6:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua"> bool setAnalogControlState ( string ~~controlName~~ [, float state] ) </syntaxhighlight>		<syntaxhighlight lang="lua"> bool setAnalogControlState ( string control [, float state ] ) </syntaxhighlight>
	===Required Arguement===		===Required Arguement===
	* '''~~controlName~~'''~~: the~~ control ~~name~~ you ~~wish~~ to set the ~~analog~~ state of. ~~Here's~~ a list:		*'''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'''

	===Optional Arguments===		===Optional Arguments===
	*'''state:''' A float between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.		*'''state:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.

	===Returns===		===Returns===
	Returns true, ~~else~~ false ~~if invalid argument~~.		Returns ''true'' if the control state was successfully set, ''false'' otherwise.

	==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">
	addCommandHandler("~~analog~~", function()		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~~);		)
	</syntaxhighlight>		</syntaxhighlight>
	~~This example written by '''Samurai'''~~

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

Tekken: /* Example */

2016-10-06T04:58:30Z

Example

← Older revision		Revision as of 04:58, 6 October 2016
Line 33:		Line 33:
	/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~~()		addCommandHandler("analog", function()
	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~~)
	</syntaxhighlight>		</syntaxhighlight>
	This example written by '''Samurai'''		This example written by '''Samurai'''