Added value descriptions to custom data types

Author: ThatGravyBoat

datatypes/bee_definition.lua

@@ -1,21 +1,21 @@
 ---@class bee_definition
----@field id string
----@field title string
----@field latin string
----@field hint string
----@field desc string
----@field lifespan string[]
----@field productivity string[]
----@field fertility string[]
----@field stability string[]
----@field behaviour string[]
----@field climate string[]
----@field rainlover boolean
----@field snowlover boolean
----@field grumpy boolean
----@field produce string
----@field chance number
----@field requirement string
----@field bid string
----@field calming string[]
----@field tier number
+---@field id string lowercase unique name for your bee
+---@field title string name of your bee for tooltips + books
+---@field latin string the latin name for your bee, shown in the book
+---@field hint string the hint to show in the book when this species hasn't been discovered yet
+---@field desc string the description to show in the book when this species has been discovered
+---@field lifespan string[] a list of possible lifespan traits this species can spawn with, value options are Hyper, Rapid, Short, Normal, Long, Ancient, Eternal
+---@field productivity string[] a list of possible productivity traits this species can spawn with, value options are Sluggish, Slowest, Slow, Normal, Fast, Fastest, Brisk
+---@field fertility string[] a list of possible fertility traits this species can spawn with, value options are Sterile, Infertile, Unlucky, Fertile, Fecund, Prolific, Swarming
+---@field stability string[] a list of possible stability traits this species can spawn with, value options are Chaotic, Erratic, Unstable, Normal, Stable, Ordered, Pure
+---@field behaviour string[] a list of possible behaviour traits this species can spawn with, value options are Diurnal, Nocturnal, Crepuscular, Cathemeral
+---@field climate string[] a list of possible climate traits this species can spawn with, value options are Temperate, Tropic, Polar, Any
+---@field rainlover boolean whether this species can work while it's raining
+---@field snowlover boolean whether this species can work while it's snowing
+---@field grumpy boolean whether this species is grumpy and needs to be calmed before being worked with
+---@field produce string the item oid of the item this species' "special produce" that will be created when frames are extracted
+---@field chance number the chance this bee can be formed when it's the mutation for a hybrid
+---@field requirement string the requirement for how this bee can be formed when it's the mutation for a hybrid, shown in the Predictor
+---@field bid string a unique 2 character identifier for this species to use for the beebox / beebank storage. The identifier cannot be a number, i.e. 01 as these are reserved by the base game. This must be unique across all mods, so ask your fellow modders first!
+---@field calming string[] [Optional] if this species is grumpy, you can provide a list of flower oids that calm it
+---@field tier number [Optional] the tier this bee should belond to, if there is room. Should be a number between 1-5, if no room is in the given tier it'll try the next tier up until it defaults to 5

datatypes/blueprint.lua

@@ -1,7 +1,7 @@
 ---@class blueprint
----@field width number
----@field height number
----@field x number
----@field y number
----@field type string Options: [forest, swamp, snow, hallow]
----@field dye number [Optional] 1-16
+---@field width number the width of the blueprint, which effects the blob of land created
+---@field height number the height of the blueprint, which effects the blob of land created
+---@field x number the y position in the world to put this blueprint
+---@field y number the y position in the world to put this blueprint
+---@field type string the type of biome to set for this blueprint | "'forest'" | "'swamp'" | "'snow'" | "'hallow'"
+---@field dye number [Optional] set a dye to apply to the land and nature items, valid number between 1-16

datatypes/boundary.lua

@@ -1,5 +1,5 @@
 ---@class boundary
----@field top number
----@field left number
----@field bottom number
----@field right number
+---@field top number the top y position of the bounding box
+---@field left number  	the left x position of the bounding box
+---@field bottom number the bottom y position of the bounding box
+---@field right number the right x position of the bounding box

datatypes/color.lua

@@ -1,4 +1,4 @@
 ---@class color
----@field r number
----@field g number
----@field b number
+---@field r number the red value of the color
+---@field g number the green value of the color
+---@field b number the blue value of the color

datatypes/coordinate.lua

@@ -1,3 +1,3 @@
 ---@class coordinate
----@field x number
----@field y number
+---@field x number the x position of this co-ordinate
+---@field y number the y position of this co-ordinate

datatypes/flower_definition.lua

@@ -1,16 +1,16 @@
 ---@class flower_definition
----@field id string
----@field species string
----@field title string
----@field latin string
----@field hint string
----@field desc string
----@field aquatic boolean
----@field deep boolean
----@field shop_buy number
----@field shop_sell number
----@field machines string[]
----@field tools string[]
----@field variants number
----@field chance number
----@field smoker string[]
+---@field id string unique ID for this flower - your oid will be a combination of "flower" and your id
+---@field species string lowercase unique name for your flower
+---@field title string name of your flower for tooltips
+---@field latin string the latin name for your flower, shown in the book
+---@field hint string the hint to show in the book when this species hasn't been discovered yet
+---@field desc string the description to show in the book when this species has been discovered
+---@field aquatic boolean whether this flower can be planted / grow on shallow water
+---@field deep boolean [Optional] whether this flower can be planted / grow on deep water
+---@field shop_buy number [Optional] the amount this flower can be bought for if sold by an NPC
+---@field shop_sell number [Optional] the amount this flower can be sold for at an NPC
+---@field machines string[] [Optional] a list of object oids that this flower can be used in
+---@field tools string[] [Optional] a list of tools that can be used on this flower,
+---@field variants number [Optional] specifies the number of variants in your sprite image, defaults to 1
+---@field chance number [Optional] the chance this species will be formed as a mutation, defaults to 100
+---@field smoker string[] [Optional] a list of bee species that this flower can be used to calm in a smoker

datatypes/game_size.lua

@@ -1,3 +1,3 @@
 ---@class game_size
----@field width number
----@field height number
+---@field width number the width of the game screen
+---@field height number the height of the game screen

datatypes/info.lua

@@ -1,3 +1,3 @@
 ---@class info
----@field 1 string tooltip
----@field 2 string color key
+---@field 1 string the tooltip to show
+---@field 2 string | "'GREEN'" | "'BLUE'" | "'RED'" | "'YELLOW'" | "'WHITE'"

datatypes/ingredient.lua

@@ -1,3 +1,3 @@
 ---@class ingredient
----@field item string
----@field amount number
+---@field item string the item for this ingredient
+---@field amount number the amount of this item needed for this ingredient

datatypes/instance.lua

@@ -1,9 +1,9 @@
 ---@class instance
----@field id number
----@field x number
----@field y number
----@field oid string
----@field sprite_index number
----@field image_index number
----@field menu_id number will be nil if not a menu instance
----@field slots slot[] will be nil if not a menu instance
+---@field id number the GMS id for this instance, to use in API methods
+---@field x number the x position of this inst
+---@field y number the y position of this inst
+---@field oid string the APICO "id" value used with the Dictionary
+---@field sprite_index number the sprite image id used for this instance
+---@field image_index number the sprite image "frame" currently set for this instance
+---@field menu_id number the menu instance for this instance - will be nil if not a menu object instance
+---@field slots slot[] a list of slot instances - will be nil if not a menu instance