Merge pull request #753 from Bumber64/patch-1

Comments for plant flags

changelog.txt

@@ -19,6 +19,7 @@ Template for new versions:
 # Future
 
 ## Structures
+- ``plant_flags``: rename ``is_burning``, ``is_drowning``, ``is_dead`` to Bay12 names ``unused_01``, ``season_dead``, ``dead``
 
 # 50.13-r2
 

df.plants.xml

@@ -1,6 +1,6 @@
 <data-definition>
-    <bitfield-type type-name='plant_flags' base-type='uint16_t'>
-        <flag-bit name='watery'/>
+    <bitfield-type type-name='plant_flags' base-type='uint16_t' comment='actually an enum relating to plant vectors'>
+        <flag-bit name='watery' comment='Within 2 tiles of pool/river/brook feature'/>
         <flag-bit name='is_shrub' comment='If it is not a shrub, then it is a tree'/>
     </bitfield-type>
 
@@ -11,17 +11,17 @@
 
         <int32_t name='grow_counter'/>
         <bitfield name='damage_flags'>
-            <flag-bit name='is_burning'/>
-            <flag-bit name='is_drowning'/>
-            <flag-bit name='is_dead'/>
+            <flag-bit name='unused_01'/>
+            <flag-bit name='season_dead'/>
+            <flag-bit name='dead'/>
         </bitfield>
         <int32_t name='hitpoints'/>
         <int16_t name='update_order'/>
 
         <int32_t name='site_id' ref-target='world_site'/>
         <int32_t name='srb_id' ref-target='site_realization_building' aux-value='$$.site_id'/>
         <stl-vector name='contaminants' pointer-type='spatter_common'/>
-        <pointer name='tree_info' type-name='plant_tree_info'/>
+        <pointer name='tree_info' type-name='plant_tree_info' comment='Sapling if NULL'/>
     </struct-type>
 
     <enum-type type-name='plant_tree_tile_branches_dir' base-type='uint16_t'>