Lump Types - BSPSource

Lumps are the fundamental data containers in BSP files, organizing different types of map data into discrete sections.

Lump

Default lump type for lumps inside a BSP file.

Constructor

Lump(int index, LumpType type)
Lump(LumpType type)

Creates a new lump with the specified index and type. The second constructor uses the type’s default index. Parameters:

index - Position in the lump table
type - The lump type enum value

Methods

Show Core Properties

getName

String getName()

Returns the name of the lump type (e.g., “LUMP_ENTITIES”).

getIndex

int getIndex()

Returns the position of this lump in the BSP file’s lump table.

getType

LumpType getType()

Returns the lump type enumeration.

getParentFile

Path getParentFile()

Returns the path to the parent BSP file.

setParentFile

void setParentFile(Path parentFile)

Sets the parent BSP file path.

Show Data Access

getLength

int getLength()

Returns the number of bytes in this lump. If compressed, returns the uncompressed size.

getBuffer

ByteBuffer getBuffer()

Returns a view of the buffer for this lump. Changes to it are reflected in the lump’s buffer.

setBuffer

void setBuffer(ByteBuffer buf)

Sets the lump data from a ByteBuffer.

getInputStream

InputStream getInputStream()

Returns an InputStream for reading lump data.

getOutputStream

OutputStream getOutputStream()

Returns an OutputStream for writing lump data.

Show Compression

isCompressed

boolean isCompressed()

Checks if the lump data is LZMA compressed.

setCompressed

void setCompressed(boolean compressed)

Marks the lump as compressed or uncompressed and updates the FourCC accordingly.

compress

void compress()

Compresses the lump data using LZMA compression.

uncompress

void uncompress()

Decompresses the lump data.

Show Versioning

getVersion

int getVersion()

Returns the lump version number.

setVersion

void setVersion(int vers)

Sets the lump version.

getFourCC

int getFourCC()

Returns the FourCC identifier (used for compressed lumps).

setFourCC

void setFourCC(int fourCC)

Sets the FourCC identifier.

LumpType

Enumeration of all lump types used in BSP files across different versions.

Common Lump Types

Show Essential Lumps

Type	Index	Description
`LUMP_ENTITIES`	0	Entity definitions
`LUMP_PLANES`	1	Plane equations
`LUMP_TEXDATA`	2	Texture data
`LUMP_VERTEXES`	3	Vertex positions
`LUMP_VISIBILITY`	4	Visibility data
`LUMP_NODES`	5	BSP tree nodes
`LUMP_TEXINFO`	6	Texture information
`LUMP_FACES`	7	Face definitions
`LUMP_LIGHTING`	8	Lightmap data
`LUMP_LEAFS`	10	BSP tree leaves
`LUMP_EDGES`	12	Edge definitions
`LUMP_SURFEDGES`	13	Surface edge references
`LUMP_MODELS`	14	Brush models

Show Advanced Features

Type	Index	Description
`LUMP_DISPINFO`	26	Displacement surface info
`LUMP_DISP_VERTS`	33	Displacement vertices
`LUMP_GAME_LUMP`	35	Game-specific lumps
`LUMP_PAKFILE`	40	Embedded PAK file
`LUMP_CUBEMAPS`	42	Cubemap samples
`LUMP_OVERLAYS`	45	Overlay decals
`LUMP_BRUSHES`	18	Brush definitions
`LUMP_BRUSHSIDES`	19	Brush side definitions

Show BSP v20+ Lumps

These lumps are specific to BSP version 20 and above:

Type	Index	Version	Description
`LUMP_LIGHTING_HDR`	53	20	HDR lightmap data
`LUMP_FACES_HDR`	58	20	HDR face data
`LUMP_MAP_FLAGS`	59	20	Map compilation flags
`LUMP_OVERLAY_FADES`	60	20	Overlay fade distances
`LUMP_PHYSLEVEL`	62	21	Physics level data
`LUMP_DISP_MULTIBLEND`	63	21	Displacement multiblend

Static Methods

get (by name)

static LumpType get(String name, int bspVersion)
static LumpType get(String name)

Returns the lump type for a given name in a specific BSP version. The version-less variant defaults to BSP v19. Parameters:

name - Lump name (e.g., “LUMP_ENTITIES”)
bspVersion - BSP version to consider for version-specific lumps

Returns:

The matching LumpType, or LUMP_UNKNOWN if not found

get (by index)

static LumpType get(int index, int bspVersion)
static LumpType get(int index)

Returns the lump type for a given index in a specific BSP version. Parameters:

index - Lump table index (0-63)
bspVersion - BSP version to consider

Returns:

The matching LumpType, or LUMP_UNKNOWN if not found

Instance Methods

getIndex

int getIndex()

Returns the position of this lump type in the lump table.

getBspVersion

int getBspVersion()

Returns the first BSP version where this lump type was introduced, or -1 if unknown.

Example Usage

// Get lump type by index
LumpType type = LumpType.get(0); // LUMP_ENTITIES

// Get lump type by name for specific version
LumpType hdrType = LumpType.get("LUMP_LIGHTING_HDR", 20);

// Check version
if (type.getBspVersion() <= bspFile.getVersion()) {
    // This lump type is supported
}

GameLump

Special lump type for game-specific lumps stored inside LUMP_GAME_LUMP.

Methods

getName

String getName()

Returns the name decoded from the FourCC identifier (e.g., “sprp” for static props).

getFlags

int getFlags()

Returns the game lump flags.

setFlags

void setFlags(int flags)

Sets the game lump flags.

setCompressed

void setCompressed(boolean compressed)

Marks the game lump as compressed and sets flags to 1 if compressed, 0 otherwise.

Common Game Lumps

FourCC	Name	Description
`sprp`	Static Props	Static prop placement
`prps`	Prop Names	Static prop model names
`prpl`	Prop Leaves	Static prop leaf associations

LumpFile

Utility for loading and saving individual lumps from .lmp files.

Constructor

LumpFile(BspFile bsp)
LumpFile(int bspVersion)

Parameters:

bsp - Parent BSP file
bspVersion - BSP version for standalone usage

Methods

load

void load(Path file, ByteOrder bo) throws IOException
void load(Path file) throws IOException

Loads a lump from an external .lmp file. The version-less variant uses little-endian byte order. Parameters:

file - Path to the .lmp file
bo - Byte order for reading

save

void save(Path file) throws IOException

Saves the lump to an external .lmp file. Parameters:

file - Path to save the .lmp file

getLump / setLump

Lump getLump()
void setLump(Lump lump)

Gets or sets the lump object.

LMP File Format

The LMP file header (20 bytes):

static final int HEADER_SIZE = 20;

Offset	Type	Field	Description
0	int	lumpOffset	Offset to lump data (usually 20)
4	int	lumpIndex	Lump table index
8	int	lumpVersion	Lump version
12	int	lumpSize	Size of lump data
16	int	mapRevision	Map revision number

Example Usage

// Load an external lump file
LumpFile lumpFile = new LumpFile(20); // BSP version 20
lumpFile.load(Paths.get("maps/mymap_l_0.lmp"));

Lump entitiesLump = lumpFile.getLump();
System.out.println("Loaded lump: " + entitiesLump.getName());
System.out.println("Size: " + entitiesLump.getLength() + " bytes");

Entities

Entity classes and key-value handling

Structs

BSP file structures and data types

Core API

Decompiler Modules

Library

​Lump

​Constructor

​Methods

​getName

​getIndex

​getType

​getParentFile

​setParentFile

​getLength

​getBuffer

​setBuffer

​getInputStream

​getOutputStream

​isCompressed

​setCompressed

​compress

​uncompress

​getVersion

​setVersion

​getFourCC

​setFourCC

​LumpType

​Common Lump Types

​Static Methods

​get (by name)

​get (by index)

​Instance Methods

​getIndex

​getBspVersion

​Example Usage

​GameLump

​Methods

​getName

​getFlags

​setFlags

​setCompressed

​Common Game Lumps

​LumpFile

​Constructor

​Methods

​load

​save

​getLump / setLump

​LMP File Format

​Example Usage

​Related

Entities

Structs

Build docs developers (and LLMs) love

Lump

Constructor

Methods

getName

getIndex

getType

getParentFile

setParentFile

getLength

getBuffer

setBuffer

getInputStream

getOutputStream

isCompressed

setCompressed

compress

uncompress

getVersion

setVersion

getFourCC

setFourCC

LumpType

Common Lump Types

Static Methods

get (by name)

get (by index)

Instance Methods

getIndex

getBspVersion

Example Usage

GameLump

Methods

getName

getFlags

setFlags

setCompressed

Common Game Lumps

LumpFile

Constructor

Methods

load

save

getLump / setLump

LMP File Format

Example Usage

Related