srctools.cmdseq

Reads and writes Hammer’s compilation configs.

These set the arguments to the compile tools.

class srctools.cmdseq.SpecialCommand

Bases: Enum

Special commands to run instead of the exe.

CHANGE_DIR = 256

COPY_FILE = 257

DELETE_FILE = 258

RENAME_FILE = 259

class srctools.cmdseq.Command( exe: str | SpecialCommand, args: str, *, enabled: bool = True, ensure_file: str | None = None, use_proc_win: bool = True, no_wait: bool = False, )

A command to run.

exe: str | SpecialCommand: Either the path to the executable, or one of several special commands.

args: str: Parameters to pass to the executable or command.

enabled: bool: Whether this command is checked and should run.

ensure_file: str | None: If non-None, the command should fail if this file doesn’t exist after it runs.

use_proc_win: bool: Determines if the command should be executed directly, or captured in the ‘run process’ window. Obsolete for Hammer versions with hammer_run_map_launcher.exe.

no_wait: bool: Indicates whether Hammer should wait for the command to finish before proceeding. Seems nonfunctional.

classmethod parse( is_enabled: int, is_special: int, executable: bytes, args: bytes, is_long_filename: int, ensure_check: bytes, ensure_file: bytes, use_proc_win: int, no_wait: int = 0, ) → Command: Parse the command from the structure in the file.

srctools.cmdseq.parse(file: FileR[bytes]) → dict[str, list[Command]]

Read a list of sequences from a file.

This returns a dict mapping names to a list of sequences.

srctools.cmdseq.write( sequences: dict[str, Sequence[Command]], file: FileWBinary, ) → None: Write commands back to a file.