Skip to content

Pattern — Terminal Command

Terminal commands are UObject classes parented to UOperatingSystemTerminalCommand. The bundled BP_CMD_Help is the canonical Blueprint graph to study and duplicate.

flowchart LR
  Event["Event: On Process Command"] --> Logic["Internal_DisplayHelp<br/><i>your logic here</i>"]
  Logic --> Finish["Finish Command"]

Bundled command reference

Asset	Main Command	Path
`BP_CMD_Help`	`help`	`Shared/Blueprints/TerminalCommands/`
`BP_CMD_Clear`	`clear`	`Shared/Blueprints/TerminalCommands/`
`BP_CMD_Cd`	`cd`	`Shared/Blueprints/TerminalCommands/`
`BP_CMD_Pwd`	`pwd`	`Shared/Blueprints/TerminalCommands/`
`BP_CMD_AptGet`	`apt-get`	`Unix/Blueprints/Programs/Terminal/Commands/` (Unix only)

Screenshot callouts

Minimal Blueprint graph

Event On Process Command (Command: String)
  → [Your logic: Append Output, parse args, broadcast messenger]
  → Finish Command (Error If Any: empty)

Node	Purpose
Get Command Parameters	Arguments after the command name
Append String to Parent Terminal Output	Write to terminal screen
Finish Command	Signal completion
Broadcast Message (Global Messenger)	Bridge to level actors

C++ equivalent

void UCMD_MyCommand::OnProcessCommand()
{
    if (UOperatingSystemTerminal* Term = ParentTerminal.Get())
    {
        Term->AppendOutput(TEXT("Done."));
    }
    FinishCommand(FGenericError());
}