Types #

All types are contained in df module. They are enums, and they act as bidirectional mappings - in other words, you can refer to the number by the name or the other way around, both are valid. So this comparison (same thing in two alternative syntax versions) evaluates to true:

df.biome_type.TUNDRA == 2
df.biome_type["TUNDRA"] == 2 

and this comparison also evaluates to true:

df.biome_type[2] == "TUNDRA"

To double check that you are referring to the right index/value in the enum, you can also quickly preview the result in the console, using the :lua syntax that lets you run a piece of code written in Lua without having to create a script:

If you have DFHack Lua Definitions installed in VSCodium, your should have type hints for all types.

To browse the types in GM Editor, you can run gui/gm-editor df command, and then press s to be able to search for a type. Press enter to view details about it. You can for example check the first and last index with _first_item and _last_item.

As you can notice in gm-editor screenshot above, to confirm that something in df is indeed an enum, you can check it via ._kind and see if it returns enum-type.

Code snippets #

Iterate over a type and print out the indexes and their corresponding values:

name = "biome_type"

if df[name] and df[name]._kind == "enum-type" then 
  for index = df[name]._first_item , df[name]._last_item do
	if df[name][index] then
	  print(tostring(index).."-"..tostring(df[name][index]))
	end
  end 
end

0-MOUNTAIN
1-GLACIER
2-TUNDRA
3-SWAMP_TEMPERATE_FRESHWATER
4-SWAMP_TEMPERATE_SALTWATER
5-MARSH_TEMPERATE_FRESHWATER
6-MARSH_TEMPERATE_SALTWATER
7-SWAMP_TROPICAL_FRESHWATER
8-SWAMP_TROPICAL_SALTWATER
9-SWAMP_MANGROVE
10-MARSH_TROPICAL_FRESHWATER
11-MARSH_TROPICAL_SALTWATER
12-FOREST_TAIGA
13-FOREST_TEMPERATE_CONIFER
14-FOREST_TEMPERATE_BROADLEAF
15-FOREST_TROPICAL_CONIFER
16-FOREST_TROPICAL_DRY_BROADLEAF
17-FOREST_TROPICAL_MOIST_BROADLEAF
18-GRASSLAND_TEMPERATE
19-SAVANNA_TEMPERATE
20-SHRUBLAND_TEMPERATE
21-GRASSLAND_TROPICAL
22-SAVANNA_TROPICAL
23-SHRUBLAND_TROPICAL
24-DESERT_BADLAND
25-DESERT_ROCK
26-DESERT_SAND
27-OCEAN_TROPICAL
28-OCEAN_TEMPERATE
29-OCEAN_ARCTIC
30-POOL_TEMPERATE_FRESHWATER
31-POOL_TEMPERATE_BRACKISHWATER
32-POOL_TEMPERATE_SALTWATER
33-POOL_TROPICAL_FRESHWATER
34-POOL_TROPICAL_BRACKISHWATER
35-POOL_TROPICAL_SALTWATER
36-LAKE_TEMPERATE_FRESHWATER
37-LAKE_TEMPERATE_BRACKISHWATER
38-LAKE_TEMPERATE_SALTWATER
39-LAKE_TROPICAL_FRESHWATER
40-LAKE_TROPICAL_BRACKISHWATER
41-LAKE_TROPICAL_SALTWATER
42-RIVER_TEMPERATE_FRESHWATER
43-RIVER_TEMPERATE_BRACKISHWATER
44-RIVER_TEMPERATE_SALTWATER
45-RIVER_TROPICAL_FRESHWATER
46-RIVER_TROPICAL_BRACKISHWATER
47-RIVER_TROPICAL_SALTWATER
48-SUBTERRANEAN_WATER
49-SUBTERRANEAN_CHASM
50-SUBTERRANEAN_LAVA

Full df types reference #

Below is the full reference for types in df (that have their name ending with _type), exported automatically with a script from Dwarf Fortress version 51.07. Empty values (nil) have been skipped.

Abstract building order #

Abstract building reputation #

Abstract building #

Action #

Activity entry #

Activity event building role #

Activity event item role #

Activity event #

Adopt region stage #

Adv background option #

Adventure construction mode #

Adventure desire state #

Adventure game loop #

Adventure interface attack mode #

Adventure interface create mode #

Adventure interface inventory context #

Adventure interface option list context #

Adventure inventory option list #

Adventure log event #

Adventure option #

Adventure travel exception #

Adventure work #

Agreement details #

Announcement alert #

Announcement #

Appearance modifier #

Arena context #

Army controller goal #

Art facet #

Art image element #

Art image property #

Article #

Artifact claim #

Artifacts mode #

Assign uniform context #

Assign vehicle context #

Attack move choice #

Battle outcome #

Biome #

Block square event #

Body abuse method #

Body abuse sculpture #

Body action #

Body part position #

Body part relation #

Breath attack #

Build req choice #

Build square #

Building bars vertical graphics flag #

Building extents #

Building item role #

Building trap graphics flag #

Building #

Building use #

Buildings mode #

Burrow selector context #

Burrow unit selector filter #

Cannot expel reason #

Charge restrict #

Civzone #

Clothing layer #

Combat animation swish direction #

Combat animation swish #

Combat report event #

Command #

Confrontation reason #

Confrontation situation #

Construction category #

Construction interface page status #

Construction #

Conversation state #

Conversation tact #

Conversation trouble #

Corpse material #

Counterintelligence mode #

Creation zone pwg alteration #

Creature graphics tissue layer swap condition #

Creature interaction effect #

Creature small texture #

Creature sound method #

Creature sound #

Crime #

Cultural interaction #

Cumulus #

Custom symbol context #

Dance form move #

Dance form partner change #

Death #

Demand #

Diplomacy state #

Diplomatic factor #

Divination outcome #

Dungeon #

Dungeon wrestle #

Effect #

Embark neighbor state #

Embark skill tab #

Emotion #

Encounter unit stage #

End cause #

Entity action #

Entity burial request status #

Entity entity link #

Entity event #

Entity focus #

Entity name #

Entity occasion purpose #

Entity site link #

Entity uniform #

Environment #

Era #

Ethic #

Evidence #

Export region stage #

Feature alteration #

Feature layer #

Feature square flag layer #

Feature square flag river #

Feature #