Improve stl-string definition

Author: vallode

dist/library/base.lua

@@ -86,6 +86,9 @@ function dfbase:_displace(index, step) end
 ---@field insert fun(self: self, index: "#ref"|"#"|integer, item: any)
 ---@field erase fun(self: self, index: integer)
 
+---@class df.string: string
+---@field value string
+
 ---@param object table
 ---@return integer
 function df.sizeof(object) end

dist/library/df.advmode.lua

@@ -211,7 +211,7 @@ df.ui_advmode_menu = {}
 ---@field PartyTacticalSettings boolean
 
 ---@class conversation: df.class
----@field conv_title string
+---@field conv_title df.string
 ---@field state conversation_state
 ---@field talk_choices df.container
 ---@field unk_30 integer References: unit
@@ -261,7 +261,7 @@ df.conversation.T_state = {}
 
 
 ---@class conversation_speech: df.class
----@field text string[] wordwrap
+---@field text df.string[] wordwrap
 ---@field speaker integer References: unit
 ---@field unk_14 integer
 ---@field unk_18 integer
@@ -1224,7 +1224,7 @@ df.talk_choice.T_unk = {}
 ---@field travel_clouds boolean
 ---@field travel_right_map adventurest_travel_right_map
 ---@field show_menu adventurest_show_menu bottom menu in travel mode
----@field message string you must move from surrounding obstacles
+---@field message df.string you must move from surrounding obstacles
 ---@field message_color integer
 ---@field message_brightness integer
 ---@field travel_not_moved boolean
@@ -1330,7 +1330,7 @@ df.talk_choice.T_unk = {}
 ---@field companions adventurest_companions
 ---@field unk_1 integer
 ---@field interactions adventurest_interactions
----@field unk_87 string
+---@field unk_87 df.string
 ---@field unk_220 integer
 ---@field unk_224 integer
 ---@field unk_v40_2 adventurest_unk_v40_2
@@ -1351,7 +1351,7 @@ df.talk_choice.T_unk = {}
 ---@field move_carefully integer Is set when the player prepares to move carefully (via the Alt + movement key combo)
 ---@field careful_direction_x integer x-axis direction for the last attempted careful player unit movement: -1 = west, 0 = none, 1 = east
 ---@field careful_direction_y integer y-axis direction for the last attempted careful player unit movement: -1 = north, 0 = none, 1 = south
----@field interrupt_performance_warning string the message displayed when the player attempts to move while their unit is performing
+---@field interrupt_performance_warning df.string the message displayed when the player attempts to move while their unit is performing
 ---@field unk_2 integer
 ---@field unk_2a integer
 ---@field name_item language_name used when naming items
@@ -1494,7 +1494,7 @@ df.adventurest.T_unk_3170.T_unk_2 = {}
 ---@field unk_43 df.container
 ---@field unk_44 df.container
 ---@field unk_45 integer
----@field unk_46 string
+---@field unk_46 df.string
 ---@field unk_47 integer
 ---@field unk_48 integer
 ---@field unk_49 integer
@@ -1606,16 +1606,16 @@ df.adventurest.T_charge_forbidden = {}
 ---@field page_top_choices df.container
 ---@field page_bottom_choices df.container
 ---@field choices adventurest.T_conversation_choices[]
----@field filter string
+---@field filter df.string
 ---@field unk_1 integer
 ---@field targets adventurest.T_conversation_targets[]
 ---@field cursor_target integer
 df.adventurest.T_conversation = {}
 
 ---@class adventurest.T_conversation_choices: df.class
 ---@field choice talk_choice
----@field keywords string[]
----@field title string[]
+---@field keywords df.string[]
+---@field title df.string[]
 ---@field orig_index integer
 ---@field ranking integer
 df.adventurest.T_conversation.T_choices = {}
@@ -1739,7 +1739,7 @@ df.adventurest.T_unk_v40_5 = {}
 ---@field unk_s1 integer
 ---@field unk_s2 df.container
 ---@field unk_s3 df.container
----@field unk_s4 string
+---@field unk_s4 df.string
 ---@field unk_s5 integer
 ---@field unk_s6 integer
 ---@field unk_s7 integer
@@ -1757,15 +1757,15 @@ df.adventurest.T_unk_v42_1 = {}
 ---@field origin integer References: historical_entity
 ---@field unk_1 df.container
 ---@field unk_2 df.container
----@field filter string
+---@field filter df.string
 ---@field unk_3 integer
 ---@field unk_4 integer
 df.adventurest.T_assume_identity = {}
 
 ---@class text_info_elementst: df.class
 df.text_info_elementst = {}
 
----@param val string
+---@param val df.string
 function df.text_info_elementst.getString(val) end
 
 ---@return integer
@@ -1776,14 +1776,14 @@ function df.text_info_elementst.getLong() end
 df.text_info_element_longst = {}
 
 ---@class text_info_element_stringst: text_info_elementst
----@field val string
+---@field val df.string
 df.text_info_element_stringst = {}
 
 ---<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>
 ---@class adventure_optionst: df.class
 df.adventure_optionst = {}
 
----@param unk_0 string
+---@param unk_0 df.string
 function df.adventure_optionst.getDescription(unk_0) end
 
 ---@param unk_0 item
@@ -1947,7 +1947,7 @@ df.adventure_movement_item_interact_pushst = {}
 ---@class adventure_item_interact_choicest: df.class
 df.adventure_item_interact_choicest = {}
 
----@param unk_0 string
+---@param unk_0 df.string
 function df.adventure_item_interact_choicest.getDescription(unk_0) end
 
 function df.adventure_item_interact_choicest.performAction() end

dist/library/df.announcements.lua

@@ -1446,7 +1446,7 @@ df.announcements = {}
 
 ---@class report: df.instance
 ---@field type announcement_type valid only if coordinates are
----@field text string
+---@field text df.string
 ---@field color integer
 ---@field bright boolean
 ---@field duration integer remaining graphical frames to display this report in announcement bar
@@ -1503,7 +1503,7 @@ df.report_zoom_type = {}
 ---@field Unit boolean
 
 ---@class popup_message: df.class
----@field text string
+---@field text df.string
 ---@field color integer
 ---@field bright boolean
 df.popup_message = {}

dist/library/df.art.lua

@@ -51,12 +51,12 @@ function df.art_image_element.clone(unk_0) end
 ---@param unk_1 integer
 function df.art_image_element.getSymbol(sym, unk_1) end
 
----@param name string
+---@param name df.string
 ---@param useThe boolean
 ---@param useName boolean
 function df.art_image_element.getName1(name, useThe, useName) end
 
----@param name string
+---@param name df.string
 ---@param unk_1 boolean
 function df.art_image_element.getName2(name, unk_1) end
 
@@ -125,7 +125,7 @@ function df.art_image_property.getType() end
 ---@return art_image_element
 function df.art_image_property.clone(unk_0) end
 
----@param unk_0 string
+---@param unk_0 df.string
 ---@param unk_1 art_image
 ---@param useName boolean
 function df.art_image_property.getName(unk_0, unk_1, useName) end
@@ -2290,7 +2290,7 @@ df.dance_form_move_group_type = {}
 ---@field DanceMove boolean
 
 ---@class dance_form_move: df.class
----@field name string
+---@field name df.string
 ---@field type dance_form_move_type[]
 ---@field modifier dance_form_move_modifier[]
 ---@field parameter df.container Depends on type (turns are in signed angles, steps are in number of steps, etc.)
@@ -2351,7 +2351,7 @@ df.scale_type = {}
 ---@field PerfectFourth boolean
 
 ---@class chord: df.class
----@field name string
+---@field name df.string
 ---@field notes integer[] chord_size entries used. Refers to the notes indices
 ---@field chord_size integer
 ---@field unk_3 integer 0 and 1 seen
@@ -2360,7 +2360,7 @@ df.chord = {}
 ---Seems odd with a 'scale' consisting of two chords, but that's what the exported XML calls it.
 ---@class named_scale: df.class
 ---@field unk_1 integer 0-4 seen. 0: nothing, for when degrees are used, 1: joined chords, 2/3: disjoined chords (varying kinds of chords seen for both), 4: as always, disjoined chords
----@field name string
+---@field name df.string
 ---@field degrees integer[] indices into the (not necessarily named) notes of the scale
 ---@field degrees_used integer elements used in array above
 ---@field first_chord integer this pair seems to be used when degrees_used = 0. Refers to indices in the chords vector
@@ -2395,8 +2395,8 @@ df.scale.T_flags = {}
 ---Curiously, the named notes do not have to match the number of defined notes
 ---@class scale_notes: df.class
 ---@field unk_1 integer Frequently looks like garbage for all values of type. Suspect it's actually a filler
----@field name string[]
----@field abreviation string[]
+---@field name df.string[]
+---@field abreviation df.string[]
 ---@field number integer[]
 ---@field length integer number of elements of the arrays above used
 df.scale.T_notes = {}
@@ -2466,10 +2466,10 @@ df.beat_type = {}
 ---@field AccentedSyncopated boolean
 
 ---@class rhythm_pattern: df.class
----@field name string
+---@field name df.string
 ---@field bars rhythm_pattern_bars[]
----@field beat_name string length as per length field
----@field beat_abbreviation string length as per length field
+---@field beat_name df.string length as per length field
+---@field beat_abbreviation df.string length as per length field
 ---@field length integer
 df.rhythm_pattern = {}
 
@@ -2479,7 +2479,7 @@ df.rhythm_pattern = {}
 df.rhythm_pattern.T_bars = {}
 
 ---@class sub_rhythm: df.class
----@field name string
+---@field name df.string
 ---@field patterns df.container indices into patterns
 ---@field unk_2 df.container Same length as patterns, but with unknown purpose
 ---@field unk_3 integer

dist/library/df.building-raws.lua

@@ -2,9 +2,9 @@
 ---@meta df.building-raws
 
 ---@class building_def: df.instance
----@field code string
+---@field code df.string
 ---@field id integer
----@field name string
+---@field name df.string
 ---@field building_type building_type
 ---@field building_subtype integer
 ---@field name_color integer[]
@@ -21,7 +21,7 @@
 ---@field workloc_x integer
 ---@field workloc_y integer
 ---@field build_labors unit_labor[]
----@field labor_description string
+---@field labor_description df.string
 ---@field build_stages integer
 df.building_def = {}
 
@@ -45,8 +45,8 @@ function df.building_def.finalize() end
 ---@field item_subtype integer
 ---@field mat_type integer References: material
 ---@field mat_index integer
----@field reaction_class string
----@field has_material_reaction_product string
+---@field reaction_class df.string
+---@field has_material_reaction_product df.string
 ---@field flags1 job_item_flags1
 ---@field flags2 job_item_flags2
 ---@field flags3 job_item_flags3
@@ -56,9 +56,9 @@ function df.building_def.finalize() end
 ---@field min_dimension integer
 ---@field quantity integer
 ---@field has_tool_use tool_uses
----@field item_str string[]
----@field material_str string[]
----@field metal_ore_str string
+---@field item_str df.string[]
+---@field material_str df.string[]
+---@field metal_ore_str df.string
 df.building_def_item = {}
 
 ---@class building_def_workshopst: building_def

dist/library/df.buildings.lua

@@ -395,7 +395,7 @@ df.building_drawbuffer = {}
 ---@field general_refs general_ref[]
 ---@field relations building_civzonest[] zone(s) this building is in
 ---@field job_claim_suppress building_job_claim_suppress[] after Remv Cre, prevents unit from taking jobs at building
----@field name string
+---@field name df.string
 ---@field activities building_activities[]
 ---@field world_data_id integer References: world_object_data
 ---@field world_data_subid integer
@@ -573,7 +573,7 @@ function df.building.getFreeCapacity(subtract_pending_jobs) end
 ---@return boolean
 function df.building.canStoreItem(unk_0, subtract_pending_jobs) end
 
----@param name string
+---@param name df.string
 function df.building.getName(name) end
 
 function df.building.getNameColor() end