Engine:CCMD bind - Revision history

Bear at 04:28, 15 October 2023

2023-10-15T04:28:26Z

← Older revision		Revision as of 04:28, 15 October 2023
Line 8:		Line 8:

	== Associations ==		== Associations ==
	*Key bindings are global, and not a part of any context.		* Key bindings are global, and not a part of any context.

	== Details ==		== Details ==

2023-10-15T01:39:04Z

Key states

← Older revision		Revision as of 01:39, 15 October 2023
Line 39:		Line 39:

	=== Key states ===		=== Key states ===
	* '+zoom' called without a value. No command, variable or alias named '~~bob~~' exist.		* '+zoom' called without a value. No command, variable or alias named '+zoom' exist.
	<kua>		<kua>
	> +zoom		> +zoom

2023-10-15T01:35:26Z

Examples

← Older revision		Revision as of 01:35, 15 October 2023
Line 39:		Line 39:

	=== Key states ===		=== Key states ===
	* '~~bob~~' called without a value. No command, variable or alias named 'bob' exist.		* '+zoom' called without a value. No command, variable or alias named 'bob' exist.
	<kua>		<kua>
	> ~~bob~~		> +zoom
	Unknown: ~~bob~~		Unknown: +zoom
	</kua>		</kua>
	* Create an alias '~~bob~~' and ~~set to~~ '~~fred~~'.		* Create an alias for '+zoom' and '-zoom'.
	<kua>		<kua>
	> alias ~~bob fred~~		> alias +zoom "set fov 45; print 'zoom is 45'"
			> alias -zoom "set fov 90; print 'zoom is 90'"
	</kua>		</kua>
	* ~~Same as~~ the ~~first example, but now alias~~ '~~bob~~' ~~exists. The 'fred' command in the 'bob' alias script runs, and 'fred' doesn't exist~~.		* Create a binding for the 'Z' key.
	<kua>		<kua>
	> ~~bob~~		> bind Z +zoom
	~~Unknown: fred~~
	</kua>		</kua>
	* ~~Create variable~~ '~~fred~~'.		* Close console and press and release the 'Z' key. Zooms in and out and prints zoom messages.
	<kua>		<kua>
	~~> var fred james~~		zoom is 45
	~~</kua>~~		zoom is 90
	* Run 'bob'
	~~<kua>~~
	~~> bob~~
	~~'fred'~~ is ~~'james'~~
	~~</kua>~~
	* Try to set 'fred' through 'bob'. Value remains the same because 'bob' is only the statement "fred".
	~~<kua>~~
	~~> bob alan~~
	~~> bob~~
	~~'fred'~~ is ~~'james'~~
	</kua>		</kua>

	== Notes ==		== Notes ==
	*		*

2023-10-15T01:27:22Z

Details

← Older revision		Revision as of 01:27, 15 October 2023
Line 13:		Line 13:
	A 'bind' acts like a custom command for a key. It runs the assigned text as a script, which can contain a single-word command, statement, or script.		A 'bind' acts like a custom command for a key. It runs the assigned text as a script, which can contain a single-word command, statement, or script.

	By default, binds do not work while input is in console or in text mode.		By default, binds do not work while input focus is in console or in text mode.

	Binds have a special relationship with commands and aliases, where specially named commands will get run during special key or device states. For example, if an alias is named '+bob' and is bound to a key, it will only get called when that key is pressed down, and if named '-bob' will get called when the key goes up.		Binds have a special relationship with commands and aliases, where specially named commands will get run during special key or device states. For example, if an alias is named '+bob' and is bound to a key, it will only get called when that key is pressed down, and if named '-bob' will get called when the key goes up.

2023-10-15T01:26:44Z

Details

← Older revision		Revision as of 01:26, 15 October 2023
Line 15:		Line 15:
	By default, binds do not work while input is in console or in text mode.		By default, binds do not work while input is in console or in text mode.

	Binds have a special relationship with commands and aliases, where specially named commands will get run during special key or device states. For example, an alias named '+bob' ~~that~~ is bound to a key, will only get called when that key is pressed down, and if named '-bob' will get called when the key goes up.		Binds have a special relationship with commands and aliases, where specially named commands will get run during special key or device states. For example, if an alias is named '+bob' and is bound to a key, it will only get called when that key is pressed down, and if named '-bob' will get called when the key goes up.

	== Examples ==		== Examples ==

2023-10-15T01:26:10Z

Details

← Older revision		Revision as of 01:26, 15 October 2023
Line 13:		Line 13:
	A 'bind' acts like a custom command for a key. It runs the assigned text as a script, which can contain a single-word command, statement, or script.		A 'bind' acts like a custom command for a key. It runs the assigned text as a script, which can contain a single-word command, statement, or script.

	By default, binds do not work while input is in console or in text mode.		By default, binds do not work while input is in console or in text mode.

			Binds have a special relationship with commands and aliases, where specially named commands will get run during special key or device states. For example, an alias named '+bob' that is bound to a key, will only get called when that key is pressed down, and if named '-bob' will get called when the key goes up.

	== Examples ==		== Examples ==

2023-10-15T01:21:29Z

To a variable

← Older revision		Revision as of 01:21, 15 October 2023
Line 36:		Line 36:
	</kua>		</kua>

	=== ~~To a variable~~ ===		=== Key states ===
	* 'bob' called without a value. No command, variable or alias named 'bob' exist.		* 'bob' called without a value. No command, variable or alias named 'bob' exist.
	<kua>		<kua>

2023-10-15T01:20:55Z

Default values

← Older revision		Revision as of 01:20, 15 October 2023
Line 30:		Line 30:
	fred		fred
	</kua>		</kua>
	* Same as the first example, but now bind 'Z' exists and shows the value ~~of the bind 'Z'~~		* Same as the first example, but now bind 'Z' exists and shows the value.
	<kua>		<kua>
	> alias bob		> alias bob

2023-10-15T01:20:34Z

Default values

← Older revision		Revision as of 01:20, 15 October 2023
Line 22:		Line 22:
	Unknown: Z		Unknown: Z
	</kua>		</kua>
	* Create a bind for Z key ~~to echo 'fred'~~.		* Create a bind for the 'Z' key.
	<kua>		<kua>
	> bind Z "echo fred"		> bind Z "echo fred"

2023-10-15T01:19:46Z

Default values

← Older revision		Revision as of 01:19, 15 October 2023
Line 17:		Line 17:
	== Examples ==		== Examples ==
	=== Default values ===		=== Default values ===
	* Check ~~alias~~ '~~bob~~' for script value. No ~~alias~~ exists ~~named~~ '~~bob~~'.		* Check bind 'Z' for script value. No bind exists for key 'Z'.
	<kua>		<kua>
	> bind Z		> bind Z
	Unknown: ~~bob~~		Unknown: Z
	</kua>		</kua>
	* ~~Call~~ '~~bob~~'~~. No command, variable or alias named 'bob' exist~~.		* Create a bind for Z key to echo 'fred'.
	<kua>		<kua>
	> ~~bob~~		> bind Z "echo fred"
	~~Unknown: bob~~
	</kua>		</kua>
	* ~~Create an alias~~ '~~bob~~' ~~and set to~~ '~~echo~~ fred'.		* Close console and press 'Z' key. Prints 'fred'.
	<kua>		<kua>
	~~> alias bob "echo fred"~~
	~~</kua>~~
	* Same as the second example, but now alias 'bob' exists. The 'echo' command in the 'bob' alias script runs, and prints 'fred'.
	~~<kua>~~
	~~> bob~~
	fred		fred
	</kua>		</kua>
	* Same as the first example, but now ~~alias~~ '~~bob~~' exists and shows the value of the ~~alias~~ '~~bob~~'		* Same as the first example, but now bind 'Z' exists and shows the value of the bind 'Z'
	<kua>		<kua>
	> alias bob		> alias bob