Scripting/Squirrel/Functions/BindKey - Revision history

Thijn at 18:05, 30 January 2017

2017-01-30T18:05:52Z

← Older revision		Revision as of 18:05, 30 January 2017
Line 42:		Line 42:

	{{Scripting/Squirrel/Functions/Game_Functions}}		{{Scripting/Squirrel/Functions/Game_Functions}}
			[[Category:Scripting/Squirrel/Functions/Game_Functions]]

Pun1sh3r at 15:55, 23 April 2016

2016-04-23T15:55:24Z

← Older revision		Revision as of 15:55, 23 April 2016
Line 9:		Line 9:
	*''bool'' '''press''' - This is the bool for the key function to be called once the key is 'pressed' or 'released'		*''bool'' '''press''' - This is the bool for the key function to be called once the key is 'pressed' or 'released'

	*''int'' '''key1''' - The primary key you bind it to, you can get the key codes from [~~http~~://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx\| here]		*''int'' '''key1''' - The primary key you bind it to, you can get the key codes from [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx here]

	*''int'' '''key2''' The second key that needs to be pressed for this bind, or zero if not needed.		*''int'' '''key2''' - The second key that needs to be pressed for this bind, or zero if not needed.

	*''int'' '''key3''' The third key that needs to be pressed for this bind, or zero if not needed.		*''int'' '''key3''' - The third key that needs to be pressed for this bind, or zero if not needed.

	== Example ==		== Example ==

Pun1sh3r at 21:26, 22 April 2016

2016-04-22T21:26:07Z

← Older revision		Revision as of 21:26, 22 April 2016
Line 38:		Line 38:
	* Callbacks [[onScriptLoad]] and [[onKeyDown]] were used in this example. More info about them in the corresponding pages.		* Callbacks [[onScriptLoad]] and [[onKeyDown]] were used in this example. More info about them in the corresponding pages.
	* [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx Virtual Key Codes] — a list of keys and their key codes that can be used for keybinds		* [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx Virtual Key Codes] — a list of keys and their key codes that can be used for keybinds

			== Related Functions ==

			{{Scripting/Squirrel/Functions/Game_Functions}}

Stormeus at 10:43, 9 March 2016

2016-03-09T10:43:07Z

← Older revision		Revision as of 10:43, 9 March 2016
Line 36:		Line 36:
	=== Notes ===		=== Notes ===

	~~Call~~ [[onScriptLoad]] and [[onKeyDown]] were used in this example. More info about them in the corresponding pages.		* Callbacks [[onScriptLoad]] and [[onKeyDown]] were used in this example. More info about them in the corresponding pages.
			* [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx Virtual Key Codes] — a list of keys and their key codes that can be used for keybinds

Stormeus at 10:41, 9 March 2016

2016-03-09T10:41:38Z

← Older revision		Revision as of 10:41, 9 March 2016
Line 1:		Line 1:
			'''BindKey''' allows the server to be informed when a player presses a key or a combination of up to three keys.

	== Syntax ==		== Syntax ==

	<pre>BindKey(press, ~~key~~, ~~args1~~, ~~args2~~)</pre>		<pre>BindKey(press, key1, key2, key3)</pre>

	== Arguments ==		== Arguments ==
Line 7:		Line 9:
	*''bool'' '''press''' - This is the bool for the key function to be called once the key is 'pressed' or 'released'		*''bool'' '''press''' - This is the bool for the key function to be called once the key is 'pressed' or 'released'

	*''int'' '''~~key~~''' - The key you bind it to, you can get the key codes from [http://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx\| here]		*''int'' '''key1''' - The primary key you bind it to, you can get the key codes from [http://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx\| here]

	*''int'' '''~~args1~~''' ~~You can set it~~ to 0		*''int'' '''key2''' The second key that needs to be pressed for this bind, or zero if not needed.

	*''int'' '''~~args2~~''' ~~You can set it~~ to 0		*''int'' '''key3''' The third key that needs to be pressed for this bind, or zero if not needed.

	== Example ==		== Example ==

ProsuWANTED at 14:00, 3 August 2015

2015-08-03T14:00:06Z

← Older revision		Revision as of 14:00, 3 August 2015
Line 1:		Line 1:
	== Syntax ==		== Syntax ==

	BindKey(press, key, args1, args2)		<pre>BindKey(press, key, args1, args2)</pre>

	== Arguments ==		== Arguments ==

ProsuWANTED: Fixed the whole page + some grammar fixes.

2015-07-01T17:13:54Z

Fixed the whole page + some grammar fixes.

← Older revision		Revision as of 17:13, 1 July 2015
Line 1:		Line 1:
	~~'''~~Syntax~~'''~~		== Syntax ==

	BindKey( ~~bool:~~press, key, ~~args...~~, args2~~...~~)		BindKey(press, key, args1, args2)

	~~'''~~Arguments~~'''~~		== Arguments ==

	'''~~bool:~~press''' This is the bool for the key function to be called once the key is 'pressed' or 'released'.		*''bool'' '''press''' - This is the bool for the key function to be called once the key is 'pressed' or 'released'

	'''key''' The key you bind at, you can get key codes from [http://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx ~~Key Codes~~]		*''int'' '''key''' - The key you bind it to, you can get the key codes from [http://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx\| here]

	'''~~args...~~''' You can ~~have this~~ 0.		*''int'' '''args1''' You can set it to 0

	'''args2~~...~~''' You can ~~have this~~ 0.		*''int'' '''args2''' You can set it to 0

	~~'''~~Example~~'''~~		== Example ==

	The following example will bind the left-shift key for player and send him a message when a player ~~press~~ that key:		The following example will bind the left-shift key for a player and will send him a message when he player presses that key:

	<source lang=squirrel>		<source lang=squirrel>
Line 32:		Line 32:
	</source>		</source>

	~~'''~~Notes~~'''~~		=== Notes ===

	Call onScriptLoad, onKeyDown were used in this example. More info about them in the corresponding pages.		Call [[onScriptLoad]] and [[onKeyDown]] were used in this example. More info about them in the corresponding pages.

Doom Killer: How to bind different keys for different actions in game, could be useful, created by Doom_Killer

2015-02-21T10:21:55Z

How to bind different keys for different actions in game, could be useful, created by Doom_Killer

New page

'''Syntax'''

BindKey( bool:press, key, args..., args2...)

'''Arguments'''

'''bool:press''' This is the bool for the key function to be called once the key is 'pressed' or 'released'.

'''key''' The key you bind at, you can get key codes from [http://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx Key Codes]

'''args...''' You can have this 0.

'''args2...''' You can have this 0.

'''Example'''

The following example will bind the left-shift key for player and send him a message when a player press that key:

<source lang=squirrel>
function onScriptLoad()
{
lshift <- BindKey(true, 0xA0, 0, 0);
}

function onKeyDown( player, key )
{
if( key == lshift )
{
MessagePlayer( ">> You pressed the left shift key", player );
}
}
</source>

'''Notes'''

Call onScriptLoad, onKeyDown were used in this example. More info about them in the corresponding pages.