Console commands
AwakenDebug adds console variables and console commands to Unreal. Enter them in the in-game console or the editor’s console. This page lists each one with its values and default.
Console variables
| Variable | Values | Default | Effect |
|---|---|---|---|
Awaken.Debug | 0 or 1 | 0 | 1 shows the in-game panel, or the text HUD, in the game view. 0 hides it. F10 toggles the same variable, and the panel’s Hide button sets it to 0. |
Awaken.Renderer | egui or canvas | egui | Which renderer draws it. egui is the in-game panel and is used when the egui library is built. canvas is the text HUD. |
Awaken.Debug.Scale | 0, or 0.5 to 4 | 0 | Scale of either renderer. 0 chooses the scale from the view height. A value from 0.5 to 4 is used as given. |
Awaken.Egui.ShowCursor | 0 or 1 | 1 | 1 shows the mouse cursor while the in-game panel is open, and puts the game’s setting back when the panel closes. 0 leaves the cursor to the game. |
Awaken.Publish | 0 or 1 | 1 | 1 writes the NPC file while the game runs. 0 stops the writing and deletes the file. Shipping builds never write. |
Console commands
| Command | Arguments | Effect |
|---|---|---|
Awaken.Select | An NPC id, next or prev. With no argument: next. | Chooses the NPC whose details the HUD shows. |
Awaken.Egui.Stats | None | Logs what the in-game panel costs a frame and what it draws. |
Awaken.Egui.Pointer | move, down, up or click, then x and y | Sends a left-button event at a pixel of the game view. For scripted checks that must not move the real cursor. |
Awaken.Dump | None | Logs every registered NPC of the running game under LogAwakenDebug: status, goal, goal list, blackboard and tree. |
Not yet verified
Awaken.Dump has not been checked with live rows.
Keys
These keys work while a game or Play In Editor session has focus.
| Key | Effect |
|---|---|
| F10 | Show or hide the in-game panel or the text HUD. |
| Page Down | Select the next NPC, while the panel or the HUD is shown. |
| Page Up | Select the previous NPC, while the panel or the HUD is shown. |
Examples
Show the HUD and select an NPC by id:
Awaken.Debug 1
Awaken.Select guard-1Make the HUD text one and a half times as large:
Awaken.Debug.Scale 1.5Stop publishing the NPC file for this session:
Awaken.Publish 0Set a value at start-up
Run commands when the game starts with -ExecCmds:
UnrealEditor MyGame.uproject -game -windowed -ExecCmds="Awaken.Debug 1"Start a game with publishing off, from the command line:
UnrealEditor MyGame.uproject -game -ini:Engine:[ConsoleVariables]:Awaken.Publish=0Or set it for the project:
Config/DefaultEngine.ini
[ConsoleVariables]
Awaken.Publish=0Next steps
- In-game panel, HUD and debugger.
- The NPC file, which
Awaken.Publishcontrols.
Last updated on