View source for Command Sequences

[[Category:File formats]]

The ''bin/CmdSeq.wc'' file defines the [[Hammer_Run_Map_Expert|expert compilation options]] for Hammer. There are two versions currently in use. All strings are fixed width, with a null character at the end of the used data. Hammer strangely fills the remainder of the data with random memory contents.

<source lang="cpp">struct Header
{
	char signature[31];  // Worldcraft Command Sequences\r\n\x1a
	float version;
	unsigned int seq_count;
	Sequence sequences[];
}
</source>

The signature contains ''"Worldcraft Command Sequences"'', followed by a carriage return, newline, and Control-Z (byte 26). The version is a floating-point number, <code>0.1</code> or <code>0.2</code>. This is followed by ''seq_count'' sequence structs, one for each compile preset defined:

<source lang="cpp">struct Sequence
{
	char name[128];
	unsigned int command_count; // Number of commands
	Command commands[];
}
</source>

Each sequence contains a number of commands:

<source lang="cpp">struct Command
{
	char is_enabled; // 0/1, If command is enabled. NOTE: CS:GO's branch of hammer uses an integer value here instead of a character.
	int special;
	char executable[260]; // Name of EXE to run.
	char args[260]; // Arguments for executable.
	int is_long_filename; // Obsolete, but always set to true. Disables MS-DOS 8-char filenames.
	int ensure_check; // Ensure file post-exists after compilation
	char ensure_file[260]; // File to check exists.
	int use_proc_win; // Use Process Window (ignored if exectuable = $game_exe).

	// V 0.2+ only:
	int no_wait;  // Wait for keypress when done compiling.
}
</source>

If ''special'' is not 0, the executable is not used. Instead a builtin command is run:

{| class="standard-table"
! Value !! Command !! Arguments
|-
| 256
| Change Directory
| <code>Location</code>
|- 
| 257
| Copy File
| <code>Source Destination</code>
|-
| 258
| Delete File
| <code>Path</code>
|-
| 259
| Rename File
| <code>Old New</code>
|}

[[VBSP]], [[VRAD]], [[VVIS]] or the game are normal commands using a replace parameter.

=== Replacement parameters ===
Commnand names and arguments can use a replacement syntax, following the form <code>$var</code>.  These arguments are quoted up until the first space after the parameter (so <code>$file.$ext</code> is quoted in one piece, but <code>$file $ext</code> will produce two sets of surrounding quotes).

{| class="standard-table"
!Parameter !! Result
|- 
| <code>$$</code>
| Literal ''$'' sign.
|-
| <code>$file</code>
| Map filename.
|-
| <code>$ext</code>
| Extension of map (''vmf'', ''vmm'').
|-
| <code>$path</code>
| Full path to folder containing the map, with no trailing slash.
|- 
| <code>$exedir</code>
| Path to the location of the game EXE.
|- 
| <code>$bspdir</code>
| Location to place BSPs in, set in [[Build Programs]].
|-
| <code>$bsp_exe</code>
| Location of [[VBSP]], set in [[Build Programs]].
|-
| <code>$vis_exe</code>
| Location of [[VVIS]], set in [[Build Programs]].
|-
| <code>$light_exe</code>
| Location of [[VRAD]], set in [[Build Programs]].
|-
| <code>$game_exe</code>
| Location of the game executable, set in [[Build Programs]].
|-
| <code>$gamedir</code>
| Folder containing [[Gameinfo.txt]].
|}