Exec commands - Revision history

Eliot: /* Texture Import */

2010-06-22T16:38:24Z

‎Texture Import

Eliot: Add type to parameters, and is as well useful to mapping.

2010-06-21T09:37:40Z

Add type to parameters, and is as well useful to mapping.

Wormbo at 19:26, 20 June 2010

2010-06-20T19:26:13Z

Wormbo: initial pass

2010-06-20T12:58:00Z

initial pass

New page

This article lists commands that can be used with the '''#exec''' [[compiler directive]]. This directive exists in Unreal Engine 1 and 2, but available commands vary between engine generations or even games. Most of these commands will load or import resources during the compile process. All of these commands can be used on the [[UnrealEd]] console as well, but some may behave slightly different there.

All commands described here have one or more parameters in the form "paramname=value". Each parameter should only be specified once, but the order in which parameters appear does not matter. Most parameters can be omitted, but some are mandatory. While most optional parameters have a default value, some of them trigger special behavior when omitted, which cannot be specified through a value. Some parameters are boolean, i.e. they are interpreted as on/off switches. These interpret the values "On", "True" (and its localized version) or "1" as enabled and all other values as disabled.

==Sounds==
===audio import===
Imports a [[wp:WAV|WAV]] file as [[Sound]]. The sound file must be in uncompressed PCM format (no ADPCM or other compressed format), 8 or 16 bits per sample and mono (1 channel).

Parameters:
;File: The WAV file to import.
;Package (optional): The package to import the sound to. Defaults to the package to compile. You shouldn't use this parameter in #exec directives.
;Group (optional): If specified, the sound is imported into this group, otherwise it ends up outside any groups.
;Name (optional): The target name for the imported sound. Defaults to the WAV file name without path and file extension.

==Textures==
===texture import===
Imports an image file as [[Texture]]. Images must have dimensions that are both [[wp:power (mathematics)|power]]s of 2. Supported formats depend on the engine version, but generally [[Unreal Engine 1]] only supports 8 bit (256 colors) formats. 16 bit grayscale formats are used for terrain height maps, so they might not be useful for #exec directives. Most image editing programs don't understand 16 bit grayscale formats correctly and interpret them as 16 bit color formats instead.

Supported formats in [[Unreal Engine 2]]:
* [[wp:BMP file format|BMP]]; 8 bit palette (256 colors), 24 bit RGB or 16 bit grayscale; RLE and other compression type are not supported
* [[wp:PCX|PCX]]; 8 bits per plane and either 1 (256 colors) or 3 (RGB) planes; RLE compression is expected
* [[wp:Truevision TGA|TGA]]; 24 bit RGB, 32 bit RGBA or 16 bit grayscale; uncompressed or RLE
* [[wp:DirectDraw Surface|DDS]]; only [[wp:S3 Texture Compression|DXT]] 1, 3 or 5
* UPT (UPaint format)

Parameters (all optional except File):
;File: The image file to import.
;Package: The package to import the texture to. Defaults to the package to compile. You shouldn't use this parameter in #exec directives.
;Group: If specified, the texture is imported into this group, otherwise it ends up outside any groups.
;Name: The target name for the imported texture. Defaults to the image file name without path and file extension.
;Mips (boolean): Whether to generate [[wp:mipmap|mipmap]]s for the texture. Defaults to On.
;LODSet: Which LOD set to use for the texture. Defaults to 1, i.e. LODSET_World. Values correspond to the [[Typecasting#byte to...|numeric representation]] of the values of the {{classgames|ELODSet}} enum.
;Alpha/AlphaTexture (boolean): Whether the texture should use its alpha channel for transparency by default. Defaults to Off.
;NormalLOD: ''???''
;Masked (boolean): Whether the texture should be masked, i.e. have completely transparent parts, while everything else is completely opaque. UE1 uses palette index 0 as mask, UE2 checks the alpha channel for more than 50% transparency. Defaults to Off.
;Modulated (boolean): Forces mipmap creation using a 50% gray border color. This should be used e.g. for modulated decals. Defaults to Off.
;Additive (boolean): Forces mipmap creation with a black border color. Defaults to Off.
;Next: Specifies the next texture in an animated texture sequence. If the name of imported textures end in "_a??" where ?? stands for a 2-digit number, this property is filled automatically.
;DXT: If specified as 1, 3 or 5, the texture is compressed using DXT1, DXT3 or DXT5 respectively. Compression will respect the Modulated or Additive parameters to fade out generated mipmaps to gray or black respectively and apply corresponding border colors.
;AlphaTrick (boolean): Only for textures with a palette. Copies the blue value over to the alpha value. Defaults to Off. (Usually you will want to use a DXT5 texture with an alpha channel instead as it has the same size as an 8 bit texture, while providing greater flexibility.)
;UClampMode, VClampMode: Sets the corresponding clamp mode to "clamp" or "wrap". Wrapped textures repeat when applied to a larger surface, clamped textures just repeat their border pixels. Defaults to "wrap".

==Animations==
{{sectstub}}

==StaticMeshes==
{{sectstub}}

==Other==
{{sectstub}}
===load===
Short for [[#obj load|obj load]].

===obj load===
Loads an existing package file, optionally under a different name. If a package is loaded under the name of the package to compile, its content will be saved in the compiled package.

Examples:
<uscript>
#exec obj load file=..\Sounds\Announcer.uax // ensures the Announcer sounds are loaded
#exec obj load file=MySkins.utx package=MyMod.Skins // loads the MySkins.utx package and places its content in the Skins group of the MyMod package
</uscript>

[[Category:Programming articles]]

@@ Line 52: / Line 52: @@
 ; ''[[Byte]]'' DXT: If specified as 1, 3 or 5, the texture is compressed using DXT1, DXT3 or DXT5 respectively. Compression will respect the Modulated or Additive parameters to fade out generated mipmaps to gray or black respectively and apply corresponding border colors.
 ; ''[[Bool]]'' AlphaTrick: Only for textures with a palette. Copies the blue value over to the alpha value. Defaults to Off. (Usually you will want to use a DXT5 texture with an alpha channel instead as it has the same size as an 8 bit texture, while providing greater flexibility.)
-; ''[[Int]]'' UClampMode, VClampMode: Sets the corresponding clamp mode to "clamp" or "wrap". Wrapped textures repeat when applied to a larger surface, clamped textures just repeat their border pixels. Defaults to "wrap".
+; ''[[Byte]]'' UClampMode, VClampMode: Sets the corresponding clamp mode to "clamp" or "wrap". Wrapped textures repeat when applied to a larger surface, clamped textures just repeat their border pixels. Defaults to "wrap".
 [[Category:Programming articles]] [[Category:Mapping articles]]

@@ Line 3: / Line 3: @@
 All commands described here have one or more parameters in the form "paramname=value". Each parameter should only be specified once, but the order in which parameters appear does not matter. Most parameters can be omitted, but some are mandatory. While most optional parameters have a default value, some of them trigger special behavior when omitted, which cannot be specified through a value. Some parameters are boolean, i.e. they are interpreted as on/off switches. These interpret the values "On", "True" (and its localized version) or "1" as enabled and all other values as disabled.
 {{expand}}
 ==Audio Import==
 Imports a [[wp:WAV|WAV]] file as [[Sound]]. The sound file must be in uncompressed PCM format (no ADPCM or other compressed format), 8 or 16 bits per sample and mono (1 channel).
 Parameters:
-;File: The WAV file to import.
+; ''[[String]]'' File: The WAV file to import.
-;Package (optional): The package to import the sound to. Defaults to the package to compile. You shouldn't use this parameter in #exec directives.
+; ''[[Name]]'' Package (optional): The package to import the sound to. Defaults to the package to compile. You shouldn't use this parameter in #exec directives.
-;Group (optional): If specified, the sound is imported into this group, otherwise it ends up outside any groups.
+; ''[[Name]]'' Group (optional): If specified, the sound is imported into this group, otherwise it ends up outside any groups.
-;Name (optional): The target name for the imported sound. Defaults to the WAV file name without path and file extension.
+; ''[[Name]]'' Name (optional): The target name for the imported sound. Defaults to the WAV file name without path and file extension.
 ==Load==
@@ Line 35: / Line 38: @@
 Parameters (all optional except File):
-;File: The image file to import.
+; ''[[String]]'' File: The image file to import.
-;Package: The package to import the texture to. Defaults to the package to compile. You shouldn't use this parameter in #exec directives.
+; ''[[Name]]'' Package: The package to import the texture to. Defaults to the package to compile. You shouldn't use this parameter in #exec directives.
-;Group: If specified, the texture is imported into this group, otherwise it ends up outside any groups.
+; ''[[Name]]'' Group: If specified, the texture is imported into this group, otherwise it ends up outside any groups.
-;Name: The target name for the imported texture. Defaults to the image file name without path and file extension.
+; ''[[Name]]'' Name: The target name for the imported texture. Defaults to the image file name without path and file extension.
-;Mips (boolean): Whether to generate [[wp:mipmap|mipmap]]s for the texture. Defaults to On.
+; ''[[Bool]]'' Mips: Whether to generate [[wp:mipmap|mipmap]]s for the texture. Defaults to On.
-;LODSet: Which LOD set to use for the texture. Defaults to 1, i.e. LODSET_World. Values correspond to the [[Typecasting#byte to...|numeric representation]] of the values of the {{classgames|ELODSet}} enum.
+; ''[[Byte]]'' LODSet: Which LOD set to use for the texture. Defaults to 1, i.e. LODSET_World. Values correspond to the [[Typecasting#byte to...|numeric representation]] of the values of the {{classgames|ELODSet}} enum.
-;Alpha/AlphaTexture (boolean): Whether the texture should use its alpha channel for transparency by default. Defaults to Off.
+; ''[[Bool]]'' Alpha/AlphaTexture: Whether the texture should use its alpha channel for transparency by default. Defaults to Off.
-;NormalLOD: ''???''
+; ''[[Byte]]'' NormalLOD: ''???''
-;Masked (boolean): Whether the texture should be masked, i.e. have completely transparent parts, while everything else is completely opaque. UE1 uses palette index 0 as mask, UE2 checks the alpha channel for more than 50% transparency. Defaults to Off.
+; ''[[Bool]]'' Masked: Whether the texture should be masked, i.e. have completely transparent parts, while everything else is completely opaque. UE1 uses palette index 0 as mask, UE2 checks the alpha channel for more than 50% transparency. Defaults to Off.
-;Modulated (boolean): Forces mipmap creation using a 50% gray border color. This should be used e.g. for modulated decals. Defaults to Off.
+; ''[[Bool]]'' Modulated: Forces mipmap creation using a 50% gray border color. This should be used e.g. for modulated decals. Defaults to Off.
-;Additive (boolean): Forces mipmap creation with a black border color. Defaults to Off.
+; ''[[Bool]]'' Additive: Forces mipmap creation with a black border color. Defaults to Off.
-;Next: Specifies the next texture in an animated texture sequence. If the name of imported textures end in "_a??" where ?? stands for a 2-digit number, this property is filled automatically.
+; ''[[Name]]'' Next: Specifies the next texture in an animated texture sequence. If the name of imported textures end in "_a??" where ?? stands for a 2-digit number, this property is filled automatically.
-;DXT: If specified as 1, 3 or 5, the texture is compressed using DXT1, DXT3 or DXT5 respectively. Compression will respect the Modulated or Additive parameters to fade out generated mipmaps to gray or black respectively and apply corresponding border colors.
+; ''[[Byte]]'' DXT: If specified as 1, 3 or 5, the texture is compressed using DXT1, DXT3 or DXT5 respectively. Compression will respect the Modulated or Additive parameters to fade out generated mipmaps to gray or black respectively and apply corresponding border colors.
-;AlphaTrick (boolean): Only for textures with a palette. Copies the blue value over to the alpha value. Defaults to Off. (Usually you will want to use a DXT5 texture with an alpha channel instead as it has the same size as an 8 bit texture, while providing greater flexibility.)
+; ''[[Bool]]'' AlphaTrick: Only for textures with a palette. Copies the blue value over to the alpha value. Defaults to Off. (Usually you will want to use a DXT5 texture with an alpha channel instead as it has the same size as an 8 bit texture, while providing greater flexibility.)
-;UClampMode, VClampMode: Sets the corresponding clamp mode to "clamp" or "wrap". Wrapped textures repeat when applied to a larger surface, clamped textures just repeat their border pixels. Defaults to "wrap".
+; ''[[Int]]'' UClampMode, VClampMode: Sets the corresponding clamp mode to "clamp" or "wrap". Wrapped textures repeat when applied to a larger surface, clamped textures just repeat their border pixels. Defaults to "wrap".
-[[Category:Programming articles]]
+[[Category:Programming articles]] [[Category:Mapping articles]]