Skip to content

Commit 0f4b046

Browse files
committed
Fix comment sharing
1 parent 0dcee53 commit 0f4b046

File tree

13 files changed

+15
-35
lines changed

13 files changed

+15
-35
lines changed

dist/library/df.advmode.lua

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1779,7 +1779,6 @@ df.text_info_element_longst = {}
17791779
---@field val df.string
17801780
df.text_info_element_stringst = {}
17811781

1782-
---<br> for "pick up vermin":<br><br> the first argument is set to the vermin index if an item was allocated and this was the last vermin of its type<br> the second argument is set to true if an item was allocated, false otherwise<br> the third argument is set to true if the second argument is false<br> the first and third arguments are not changed in all other cases<br> returns an item_verminst pointer<br><br> for all other types (as of 0.47.04):<br><br> does not modify arguments 1 and 2<br> argument 3 is set to true if a fire was started<br> returns nullptr<br>
17831782
---@class adventure_optionst: df.class
17841783
df.adventure_optionst = {}
17851784

@@ -1790,7 +1789,6 @@ function df.adventure_optionst.getDescription(unk_0) end
17901789
---@return item
17911790
function df.adventure_optionst.getIngestedItem(unk_0) end
17921791

1793-
---<br> for "pick up vermin":<br><br> the first argument is set to the vermin index if an item was allocated and this was the last vermin of its type<br> the second argument is set to true if an item was allocated, false otherwise<br> the third argument is set to true if the second argument is false<br> the first and third arguments are not changed in all other cases<br> returns an item_verminst pointer<br><br> for all other types (as of 0.47.04):<br><br> does not modify arguments 1 and 2<br> argument 3 is set to true if a fire was started<br> returns nullptr<br>
17941792
---@param unk_0 integer
17951793
---@param unk_1 boolean
17961794
---@param unk_2 boolean

dist/library/df.buildings.lua

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2172,7 +2172,6 @@ df.building_window_glassst = {}
21722172
df.building_window_gemst = {}
21732173

21742174
---@class _dfhack_room_quality_level: integer, string, df.enum
2175-
---<br> Not in DF<br><br> Royal Throne Room | Royal Bedroom | Royal Dining Room | Royal Mausoleum<br> Opulent Throne Room | Grand Bedroom | Grand Dining Room | Grand Mausoleum<br> Throne Room | Great Bedroom | Great Dining Room | Mausoleum<br> Splendid Office | Fine Quarters | Fine Dining Room | Fine Tomb<br> Decent Office | Decent Quarters | Decent Dining Room | Tomb<br> Office | Quarters | Dining Room | Burial Chamber<br> Modest Office | Modest Quarters | Modest Dining Room | Servant's Burial Chamber<br> Meager Office | Meager Quarters | Meager Dining Room | Grave<br>
21762175
---@field Meager 0
21772176
---@field [0] "Meager"
21782177
---@field Modest 1

dist/library/df.creature-raws.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1880,7 +1880,7 @@ df.caste_body_info.T_flags = {}
18801880
---@field itemcorpse_str df.string[]
18811881
---@field remains df.string[]
18821882
---@field description df.string
1883-
---@field mannerisms df.string[] fingers[2], nose, ear, head, eyes, mouth, hair, knuckles, lips, cheek, nails, f eet, arms, hands, tongue, leg
1883+
---@field mannerisms df.string[]
18841884
---@field caste_tile integer
18851885
---@field caste_soldier_tile integer
18861886
---@field caste_alttile integer

dist/library/df.globals.lua

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,6 @@ df.weather_type = {}
198198
---@field Snow boolean
199199

200200
---@class _next_global_id: integer, string, df.enum
201-
---<br> The storage order of "next ID" fields in the save file.<br> Followed by game type. The enum item name is the part between<br> next_ and _global_id in the Dwarf Fortress global variable table.<br>
202201
---@field unit 0
203202
---@field [0] "unit"
204203
---@field soul 1

dist/library/df.history.lua

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,6 @@ df.historical_figure_info.T_reputation.T_unk_2c = {}
754754
---@field unk_6 integer
755755
df.historical_figure_info.T_reputation.T_unk_2c.T_unk_12 = {}
756756

757-
---<br> only CONVERSATION, INTIMIDATION, and LYING seen;<br> could easily be an entirely different type<br>
758757
---@class historical_figure_relationships: df.class
759758
---@field hf_visual historical_figure_relationships_hf_visual[]
760759
---@field hf_historical historical_figure_relationships_hf_historical[]
@@ -847,7 +846,7 @@ df.historical_figure_relationships.T_artifact_claims = {}
847846

848847
---<br> only CONVERSATION, INTIMIDATION, and LYING seen;<br> could easily be an entirely different type<br>
849848
---@class historical_figure_relationships_intrigues: df.class
850-
---@field potential_corrupt_skill historical_figure_relationships.T_intrigues_potential_corrupt_skill <br> only CONVERSATION, INTIMIDATION, and LYING seen;<br> could easily be an entirely different type<br>
849+
---@field potential_corrupt_skill historical_figure_relationships.T_intrigues_potential_corrupt_skill
851850
---@field potential_corrupt_target historical_figure_relationships.T_intrigues_potential_corrupt_target[]
852851
---@field potential_corrupt_circumstance unit_thought_type[]
853852
---@field potential_corrupt_unk4 df.container only -1 seen
@@ -866,7 +865,6 @@ df.historical_figure_relationships.T_artifact_claims = {}
866865
---@field unk17 integer
867866
df.historical_figure_relationships.T_intrigues = {}
868867

869-
---<br> only CONVERSATION, INTIMIDATION, and LYING seen;<br> could easily be an entirely different type<br>
870868
---@class historical_figure_relationships.T_intrigues_potential_corrupt_skill: df.class
871869
df.historical_figure_relationships.T_intrigues.T_potential_corrupt_skill = {}
872870

dist/library/df.items.lua

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,6 @@ df.slab_engraving_type = {}
395395
---@field [27] boolean
396396
---@field TavernSign boolean
397397

398-
---In item_foodst, requires MEAT or FISH ingredient.
399398
---@class item: df.instance
400399
---@field pos coord
401400
---@field flags item_flags
@@ -753,12 +752,10 @@ function df.item.isEdiblePlant() end
753752
---@return boolean
754753
function df.item.isEdibleRaw(hunger) end
755754

756-
---In item_foodst, requires MEAT or FISH ingredient.
757755
---@param hunger integer
758756
---@return boolean
759757
function df.item.isEdibleCarnivore(hunger) end
760758

761-
---In item_foodst, requires CORPSEPIECE, MEAT or FISH ingredient.
762759
---@param hunger integer
763760
---@return boolean
764761
function df.item.isEdibleBonecarn(hunger) end

dist/library/df.jobs.lua

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ df.job_material_category = {}
6363
---@field strand boolean
6464

6565
---@class _dfhack_material_category: integer, string, df.bitfield
66-
---<br> An extended version of job_material_category,<br> for use in some plugins, like workflow.<br>
6766
---@field plant 0
6867
---@field [0] "plant"
6968
---@field wood 1

dist/library/df.map.lua

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -487,33 +487,29 @@ df.block_burrow = {}
487487
---@field designation tile_designation[][]
488488
---@field occupancy tile_occupancy[][]
489489
---@field fog_of_war integer[][] for adventure mode
490-
---@field path_cost map_block_path_cost flood; 256*cost for straight, 362*cost for diagonal
491-
---@field path_tag map_block_path_tag flood; sync to path_distance; same value; inc per run; reset to 0 on wraparound
492-
---@field walkable map_block_walkable 0 = non-walkable; same nonzero at A and B = walkable from A to B
493-
---@field map_edge_distance map_block_map_edge_distance 1 at walkable map edge; then +1 per 10 tiles it seems; 0 in dug tunnels
490+
---@field path_cost map_block_path_cost
491+
---@field path_tag map_block_path_tag
492+
---@field walkable map_block_walkable
493+
---@field map_edge_distance map_block_map_edge_distance
494494
---@field temperature_1 integer[][]
495495
---@field temperature_2 integer[][]
496496
---@field unk13 integer[][]
497497
---@field liquid_flow tile_liquid_flow[][]
498498
---@field region_offset integer[]
499499
df.map_block = {}
500500

501-
---flood; 256*cost for straight, 362*cost for diagonal
502501
---@class map_block_path_cost: df.class
503502
df.map_block.T_path_cost = {}
504503

505504

506-
---flood; sync to path_distance; same value; inc per run; reset to 0 on wraparound
507505
---@class map_block_path_tag: df.class
508506
df.map_block.T_path_tag = {}
509507

510508

511-
---0 = non-walkable; same nonzero at A and B = walkable from A to B
512509
---@class map_block_walkable: df.class
513510
df.map_block.T_walkable = {}
514511

515512

516-
---1 at walkable map edge; then +1 per 10 tiles it seems; 0 in dug tunnels
517513
---@class map_block_map_edge_distance: df.class
518514
df.map_block.T_map_edge_distance = {}
519515

dist/library/df.ui-menus.lua

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---THIS FILE WAS AUTOMATICALLY GENERATED. DO NOT EDIT.
22
---@meta df.ui-menus
33

4-
---<br> When creating a building, one record per required item type.<br> E.g. Soap Maker's workshop requires a bucket and a building material.<br>
54
---@class ui_build_item_req: df.class
65
---@field filter job_item_filter
76
---@field candidates item[]
@@ -26,7 +25,6 @@ df.build_req_choice_type = {}
2625
---@field [1] boolean
2726
---@field Specific boolean
2827

29-
---One choice in the build item selector.
3028
---@class build_req_choicest: df.class
3129
---@field distance integer
3230
df.build_req_choicest = {}

dist/library/df.units.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1609,7 +1609,7 @@ df.pronoun_type.attrs = {}
16091609
---@field profession2 profession
16101610
---@field race integer References: creature_raw
16111611
---@field pos coord
1612-
---@field idle_area coord <br> E.g. for a dead miner, holds the place where he<br> was likely hanging around when he got the command<br> to mine in an aquifer.<br>
1612+
---@field idle_area coord
16131613
---@field idle_area_threshold integer
16141614
---@field idle_area_type unit_station_type
16151615
---@field follow_distance integer

0 commit comments

Comments
 (0)