Engine:CCMD alias

Revision as of 21:17, 14 October 2023 by Bear (talk | contribs) (→‎Details)
Console commands

Creates a new alias wiht a callable script in the current context, replacing existing alias if any.

alias bob "echo fred"

Arguments

  • name - name for the new alias
  • value - script string or command to set as alias

Details

An 'alias' acts like a custom command. It runs the assigned text as a script, which can contain a single-word command, statement, or script. Is used to create a custom command in the current context.

Aliases do not take any parameters and will run the command, statement, or script verbatim. If for example, an alias named 'bob' is set to 'echo', it will always run exactly 'echo' which will print nothing, even if you run 'bob "some text". The second parameter will be ignored.

Thus, aliases act like simple static macros. But when run they can do anything a script run by any other means could do. And because aliases are treated like commands, they can have direct key bindings.

Examples

Default values

  • 'bob' called without a value. No command, variable or alias named 'bob' exist.
> bob
Unknown: bob
  • Creates an alias 'bob' and sets to 'echo fred'.
> alias bob "echo fred"
  • Same as the first example, but now alias 'bob' exists. The 'echo' command in the 'bob' alias script runs, and prints 'fred'.
> bob
fred

To a variable

  • 'bob' called without a value. No command, variable or alias named 'bob' exist.
> bob
Unknown: bob
  • Create an alias 'bob' and set to 'fred'.
> alias bob fred
  • Same as the first example, but now alias 'bob' exists. The 'fred' command in the 'bob' alias script runs, and 'fred' doesn't exist.
> bob
Unknown: fred
  • Create variable 'fred'.
> var fred james
  • Run 'bob'
> bob
'fred' is 'james'
  • Try to set 'fred' through 'bob'. Value remains the same because 'bob' is only the statement "fred".
> bob alan
> bob
'fred' is 'james'

Notes