Skip to content

Commit a5c5e90

Browse files
committed
Add unknown vmethod paramaters
1 parent ce23ddb commit a5c5e90

20 files changed

+349
-152
lines changed

dist/library/df.advmode.lua

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1743,14 +1743,20 @@ df.text_info_element_stringst = {}
17431743
---for "pick up vermin": the first argument is set to the vermin index if an item was allocated and this was the last vermin of its type the second argument is set to true if an item was allocated, false otherwise the third argument is set to true if the second argument is false the first and third arguments are not changed in all other cases returns an item_verminst pointer for all other types (as of 0.47.04): does not modify arguments 1 and 2 argument 3 is set to true if a fire was started returns nullptr
17441744
df.adventure_optionst = {}
17451745

1746-
function df.adventure_optionst:getDescription() end
1746+
---@param unk_0 string
1747+
function df.adventure_optionst:getDescription(unk_0) end
17471748

1749+
---@param unk_0 item
17481750
---@return item
1749-
function df.adventure_optionst:getIngestedItem() end
1751+
function df.adventure_optionst:getIngestedItem(unk_0) end
17501752

17511753
---for "pick up vermin": the first argument is set to the vermin index if an item was allocated and this was the last vermin of its type the second argument is set to true if an item was allocated, false otherwise the third argument is set to true if the second argument is false the first and third arguments are not changed in all other cases returns an item_verminst pointer for all other types (as of 0.47.04): does not modify arguments 1 and 2 argument 3 is set to true if a fire was started returns nullptr
1754+
---@param unk_0 integer
1755+
---@param unk_1 boolean
1756+
---@param unk_2 boolean
1757+
---@param unk_3 item
17521758
---@return item
1753-
function df.adventure_optionst:performAction() end
1759+
function df.adventure_optionst:performAction(unk_0, unk_1, unk_2, unk_3) end
17541760

17551761
---@return integer
17561762
function df.adventure_optionst:getPlayerPosX() end
@@ -1772,20 +1778,24 @@ function df.adventure_optionst:getTargetPosZ() end
17721778

17731779
function df.adventure_optionst:deleteSpatter() end
17741780

1781+
---@param unk_0 unit
17751782
---@return unit
1776-
function df.adventure_optionst:getSuckBloodUnitID() end
1783+
function df.adventure_optionst:getSuckBloodUnitID(unk_0) end
17771784

17781785
---@return boolean
17791786
function df.adventure_optionst:isIngestFromContainer() end
17801787

1788+
---@param unk_0 building
17811789
---@return building
1782-
function df.adventure_optionst:getBuildingContainer() end
1790+
function df.adventure_optionst:getBuildingContainer(unk_0) end
17831791

1792+
---@param unk_0 item
17841793
---@return item
1785-
function df.adventure_optionst:getItemContainer() end
1794+
function df.adventure_optionst:getItemContainer(unk_0) end
17861795

1796+
---@param unk_0 unit
17871797
---@return unit
1788-
function df.adventure_optionst:getUnitContainer() end
1798+
function df.adventure_optionst:getUnitContainer(unk_0) end
17891799

17901800
---@class adventure_option_eat_unit_contaminantst: adventure_optionst
17911801
---@field unit unit
@@ -1897,7 +1907,8 @@ df.adventure_movement_item_interact_pushst = {}
18971907
---@class adventure_item_interact_choicest: df.class
18981908
df.adventure_item_interact_choicest = {}
18991909

1900-
function df.adventure_item_interact_choicest:getDescription() end
1910+
---@param unk_0 string
1911+
function df.adventure_item_interact_choicest:getDescription(unk_0) end
19011912

19021913
function df.adventure_item_interact_choicest:performAction() end
19031914

dist/library/df.art.lua

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,22 +40,25 @@ function df.art_image_element:read_file(file, loadversion) end
4040
---@return art_image_element_type
4141
function df.art_image_element:getType() end
4242

43-
---@param ID integer
43+
---@param ID integer race, item type, plant ID, or shape ID
4444
function df.art_image_element:setID(ID) end
4545

46+
---@param unk_0 art_image_element
4647
---@return art_image_element
47-
function df.art_image_element:clone() end
48+
function df.art_image_element:clone(unk_0) end
4849

4950
---@param sym integer
50-
function df.art_image_element:getSymbol(sym) end
51+
---@param unk_1 integer
52+
function df.art_image_element:getSymbol(sym, unk_1) end
5153

5254
---@param name string
5355
---@param useThe boolean
5456
---@param useName boolean
5557
function df.art_image_element:getName1(name, useThe, useName) end
5658

5759
---@param name string
58-
function df.art_image_element:getName2(name) end
60+
---@param unk_1 boolean
61+
function df.art_image_element:getName2(name, unk_1) end
5962

6063
function df.art_image_element:markDiscovered() end
6164

@@ -118,11 +121,14 @@ function df.art_image_property:read_file(file, loadversion) end
118121
---@return art_image_property_type
119122
function df.art_image_property:getType() end
120123

124+
---@param unk_0 art_image_element
121125
---@return art_image_element
122-
function df.art_image_property:clone() end
126+
function df.art_image_property:clone(unk_0) end
123127

128+
---@param unk_0 string
129+
---@param unk_1 art_image
124130
---@param useName boolean
125-
function df.art_image_property:getName(useName) end
131+
function df.art_image_property:getName(unk_0, unk_1, useName) end
126132

127133
---@class _art_image_property_verb: df.enum
128134
---@field Withering 0

dist/library/df.building-raws.lua

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@
2525
---@field build_stages integer
2626
df.building_def = {}
2727

28-
function df.building_def:parseRaws() end
28+
---@param unk_0 integer
29+
---@param unk_1 integer
30+
---@param unk_2 integer
31+
---@param unk_3 integer
32+
function df.building_def:parseRaws(unk_0, unk_1, unk_2, unk_3) end
2933

3034
---add to world.raws.buildings.whatever
3135
function df.building_def:categorize() end

dist/library/df.buildings.lua

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -424,8 +424,9 @@ function df.building:setCustomType(type) end
424424
---@param supplies hospital_supplies
425425
function df.building:countHospitalSupplies(supplies) end
426426

427+
---@param unk_0 stockpile_links
427428
---@return stockpile_links
428-
function df.building:getStockpileLinks() end
429+
function df.building:getStockpileLinks(unk_0) end
429430

430431
---?
431432
function df.building:detachWorldData() end
@@ -434,8 +435,9 @@ function df.building:detachWorldData() end
434435
---@return boolean
435436
function df.building:canLinkToStockpile() end
436437

438+
---@param unk_0 building_users
437439
---@return building_users
438-
function df.building:getUsers() end
440+
function df.building:getUsers(unk_0) end
439441

440442
---@param delta_x integer
441443
---@param delta_y integer
@@ -446,7 +448,9 @@ function df.building:moveBuilding(delta_x, delta_y, delta_z) end
446448
---@param abs_y integer
447449
function df.building:initOccupancy(abs_x, abs_y) end
448450

449-
function df.building:setFillTimer() end
451+
---@param unk_0 job_type
452+
---@param unk_1 integer
453+
function df.building:setFillTimer(unk_0, unk_1) end
450454

451455
---@return boolean
452456
function df.building:isOnFire() end
@@ -474,25 +478,30 @@ function df.building:updateTemperature() end
474478
function df.building:updateItems() end
475479

476480
---@param temp integer
477-
function df.building:updateTempFromTile(temp) end
481+
---@param unk_1 boolean
482+
---@param unk_2 boolean
483+
function df.building:updateTempFromTile(temp, unk_1, unk_2) end
478484

479485
---@return boolean
480486
function df.building:isNormalFurniture() end
481487

482488
---@return boolean
483489
function df.building:isFarmPlot() end
484490

491+
---@param unk_0 workshop_profile
485492
---@return workshop_profile
486-
function df.building:getWorkshopProfile() end
493+
function df.building:getWorkshopProfile(unk_0) end
487494

495+
---@param unk_0 machine_info
488496
---@return machine_info
489-
function df.building:getMachineInfo() end
497+
function df.building:getMachineInfo(unk_0) end
490498

491499
---@param power_info power_info
492500
function df.building:getPowerInfo(power_info) end
493501

502+
---@param unk_0 machine_tile_set
494503
---@return boolean
495-
function df.building:canConnectToMachine() end
504+
function df.building:canConnectToMachine(unk_0) end
496505

497506
---@return building_type
498507
function df.building:getType() end
@@ -514,7 +523,8 @@ function df.building:updateAction() end
514523
---@return boolean
515524
function df.building:isStatueOrRestraint() end
516525

517-
function df.building:setMaterialAmount() end
526+
---@param unk_0 integer
527+
function df.building:setMaterialAmount(unk_0) end
518528

519529
---@param stage integer
520530
function df.building:setBuildStage(stage) end
@@ -542,8 +552,9 @@ function df.building:isExtentShaped() end
542552
---@param abs_y integer
543553
function df.building:updateOccupancy(abs_x, abs_y) end
544554

555+
---@param unk_0 unit
545556
---@return integer
546-
function df.building:getPersonalValue() end
557+
function df.building:getPersonalValue(unk_0) end
547558

548559
---@return boolean
549560
function df.building:canBeRoom() end
@@ -564,9 +575,10 @@ function df.building:isImpassableTile(rel_x, rel_y) end
564575
---@return integer
565576
function df.building:getFreeCapacity(subtract_pending_jobs) end
566577

578+
---@param unk_0 item
567579
---@param subtract_pending_jobs boolean
568580
---@return boolean
569-
function df.building:canStoreItem(subtract_pending_jobs) end
581+
function df.building:canStoreItem(unk_0, subtract_pending_jobs) end
570582

571583
---@param name string
572584
function df.building:getName(name) end
@@ -582,8 +594,9 @@ function df.building:getClutterLevel() end
582594
---@return boolean
583595
function df.building:needsDesign() end
584596

597+
---@param unk_0 job_type
585598
---@return boolean
586-
function df.building:canUseForMood() end
599+
function df.building:canUseForMood(unk_0) end
587600

588601
---@return boolean
589602
function df.building:canBeRoomSubset() end
@@ -605,7 +618,8 @@ function df.building:isAssigned() end
605618
---@return boolean
606619
function df.building:isJusticeRestraint() end
607620

608-
function df.building:detachRestrainedUnit() end
621+
---@param unk_0 unit
622+
function df.building:detachRestrainedUnit(unk_0) end
609623

610624
---@param file file_compressorst
611625
function df.building:write_file(file) end
@@ -628,7 +642,7 @@ function df.building:uncategorize() end
628642
---@return integer
629643
function df.building:getBaseValue() end
630644

631-
---@param new_state integer
645+
---@param new_state integer 0 = active/open, 1 = inactive/closed
632646
function df.building:setTriggerState(new_state) end
633647

634648
---@return boolean
@@ -671,7 +685,7 @@ function df.building:getDrawExtents(buffer) end
671685

672686
---@param unk_item integer
673687
---@param buffer building_drawbuffer
674-
---@param z_offset integer
688+
---@param z_offset integer building_wellst only
675689
function df.building:drawBuilding(unk_item, buffer, z_offset) end
676690

677691
---@return integer
@@ -680,7 +694,9 @@ function df.building:getSpecificSquad() end
680694
---@return integer
681695
function df.building:getSpecificPosition() end
682696

683-
function df.building:setSpecificSquadPos() end
697+
---@param unk_0 integer
698+
---@param unk_1 integer
699+
function df.building:setSpecificSquadPos(unk_0, unk_1) end
684700

685701
function df.building:clearSpecificSquad() end
686702

dist/library/df.graphics.lua

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,8 @@ function df.renderer:render() end
594594

595595
function df.renderer:set_fullscreen() end
596596

597-
function df.renderer:zoom() end
597+
---@param unk_0 zoom_commands
598+
function df.renderer:zoom(unk_0) end
598599

599600
---@param w integer
600601
---@param h integer
@@ -776,8 +777,9 @@ df.enabler.T_flag = {}
776777
---@field uploaded boolean
777778
df.enabler.T_textures = {}
778779

780+
---@param unk_0 interface_key
779781
---@return string
780-
function df.enabler:GetKeyDisplay() end
782+
function df.enabler:GetKeyDisplay(unk_0) end
781783

782784
---@class _justification: df.enum
783785
---from libgraphics

dist/library/df.history.lua

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2989,8 +2989,9 @@ function df.history_event:getHappinessModifier(entity1, entity2) end
29892989
function df.history_event:madeFirstContact(entity1, entity2, site) end
29902990

29912991
---@param killer historical_figure
2992+
---@param unk_1 historical_figure
29922993
---@return historical_figure
2993-
function df.history_event:getKilledHistfigID(killer) end
2994+
function df.history_event:getKilledHistfigID(killer, unk_1) end
29942995

29952996
---@param victim historical_figure
29962997
---@return boolean
@@ -3077,8 +3078,9 @@ function df.history_event:categorize() end
30773078
---removes event from world_history.events_death if relevant
30783079
function df.history_event:uncategorize() end
30793080

3081+
---@param unk_0 lightuserdata
30803082
---@param indent integer
3081-
function df.history_event:generate_xml(indent) end
3083+
function df.history_event:generate_xml(unk_0, indent) end
30823084

30833085
---@param file file_compressorst
30843086
function df.history_event:write_file(file) end
@@ -5240,8 +5242,9 @@ df.history_event_collection = {}
52405242
---@return history_event_collection_type
52415243
function df.history_event_collection:getType() end
52425244

5245+
---@param unk_0 lightuserdata
52435246
---@param indent integer
5244-
function df.history_event_collection:generate_xml(indent) end
5247+
function df.history_event_collection:generate_xml(unk_0, indent) end
52455248

52465249
---@param file file_compressorst
52475250
function df.history_event_collection:write_file(file) end

dist/library/df.interaction.lua

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -143,19 +143,28 @@ function df.interaction_effect:write_file(file) end
143143
function df.interaction_effect:read_file(file, loadversion) end
144144

145145
---@param target unit
146-
function df.interaction_effect:activateOnUnit(target) end
146+
---@param unk_1 integer has pointer-vector at offset 0x10
147+
---@param unk_2 boolean only used by animate
148+
function df.interaction_effect:activateOnUnit(target, unk_1, unk_2) end
147149

148150
---@param target item
149151
function df.interaction_effect:activateOnItem(target) end
150152

151-
function df.interaction_effect:parseRaws() end
153+
---@param unk_0 integer
154+
---@param unk_1 integer
155+
---@param unk_2 integer
156+
---@param unk_3 integer
157+
---@param unk_4 integer
158+
function df.interaction_effect:parseRaws(unk_0, unk_1, unk_2, unk_3, unk_4) end
152159

153-
function df.interaction_effect:finalize() end
160+
---@param unk_0 integer
161+
function df.interaction_effect:finalize(unk_0) end
154162

155163
function df.interaction_effect:applySyndromes() end
156164

165+
---@param unk_0 syndrome
157166
---@return boolean
158-
function df.interaction_effect:hasSyndrome() end
167+
function df.interaction_effect:hasSyndrome(unk_0) end
159168

160169
---@class interaction_effect_animatest: interaction_effect
161170
---@field unk_1 integer
@@ -305,7 +314,12 @@ function df.interaction_source:write_file(file) end
305314
---@param loadversion save_version
306315
function df.interaction_source:read_file(file, loadversion) end
307316

308-
function df.interaction_source:parseRaws() end
317+
---@param unk_0 integer
318+
---@param unk_1 integer
319+
---@param unk_2 integer
320+
---@param unk_3 integer
321+
---@param unk_4 integer
322+
function df.interaction_source:parseRaws(unk_0, unk_1, unk_2, unk_3, unk_4) end
309323

310324
---@class interaction_source_regionst: interaction_source
311325
---@field region_flags interaction_source_regionst_region_flags
@@ -538,7 +552,12 @@ function df.interaction_target:write_file(file) end
538552
---@param loadversion save_version
539553
function df.interaction_target:read_file(file, loadversion) end
540554

541-
function df.interaction_target:parseRaws() end
555+
---@param unk_0 integer
556+
---@param unk_1 integer
557+
---@param unk_2 integer
558+
---@param unk_3 integer
559+
---@param unk_4 integer
560+
function df.interaction_target:parseRaws(unk_0, unk_1, unk_2, unk_3, unk_4) end
542561

543562
---@class interaction_target_info: df.class
544563
---@field affected_creature_str string[][]

0 commit comments

Comments
 (0)