IsControlEnabled - Revision history

Bass at 19:54, 1 April 2013

2013-04-01T19:54:06Z

← Older revision		Revision as of 19:54, 1 April 2013
Line 18:		Line 18:

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

Mr.Hankey: added client syntax

2009-02-12T14:17:58Z

added client syntax

← Older revision		Revision as of 14:17, 12 February 2009
Line 4:		Line 4:

	==Syntax==		==Syntax==
			<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool isControlEnabled ( player thePlayer, string control )		bool isControlEnabled ( player thePlayer, string control )
Line 11:		Line 12:
	*'''thePlayer:''' The player you wish the control status of.		*'''thePlayer:''' The player you wish the control status of.
	*'''control:''' The control you wish to check. See [[control names]] for a list of possible controls.		*'''control:''' The control you wish to check. See [[control names]] for a list of possible controls.
			</section>

			<section name="Client" class="client" show="true">
			<syntaxhighlight lang="lua">bool isControlEnabled ( string control ) </syntaxhighlight>

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


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

Ransom at 06:34, 11 October 2007

2007-10-11T06:34:05Z

← Older revision		Revision as of 06:34, 11 October 2007
Line 16:		Line 16:

	==Example==		==Example==
	<syntaxhighlight lang="lua">		<section name="Example 1" class="server" show="true">
	--~~This line does~~...		This example uses a command handler to allow a player to toggle whether he can use vehicle weapons by disabling or enabling the primary and secondary vehicle fire keys. The command handler is trigged with 'toggleweapons'
	~~blabhalbalhb --abababa~~		<syntaxhighlight lang="lua">function changeWeaponControls ( player, commandName )
	--~~This line does this~~...		--Check to see if the player can use primary/secondary vehicle fire controls
	~~mooo~~		primaryWeaponControl = isControlEnabled ( player, "vehicle_fire" )
	</syntaxhighlight>		secondaryWeaponControl = isControlEnabled ( player, "vehicle_secondary_fire" )
			--Toggle the use of the primary vehicle fire control ability.
			if ( primaryWeaponControl == true ) then
			toggleControl ( player, "vehicle_fire", false )
			outputChatBox ( "Disabled your ability to use primary vehicle weapons." )
			else
			toggleControl ( player, "vehicle_fire", true )
			outputChatBox ( "Enabled your ability to use primary vehicle weapons." )
			end
			--Toggle the use of the secondar vehicle fire control ability.
			if ( secondaryWeaponControl == true ) then
			toggleControl ( player, "vehicle_secondary_fire", false )
			outputChatBox ( "Disabled your ability to use secondary vehicle weapons." )
			else
			toggleControl ( player, "vehicle_secondary_fire", true )
			outputChatBox ( "Enabled your ability to use secondary vehicle weapons." )
			end
			end
			addCommandHandler ( "toggleweapons", changeWeaponControls )</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Input functions}}		{{Input functions}}
	~~[[Category:Incomplete]] -- leave this unless you complete the function~~

Jbeta at 23:56, 27 August 2007

2007-08-27T23:56:03Z

← Older revision		Revision as of 23:56, 27 August 2007
Line 24:		Line 24:

	==See Also==		==See Also==
	~~<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->~~
	{{Input functions}}		{{Input functions}}
	[[Category:Incomplete]] -- leave this unless you complete the function		[[Category:Incomplete]] -- leave this unless you complete the function

Jbeta at 23:55, 27 August 2007

2007-08-27T23:55:50Z

← Older revision		Revision as of 23:55, 27 August 2007
Line 25:		Line 25:
	==See Also==		==See Also==
	<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->		<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
	{{~~FunctionArea_functions~~}}		{{Input functions}}
	[[Category:Incomplete]] -- leave this unless you complete the function		[[Category:Incomplete]] -- leave this unless you complete the function

Arc at 15:48, 17 August 2007

2007-08-17T15:48:45Z

← Older revision		Revision as of 15:48, 17 August 2007
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool isControlEnabled ( player ~~theplayer~~, string control )		bool isControlEnabled ( player thePlayer, string control )
	</syntaxhighlight>		</syntaxhighlight>

Arc at 15:48, 17 August 2007

2007-08-17T15:48:32Z

← Older revision		Revision as of 15:48, 17 August 2007
Line 1:		Line 1:
	__NOTOC__		{{Server client function}}
			__NOTOC__
	Checks whether a GTA control is enabled or disabled for a certain player.		Checks whether a GTA control is enabled or disabled for a certain player.

Black Dragon at 14:43, 20 June 2007

2007-06-20T14:43:28Z

← Older revision		Revision as of 14:43, 20 June 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	~~<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->~~		Checks whether a GTA control is enabled or disabled for a certain player.
	~~This fake function~~ is for ~~use with blah & blah and does blahblahblabhalbhl~~

	==Syntax==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool isControlEnabled ( player theplayer, string (control) )		bool isControlEnabled ( player theplayer, string control )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	~~<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->~~		*'''thePlayer:''' The player you wish the control status of.
	*'''~~argumentName~~:''' ~~description~~		*'''control:''' The control you wish to check. See [[control names]] for a list of possible controls.

	~~<!-- Only include this section below if there are optional arguments -->~~
	~~===Optional Arguments===~~
	~~{{OptionalArg}}~~
	*'''~~argumentName2~~:''' ~~description~~
	*'''argumentName3:''' description

	===Returns===		===Returns===
	~~<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->~~		Returns ''true'' if control is enabled, ''false'' otherwise.
	Returns ''true'' if ~~blah~~, ''false'' otherwise.

	==Example==		==Example==
	~~<!-- Explain what the example is in a single sentance -->~~
	~~This example does...~~
	~~<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--This line does...		--This line does...

Ransom at 23:11, 11 April 2007

2007-04-11T23:11:50Z

← Older revision		Revision as of 23:11, 11 April 2007
Line 6:		Line 6:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~returnType functionName~~ ( ~~arguments~~ )		bool isControlEnabled ( player theplayer, string (control) )
	</syntaxhighlight>		</syntaxhighlight>

Line 37:		Line 37:
	<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->		<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
	{{FunctionArea_functions}}		{{FunctionArea_functions}}
	~~[[Category:Need_Syntax]] -- leave this until syntax is available. Cannot document the function or event without syntax.~~
	[[Category:Incomplete]] -- leave this unless you complete the function		[[Category:Incomplete]] -- leave this unless you complete the function

Ransom at 22:50, 11 April 2007

2007-04-11T22:50:32Z

New page

__NOTOC__

This fake function is for use with blah & blah and does blahblahblabhalbhl

==Syntax==

<syntaxhighlight lang="lua">
returnType functionName ( arguments )
</syntaxhighlight>

===Required Arguments===

*'''argumentName:''' description


===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description

===Returns===

Returns ''true'' if blah, ''false'' otherwise.

==Example==

This example does...

<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==

{{FunctionArea_functions}}
[[Category:Need_Syntax]] -- leave this until syntax is available. Cannot document the function or event without syntax.
[[Category:Incomplete]] -- leave this unless you complete the function