Wiki Downtime / Change Your Passwords!
This notice may be cached—the current version can be found here.

Difference between revisions of "v0.31:XML dump"

From Dwarf Fortress Wiki
Jump to: navigation, search
m (historical_event_collections)
(historical_event_collections: the ones I've found thus far)
Line 322: Line 322:
 
* type - the type of event collection this is (the different types are listed below)
 
* type - the type of event collection this is (the different types are listed below)
 
* parent_eventcol - Is this event collection part of another event collection?  If so the id of that parent is listed here, otherwise it will be -1
 
* parent_eventcol - Is this event collection part of another event collection?  If so the id of that parent is listed here, otherwise it will be -1
 +
* ordinal - How many times has this happened ("The Third Siege of Ironhand" would have <ordinal>3</ordinal>)
  
 
The different types of event collections along with a description and their components are listed below.  It's likely there are more event collections then those listed below:
 
The different types of event collections along with a description and their components are listed below.  It's likely there are more event collections then those listed below:
Line 328: Line 329:
 
=== abduction ===
 
=== abduction ===
 
'''Description needed'''
 
'''Description needed'''
 
+
* subregion_id
'''Parts needed'''
+
* feature_layer_id
 +
* site_id
 +
* coords
 +
* attacking_enid
 +
* defending_enid
  
 
=== beast attack ===
 
=== beast attack ===
 
'''Description needed'''
 
'''Description needed'''
 
+
* subregion_id
'''Parts needed'''
+
* feature_layer_id
 +
* site_id
 +
* coords
 +
* defending_enid
  
 
=== duel ===
 
=== duel ===
 
'''Description needed'''
 
'''Description needed'''
 
+
* subregion_id
'''Parts needed'''
+
* feature_layer_id
 +
* site_id
 +
* coords
 +
* attacking_hfid
 +
* defending_hfid
  
 
=== journey ===
 
=== journey ===
 
'''Description needed'''
 
'''Description needed'''
 
+
''No additional parts''
'''Parts needed'''
+
  
 
=== war ===
 
=== war ===
 
'''Description needed'''
 
'''Description needed'''
 
+
* aggressor_ent_id
'''Parts needed'''
+
* defender_ent_id
  
 
=== battle ===
 
=== battle ===
 
'''Description needed'''
 
'''Description needed'''
 +
* name
 +
* war_eventcol
 +
* subregion_id
 +
* feature_layer_id
 +
* site_id
 +
* coords
 +
* attacking_hfid (multiple)
 +
* '''Multiple different "squads" each with these parts
 +
** attacking_squad_race
 +
** attacking_squad_entity_pop
 +
** attacking_squad_number
 +
** attacking_squad_deaths
 +
** attacking_squad_site
 +
* outcome
 +
 +
''' Does not have an "ordinal" part
 +
  
'''Parts needed'''
 
  
 
=== site conquered ===
 
=== site conquered ===
 
'''Description needed'''
 
'''Description needed'''
 
+
* war_eventcol
'''Parts needed'''
+
* site_id
 +
* attacking_enid
 +
* defending_enid
  
 
== historical_eras ==
 
== historical_eras ==
  
 
Each <historical_era> element contains a name and a start_year element.
 
Each <historical_era> element contains a name and a start_year element.

Revision as of 19:09, 16 September 2010

An XML dump of a world's history can be generated from Legends mode.

The XML file this produces is currently not well-formed, lacking a root element that encapsulates the other contents of the dump. Some XML manipulation programs may need to have this taken into account to handle the file properly.

The XML dump consists of the following elements:

Contents

regions

Each dump contains one <regions> element, which contains a large number of <region> elements. Each <region> element has the following attributes stored as elements within it:

  • id - a reference number used to identify the region elsewhere
  • name - the name of the region (eg, "the colorless desert" or "the perplexing forests"). The names are all lower-case.
  • type - the type of region. Types include:
    • Ocean
    • Hills
    • Desert
    • Forest
    • Mountains
    • Glacier

underground_regions

Similar to the <regions> element. The <underground_region> elements contain the following:

  • id - reference number used to identify the region
  • type - can be:
    • cavern
    • magma
    • underworld
  • depth

Note that underground regions don't have names.

sites

Each <site> element contains the following:

  • id - reference number
  • name
  • type
    • city
    • tree city
    • cave
    • dwarf fortress
  • coords - an X, Y coordinate giving the location of the site on the world map.

structures

Each site may contain a <structures> tag.

historical_figures

The <historical_figure> elements contain only the very most basic information:

  • id
  • name

Other information such as death dates and marriages are stored in the historical_events element.

entity_populations

Each <entity_population> element contains only a single tag, giving an id number.

entities

Each <entity> element contains an id tag, and may also contain a name tag.

Entityies are civilizations, groups (which can found sites/religions/attack/defend), or religions.

historical_events

The <historical_event> element is the most complex. Each contains:

  • id - a reference number
  • year - the year in which the event took place
  • seconds72 -
  • type - a label indicating what sort of event this is.

The other elements of the historical_event will depend on the contents of the type element. Types include:

add hf hf link

This is an event that links two historical figures (hf) together. This event could either be a marriage, the beginning of hfid worshipping hfid_target, or something else.

  • hfid
  • hfid_target

add hf site link

This event shows that some (unexported) HF took up residence in some site (site_id)

  • site_id

add hf entity link

Explanation needed

  • civ_id

attacked site

This is an event that marks when a group (attacker_civ_id) attacked another group (site_civ_id) at a site (site_id) owned by a civ (defender_civ_id). The attack was led by a HF (attacker_general_hfid) and the defense was led by another hfid (defender_general_hfid).

  • attacker_civ_id
  • defender_civ_id
  • site_civ_id
  • site_id
  • attacker_general_hfid
  • defender_general_hfid

body abused

Explanation needed

  • site_id
  • subregion_id (always -1?)
  • feature_layer_id (always -1?)
  • coords


change hf job

This event shows that some HF (hfid) took up a different job (unexported) at some site (site_id)

  • hfid
  • site_id
  • subregion_id (always -1?)
  • feature_layer_id (always -1?)

change hf state

This event shows that some HF (hfid) changed state (to state) at site_id, in subregion_id, or in feature_layer_id, located at coords.

  • state - tells what state the historical figure is changing to.
    • settled (site,coords given)
    • scouting (site,coords given)
    • theif (site,coords given)
    • snatcher (site,coords given)
    • wandering (feature_layer given)
    • refugee (subregion_id,coords given)
    • hunting (subregion_id,coords given)
  • hfid - ID number of the historical figure whose state is changing
  • site_id
  • subregion_id
  • feature_layer_id
  • coords

create entity position

Explanation needed No Parts

created site

Appears to be the creation of a town (?)

  • civ_id
  • site_civ_id
  • site_id

created structure

Some entity (site_civ_id) of entity/civ (civ_id) built structure (structure_id) at some site (site_id)

  • civ_id - identifies an entity that makes up the second part of the Civ name (i.e. the 'X' in "Y of X")
  • site_civ_id - identifies an entity that makes up the first part of the Civ name (i.e. the 'Y' in "Y of X")
  • site_id - the site where the structure was created - town, fortress, whatever
  • structure_id - An ID identifying the structure. Uncertain if there is a way to find out what type of structure this is.

created world construction

Some entity (site_civ_id) of some civ/entity (civ_id) completed component wcid of master_wcid, which is a road between site_id1 and site_id2. The final completion of the road has master_wcid being -1.

  • civ_id
  • site_civ_id
  • wcid
  • master_wcid
  • site_id1
  • site_id2

creature devoured

This event shows that some HF (unexported) devoured another HF (unexported) at some site/region (site_id or subregion_id)

  • site_id
  • subregion_id
  • feature_layer_id

destroyed site

This event shows that some entity (attacker_civ_id) destroyed some site (site_id) defended by some entity (defender_civ_id) which is a member of some entity (site_civ_id).

  • site_id
  • site_civ_id
  • attacker_civ_id
  • defender_civ_id

entity created

This event makrs the creation of an entity (entity_id) at some site (site_id). This could be either a group which leaves and possibly founds another site, or this could be a religion being founded.

field battle

This event shows that some entity (attacker_civ_id) attacked some entity (defender_civ_id) at some region (subregion_id) led by a HF (attacker_general_hfid), the defenders are led by another HF (defender_general_hfid).

  • attacker_civ_id
  • defender_civ_id
  • subregion_id
  • feature_layer_id
  • coords
  • attacker_general_hfid
  • defender_general_hfid

hf abducted

This event shows that some HF (target_hfid) was abducted by a snatcher (snatcher_hfid) from some site (site_id)

subregion_id/feature_layer_id always -1?

  • target_hfid
  • snatcher_hfid
  • site_id
  • subregion_id
  • feature_layer_id

hf died

This event shows that some HF (hfid) was killed by some HF (slayer_hfid) at site/region (site_id or subregion_id)

  • hfid - the historical figure who died
  • slayer_hfid - the historical figure who slew him
  • slayer_item_id - -1 if no notable item was used
  • slayer_shooter_item_id - -1 if no notable item was used
  • site_id - -1 if not killed at a site
  • subregion_id
  • feature_layer_id
  • cause - causes include:
    • shot
    • struck
    • dragonfire

hf new pet

This event shows that some HF (group_hfid) tamed some animal in sub_region_id at coords.

  • group_hfid
  • site_id (always -1?)
  • subregion_id
  • feature_layer_id (always -1?)
  • coords

hf razed structure

Some HF (hist_fig_id) razed a structure (structure_id) at some site (site_id)

  • hist_fig_id
  • site_id
  • structure_id

hf reunion

Explanation needed

  • group_1_hfid
  • group_2_hfid
  • site_id
  • subregion_id
  • feature_layer_id

hf simple battle event

This shows that some HF (group_1_hfid) did something (subtype) to another HF (group_2_hfid) at some site/region (site_id or subregion_id)

  • subtype
    • attacked
    • scuffle
    • confront
    • ambushed
    • 2 lost after receiving wounds
  • group_1_hfid
  • group_2_hfid
  • site_id
  • subregion_id
  • feature_layer_id

hf travel

This event shows that some HF (group_hfid):

escaped from the underworld (has <escape/> and feature_layer_id given)
returned to a site (has "<return/>" listed and a site)
left a site to go to a region (has subregion_id,coords and site_id)
  • group_hfid
  • site_id
  • subregion_id
  • feature_layer_id
  • coords

hf wounded

This event shows that some HF (woundee_hfid) was wounded at site/region (site_id or subregion_id) by some HF (wounder_hfid)

  • woundee_hfid
  • wounder_hfid
  • site_id
  • subregion_id
  • feature_layer_id

impersonate hf

This event that some HF (trickster_hfid) began impersonating another HF (cover_hfid) withing an entity (target_enid)

  • trickster_hfid
  • cover_hfid
  • target_enid

item stolen

Explanation needed No Parts

new site leader

This event shows that an attacking entity (attacker_civ_id) attacked another entity (defender_civ_id) which was part of an entity (site_civ_id). The attackers one and took over the site (site_id), instituting a new government (new_site_civ_id) ran by a new leader (new_leader_hfid).

peace accepted

Explanation needed Parts needed

peace rejected

Explanation needed Parts needed

razed structure

Explanation needed Parts needed

reclaim site

This event shows an entity (site_civ_id), a member of another entity (civ_id) reclaimed a site (site_id).

  • civ_id
  • site_civ_id
  • site_id

remove hf site link

This event shows that some HF (unexported) moved out of site_id.

  • site_id

remove hf entity link

Explanation needed

  • civ_id

replaced structure

This event shows that an entity (site_civ_id) a member of another entity (civ_id) replaced a structure type (old_ab_id) with another structure type (new_ab_id) at a site (site_id). This normally (only?) happens when a civ replaces buildings (homes) with larger buildings

site taken over

Explanation needed Parts needed

historical_event_collections

As of .31.13 these have been added and contain a massive amount of information. Please help to add details below

Each historical event collection contains the following items, as well as additional items depending on it's type:

  • id - a reference number
  • start_year - the year in which the event collection started
  • start_seconds72 -
  • end_year - the year in which the event collection ended
  • start_seconds72 -
  • event - one or more events which are part of this collection
  • type - the type of event collection this is (the different types are listed below)
  • parent_eventcol - Is this event collection part of another event collection? If so the id of that parent is listed here, otherwise it will be -1
  • ordinal - How many times has this happened ("The Third Siege of Ironhand" would have <ordinal>3</ordinal>)

The different types of event collections along with a description and their components are listed below. It's likely there are more event collections then those listed below:


abduction

Description needed

  • subregion_id
  • feature_layer_id
  • site_id
  • coords
  • attacking_enid
  • defending_enid

beast attack

Description needed

  • subregion_id
  • feature_layer_id
  • site_id
  • coords
  • defending_enid

duel

Description needed

  • subregion_id
  • feature_layer_id
  • site_id
  • coords
  • attacking_hfid
  • defending_hfid

journey

Description needed No additional parts

war

Description needed

  • aggressor_ent_id
  • defender_ent_id

battle

Description needed

  • name
  • war_eventcol
  • subregion_id
  • feature_layer_id
  • site_id
  • coords
  • attacking_hfid (multiple)
  • Multiple different "squads" each with these parts
    • attacking_squad_race
    • attacking_squad_entity_pop
    • attacking_squad_number
    • attacking_squad_deaths
    • attacking_squad_site
  • outcome

Does not have an "ordinal" part


site conquered

Description needed

  • war_eventcol
  • site_id
  • attacking_enid
  • defending_enid

historical_eras

Each <historical_era> element contains a name and a start_year element.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox
Advertisement