TextureXList
The
Constants
Name | Value | Description |
---|---|---|
FORMAT_NORMAL |
0 | Doom TEXTUREx format |
FORMAT_STRIFE11 |
1 | Strife TEXTUREx format |
FORMAT_NAMELESS |
2 | Doom Alpha nameless format |
FORMAT_TEXTURES |
3 | ZDoom TEXTURES format |
FORMAT_JAGUAR |
4 | Jaguar Doom TEXTUREx format |
Properties
Property | Type | Description |
---|---|---|
All textures in the list | ||
The format of this list (see FORMAT_ constants) |
||
The name of the list |
Constructors
Creates a new, empty list with FORMAT_NORMAL
.
Creates a new, empty list of the given
Parameters
format (integer ): The format of the list (seeFORMAT_
constants)
Functions
Overview
General
Texture List Modification
Read/Write
Texture
Gets the texture in the list matching
Parameters
name (string ): The name of the texture to get
Returns
CTexture : The first texture found in the list withname , ornil
if not found
TextureIndex
Gets the index of the texture in the list matching
Parameters
name (string ): The name of the texture
Returns
integer : The index of the first texture found in the list withname , or-1
if not found
ConvertToTEXTURES
Converts all textures in the list to extended format.
Returns
boolean :true
on success,false
if the list was already inTEXTURES
format
Notes
This will set FORMAT_TEXTURES
.
FindErrors
Finds and logs any errors in the texture list.
Returns
boolean :true
if any errors were found
AddTexture
Adds a new texture to the list.
Parameters
name (string ): The name of the new texture[extended] (boolean ): Iftrue
, the new texture will be in ZDoomTEXTURES
format. Default isfalse
[position] (integer ): The position the new texture should be added in the list. Default is0
, which will add to the end of the list
Returns
CTexture : The newly created texture
RemoveTexture
Removes the texture at
Parameters
position (integer ): The position of the texture to remove
SwapTextures
Swaps the textures at
Parameters
position1 (integer ): The position of the first texture to swapposition2 (integer ): The position of the second texture to swap
Clear
Removes all textures from the list.
RemovePatch
Removes
Parameters
patch (string ): The name of the patch to be removed
ReadTEXTUREXData
Reads a Doom-format TEXTUREx
entry.
Parameters
entry (ArchiveEntry ): The entry to read the data frompatchTable (PatchTable ): The patch table (PNAMES) to use for patch namesadditive (boolean ): Iftrue
, textures are added to the current list, otherwise all textures are cleared first
Returns
boolean :true
on success
Notes
This will set
WriteTEXTUREXData
Writes the list in Doom TEXTUREx
format to
Parameters
entry (ArchiveEntry ): The entry to write the data topatchTable (PatchTable ): The patch table (PNAMES) to use for patch names
Returns
boolean :true
on success
ReadTEXTURESData
Reads ZDoom TEXTURES
data from
Parameters
entry (ArchiveEntry ): The entry to read data from
Returns
boolean :true
on success
WriteTEXTURESData
Writes the list in ZDoom TEXURES
format to
Parameters
entry (ArchiveEntry ): The entry to write data to
Returns
boolean :true
on success