Jump to content

WoW:Console: Difference between revisions

From Thunderbrew
No edit summary
No edit summary
Line 1: Line 1:
The console is fundamental to the entire engine. It determines how the [[WoW:GxApi|Graphics API]] is initialized, controls how [[WoW:CVar|configurations]] are set, and allows many features to be toggled or adjusted using [[WoW:Console commands|commands]] without having to quit the game.
The console is fundamental to the entire engine. It determines how the [[WoW:GxApi|Graphics API]] is initialized, controls how [[WoW:CVar|configurations]] are set, and allows many features to be toggled or adjusted using [[WoW:Console#Commands|Commands]] without having to quit the game.


== Commands ==
== Commands ==


A command is a function associated with a string that contains no whitespace. The function accepts the name of the command as a string, as well as an optional argument string. For example, running the following command:
A Command is a whitespace-less string that can be associated with a function. The Command may or may not have a help message, and it may have a [[#Category]].
 
A Command is a function associated with a string that contains no whitespace. The function accepts the name of the command as a string, as well as an optional argument string. For example, running the following command:


<pre>
<pre>
Line 19: Line 21:
</pre>
</pre>


=== Categories ===
=== Category ===


Every [[#Commands|Command]] or [[WoW:CVar]] belongs to a category number.
Every [[#Commands|Command]] or [[WoW:CVar]] belongs to a category number.

Revision as of 20:57, 12 June 2025

The console is fundamental to the entire engine. It determines how the Graphics API is initialized, controls how configurations are set, and allows many features to be toggled or adjusted using Commands without having to quit the game.

Commands

A Command is a whitespace-less string that can be associated with a function. The Command may or may not have a help message, and it may have a #Category.

A Command is a function associated with a string that contains no whitespace. The function accepts the name of the command as a string, as well as an optional argument string. For example, running the following command:

RUN commandname "with argument"

will dispatch a handler function:

int32 handler(const char* command, const char* argument) {
  print(command);  // "commandname"
  print(argument); // "with argument"
  return 1;
}

Category

Every Command or WoW:CVar belongs to a category number.