Tech Description Enums

From FreeOrionWiki
Revision as of 10:37, 20 July 2015 by Adrian broher (Talk | contribs) (Wikipedia has a better and more complete definition on what 'source code' is.)

Jump to: navigation, search

This is a list of enumerated values that used to be helpful for writing XML tech and building descriptions. Since such content is now described by a more user-friendly scripting language that doesn't require using the enumerated values from the code, this page is now not really useful for scripting of content.

It might still be useful to a coder, however...

These were extracted directly from the wikipedia:Source_code source code (specifically: Enums.h), which will almost surely change at some point. Consequently, this list might be out of date, so check the code for the newest values to be safe, especially if you're getting odd errors when playing around with XML files.

Also, this list is only a convenience, and is not a reflection of design or offical code documentation.

The enumerated type in each heading is followed by the values that may be entered in effect XML descriptions for a field of the enumerated type. Comments are indicated by // on a line, and are not part of the acceptable values.

StarType

   STAR_BLUE
   STAR_WHITE
   STAR_YELLOW
   STAR_ORANGE
   STAR_RED
   STAR_NEUTRON
   STAR_BLACK

PlanetType

   PT_SWAMP
   PT_TOXIC
   PT_INFERNO
   PT_RADIATED
   PT_BARREN
   PT_TUNDRA
   PT_DESERT
   PT_TERRAN
   PT_OCEAN
   PT_GAIA
   PT_ASTEROIDS
   PT_GASGIANT

PlanetSize

   SZ_NOWORLD   // used to designate an empty planet slot
   SZ_TINY
   SZ_SMALL
   SZ_MEDIUM
   SZ_LARGE
   SZ_HUGE
   SZ_ASTEROIDS
   SZ_GASGIANT

PlanetEnvironment

   PE_UNINHABITABLE   //for gas giants and asteroids
   PE_TERRIBLE
   PE_ADEQUATE
   PE_SUPERB
   PE_OPTIMAL

FocusType

   FOCUS_UNKNOWN    //  Don't use this one -Zach
   FOCUS_BALANCED
   FOCUS_FARMING
   FOCUS_INDUSTRY
   FOCUS_MINING
   FOCUS_RESEARCH
   FOCUS_TRADE

MeterType

   METER_POPULATION
   METER_FARMING
   METER_INDUSTRY
   METER_RESEARCH
   METER_TRADE
   METER_MINING
   METER_CONSTRUCTION
   METER_HEALTH


UnlockableItemType

   UIT_BUILDING 
   UIT_SHIP_COMPONENT // Currently unimplemented -Zach

BuildType

   BT_NOT_BUILDING    // no building is taking place
   BT_BUILDING
   BT_SHIP
   BT_ORBITAL         // Currently unimplemented -Zach


UniverseObjectType

   OBJ_BUILDING
   OBJ_SHIP
   OBJ_FLEET 
   OBJ_PLANET
   OBJ_POP_CENTER
   OBJ_PROD_CENTER
   OBJ_SYSTEM

TechType

   TT_THEORY
   TT_APPLICATION
   TT_REFINEMENT

StockpileType

   ST_FOOD
   ST_MINERAL
   ST_TRADE