changelog.txt

===[[[
This file contains changes specific to the df-structures repo. See
docs/changelog.txt in the dfhack repo for a full description, or
https://docs.dfhack.org/en/latest/docs/Compile.html#build-changelog

NOTE: currently, gen_changelog.txt expects a "Future" section to exist at the
top of this file (even if no changes are listed under it), or you will get a
"Entry without section" error. Also, to maintain proper sorting in the generated
changelogs when making a new release, docs/changelog.txt in the dfhack repo must
have the new release listed in the right place, even if no changes were made in
that repo.

Template for new versions:

## Structures

]]]

# Future

## Structures
- added ``unitst_set_automatic_professions`` entry point export to list of known globals

# 50.14-r1

## Structures

# ``job_item_flags3``: added new flag ``grown_not_crafted``
# ``widget``: changed ``visibility_flag`` to ``flag`` (matching DF internal name)
# added new keybindings for 50.14

# 50.13-r5

# 50.13-r4

## Structures
- ``world_site``: rename ``is_mountain_halls`` and ``is_fortress`` to Bay12 names ``min_depth`` and ``max_depth``

# 50.13-r3

## Structures
- ``plant_flags``: rename ``is_burning``, ``is_drowning``, ``is_dead`` to Bay12 names ``unused_01``, ``season_dead``, ``dead``
- ``job.item_category`` is now ``job.specflag``, contains a union of flag fields, and depends on the job type
- ``slab_engraving_type``: correct order of items (last two were swapped)
- ``unitst``: correct return type of ``create_nemesis`` vmethod
- ``world_data``: identify many fields and substructures
- added several bay12 exported entry points to list of known globals
- canonicalized a wide swath of type names, field names, and structure organization to match DF's internal names and organization. fields that already had useful names were largely left alone, but all ``unk``, ``anon``, and other "placeholder" names have been changed. structures that differed from reality were also corrected (e.g. collections of fields that were actually substructures and vice versa).

# 50.13-r2

# 50.13-r1.1

# 50.13-r1

## Structures
- ``biome_type``: add enum attrs for ``caption`` and ``plant_raw_flags``

# 50.12-r3

## Structures
- name many previously-unknown map-related fields and flag bits
- ``unit_action_data_attack`` (``unit_move_attackst``): identify flags
- ``job_type``: new job class type: "Carving" (for smoothing and detailing)

# 50.12-r2.1

# 50.12-r2

## Structures
- ``plotinfo.hauling``: name fields related to the hauling route panel
- ``plant_tree_info``: define tree body and branch flags
- ``unit``: identify and define many previously unknown fields, types, and enums
- ``activity_event``: identify fields and type values

# 50.12-r1

# 50.11-r7

## Structures
- ``job_skill``: correct ``moodable`` property for several professions
- ``buildings_other``: add correct types for civzone building vectors

# 50.11-r6

## Structures
- ``soundst``: fix alignment

# 50.11-r5

## Structures
- ``occupation``: realigned
- ``service_order_type``: enum defined
- ``service_orderst``: type defined
- ``markup_text_boxst``: updated based on information from Bay12
- ``markup_text_linkst``, ``markup_text_wordst``, ``script_environmentst``: defined
- ``plotinfost``: ``unk23c8_flags`` renamed to ``flags``, updated based on information from Bay12
- ``world_raws``: ``unk_v50_1``, ``unk_v50_2``, ``unk_v50_3`` renamed to ``text_set``, ``music``, ``sound``
- ``soundst``: defined
- ``announcement_alertst``: defined
- ``announcement_alert_type``: enum defined
- ``announcement_type``: added ``alert_type`` enum attribute
- ``alert_button_announcement_id``: now int32_t vector (contains report ids)
- ``viewscreen_choose_start_sitest``: fix structure of warning flags -- convert series of bools to a proper bitmask
- ``feature_init_flags``: more enum values defined

# 50.11-r4

# 50.11-r3

## Structures
- ``burrow``: add new graphics mode texture and color fields
- ``job_item_flags3``: identify additional flags

# 50.11-r2

## Structures
- add new globals: ``translate_name``, ``buildingst_completebuild``
- ``artifact_rumor_locationst``: defined
- ``world_view_mode_type``: defined
- ``viewscreen_worldst``: defined types for ``view_mode`` and ``artifacts_arl`` fields

# 50.11-r1

## Structures
- add new global: ``start_dwarf_count``

# 50.10-r1

# 50.09-r4

## Structures
- Identified a number of previously anonymous virtual methods in ``itemst``

# 50.09-r3

## Structures
- Added ``global_table`` global and corresponding ``global_table_entry`` type
- ``viewscreen_legendsst``: realign structure
- ``viewscreen_new_arenast``: added (first appeared in 50.06)
- ``plotinfo``: name the fields related to tutorial popups
- ``help_context_type``: fix typo in enum name: ``EMBARK_TUTORIAL_CHICE`` -> ``EMBARK_TUTORIAL_CHOICE``

# 50.09-r2

## Structures
- ``build_req_choicest``: realign structure and fix vmethods
- ``squad_orderst``: fix vmethods

# 50.09-r1

## Structures
- ``tiletype_shape``: changed RAMP_TOP and ENDLESS_PIT to not walkable to reflect how scripts actually need these types to be treated

# 50.08-r4

## Structures
- ``abstract_building_libraryst``: initialize unknown variables as DF does
- ``misc_trait_type``: realign

# 50.08-r3

# 50.08-r2

## Structures

- Removed ``steam_mod_manager`` and ``game_extra`` globals. Their contents have been merged back into ``game``.
- ``mod_headerst``: rename ``non_vanilla`` flag to ``vanilla`` to reflect its actual usage
- ``arena_unit``: identify fields related to unit creation
- ``arena_tree``: identify fields related to tree creation
- ``abstract_building_contents``: identify fields and flags related to location item counts
- ``profession``: renamed captions ``Cheese Maker`` to ``Cheesemaker``, ``Bee Keeper`` to ``Beekeeper``, and ``Bone Setter`` to ``Bone Doctor``

# 50.08-r1

## Structures
- convert ``mod_manager`` fields to pointers

# 50.07-r1

## Structures

- identified ``divine_treasure`` and ``encased_horror`` map events
- identified fields in ``deep_vein_hollow``, ``glowing_barrier``, and ``cursed_tomb`` map events
- correct bit size of tree body data

# 50.07-beta2

## Structures
- realigned ``stockpile_settings`` for new "corpses" vector
- realigned ``furniture_type`` enum (added BAG)

# 50.07-beta1

## Structures
- identified two fields related to saves/autosaves to facilitate quicksave implementation

# 50.07-alpha3

## Structures
- ``plot_infost``.``unk_8``: renamed to ``theft_intrigues``. Fields ``unk_1`` thru ``unk_8`` renamed to ``target_item``, ``mastermind_hf``, ``mastermind_plot_id``, ``corruptor_hf``, ``corruptor``, ``corruptee_hf``, ``corruptee``, and ``theft_agreement``. ``unk_1`` renamed to ``item_known_pos``.
- ``specific_ref_type``: Removed ``BUILDING_PARTY``, ``PETINFO_PET``, and ``PETINFO_OWNER`` enum values to fix alignment.
- ``history_eventst``: Removed ``history_event_masterpiece_created_arch_designst`` and related enum value

# 50.07-alpha2

## Structures
- corrected alignment in ``world.status``
- ``dipscript_popup``: ``meeting_holder`` converted from unit pointer into two unit refs ``meeting_holder_actor`` and ``meeting_holder_noble``.
- ``activity_info``: ``unit_actor``, ``unit_noble``, and ``place`` converted from pointers to integer references.
- ``plotinfost``.``equipment``: Converted ``items_unmanifested``, ``items_unassigned``, and ``items_assigned`` vectors from pointers to item refs
- split ``gamest`` into ``gamest`` and ``gamest_extra`` to accommodate steam-specific data in ``gamest.mod_manager``
- identify item vmethod 213 (applies a thread improvements to appropriate items based on an RNG)
- identify various data types related to job completion/cancellation
- identify two anons in ``difficultyst``

# 50.07-alpha1

## Structures
- added missing tiletypes and corrected a few old ones based on a list supplied by Toady

# 50.05-alpha3.1

# 50.05-alpha3

## Structures
- corrected misalignment in ``unitst`` (affecting ``occupation`` and ``adjective``)
- identified some anons in ``unitst`` related to textures (thanks, putnam)
- realigned and fleshed out ``entity_site_link`` (again, thanks, putnam)
- add "hospital" language name category
- remove some no-longer-valid reputation types
- identify a table of daily events scheduled to take place in the current year
- ``occupation_type``: add enum values for new occupations related to hospitals
- ``item.setSharpness()``: more info about params
- ``building_design``: corrected misalignments
- ``creature_raw_graphics``: corrected misalignments
- identified fields for squads and other military structures

# 50.05-alpha2

## Structures
- corrected misalignment in ``historical_entity``
- partially identified squad-related structures in ``plotinfo`` and corrected position of ``civ_alert_idx`` (does not affect alignment)
- identified two old and one new language name groups

# 50.05-alpha1

## Structures
- Renamed globals to match DF:
    - ``ui``: renamed to ``plotinfo``
    - ``ui_advmode``: renamed to ``adventure``
    - ``ui_build_selector``: renamed to ``buildreq``
    - ``ui_sidebar_menus``: renamed to ``game``
- ``building_civzonest``: identify two variables, ``dir_x`` and ``dir_y``, that handle archery range direction.