Fixed optional params and fields not having correct comment format.

Removed void returns to cause less confusion.

Author: ThatGravyBoat

create_methods.lua

@@ -26,7 +26,7 @@ function api_create_effect(px, py, ptype, amount, color)  end
 ---@param count number the number of the item to create
 ---@param x number the x position to create the item at
 ---@param y number the y position to create the item at
----@param stats table [Optional] a stats obj to use, can be one you got from api_Create_bee_stats() or a custom one
+---@param stats table @[Optional] a stats obj to use, can be one you got from api_Create_bee_stats() or a custom one
 function api_create_item(item, count, x, y, stats)  end
 
 ---
@@ -48,7 +48,7 @@ function api_create_obj(oid, x, y)  end
 ---
 ---@param method string the function you want to call when the timer ends
 ---@param seconds number the amount of time you want to wait
----@param arg1 any? [Optional] an argument to pass into the callback
----@param arg2 any? [Optional] an argument to pass into the callback
----@param arg3 any? [Optional] an argument to pass into the callback
+---@param arg1 any? @[Optional] an argument to pass into the callback
+---@param arg2 any? @[Optional] an argument to pass into the callback
+---@param arg3 any? @[Optional] an argument to pass into the callback
 function api_create_timer(method, seconds, arg1, arg2, arg3)  end

datatypes/bee_definition.lua

@@ -17,5 +17,5 @@
 ---@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
+---@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

@@ -4,4 +4,4 @@
 ---@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
+---@field dye number @[Optional] set a dye to apply to the land and nature items, valid number between 1-16

datatypes/flower_definition.lua

@@ -6,11 +6,11 @@
 ---@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
+---@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/item_definition.lua

@@ -6,12 +6,12 @@
 ---@field shop_key boolean whether this is a "key" item and so cannot be sold
 ---@field shop_buy number the amount this item can be bought for if sold by an NPC
 ---@field shop_sell number the amount this item can be sold for at an NPC
----@field machines string[] [Optional] a list of object oids that this item this can be used in
----@field placeable boolean [Optional] whether this item can be placed down on the ground, will use the object oid specified in "obj" if true
----@field place_grass boolean [Optional] if placeable, this specifies if the item can only be placed on grass
----@field place_water boolean [Optional] if placeable, this specifies if the item can only be placed on shallow water
----@field place_deep boolean [Optional] if placeable, this specifies if the item can only be placed on deep water
----@field singular boolean [Optional] if specified, items created with this definition will not be able to stack, like frames - you MUST give it a durability if you set this
----@field durability boolean [Optional] if specified, items created with this definition will have a durability, like tools
----@field obj string [Optional] if placeable, this specifies the object oid that will be created when the item is used
----@field honeycore boolean [Optional] if true, this item will be bought + sold for honeycore instead of rubees
+---@field machines string[] @[Optional] a list of object oids that this item this can be used in
+---@field placeable boolean @[Optional] whether this item can be placed down on the ground, will use the object oid specified in "obj" if true
+---@field place_grass boolean @[Optional] if placeable, this specifies if the item can only be placed on grass
+---@field place_water boolean @[Optional] if placeable, this specifies if the item can only be placed on shallow water
+---@field place_deep boolean @[Optional] if placeable, this specifies if the item can only be placed on deep water
+---@field singular boolean @[Optional] if specified, items created with this definition will not be able to stack, like frames - you MUST give it a durability if you set this
+---@field durability boolean @[Optional] if specified, items created with this definition will have a durability, like tools
+---@field obj string @[Optional] if placeable, this specifies the object oid that will be created when the item is used
+---@field honeycore boolean @[Optional] if true, this item will be bought + sold for honeycore instead of rubees

datatypes/layout.lua

@@ -1,5 +1,5 @@
 ---@class layout
 ---@field 1 number the x position for the slot, relative to the menu's top left coordinate
 ---@field 2 number the y position for the slot, relative to the menu's top left coordinate
----@field 3 string [Optional] the type of slot this is | "'Input'" | "'Liquid Input'" | "'Output'" | "'Liquid Output'" | "'Shop'"
----@field 4 string[] [Optional] if the type of slot is Input or Liquid Input, this let's you define the items that are allowed in them
+---@field 3 string @[Optional] the type of slot this is | "'Input'" | "'Liquid Input'" | "'Output'" | "'Liquid Output'" | "'Shop'"
+---@field 4 string[] @[Optional] if the type of slot is Input or Liquid Input, this let's you define the items that are allowed in them

datatypes/menu_definition.lua

@@ -9,12 +9,12 @@
 ---@field layout layout[] a list of layouts to set the slots for this objects menu
 ---@field info info[] a list of information to show when the menu help button is pressed
 ---@field buttons string[] a list of buttons for this objects menu to have | "'Help'" | "'Target'" | "'Sort'" | "'Move'" | "'Close'"
----@field machines string[] [Optional] a list of object oids that this object this can be used in
----@field tools string[] [Optional] a list of tools that can be used on this object
----@field nature boolean [Optional] this specifies if the object can only be placed on grass
----@field aquatic boolean [Optional] this specifies if the object can only be placed on shallow water
----@field deep boolean [Optional] this specifies if the object can only be placed on deep water
----@field singular boolean [Optional] this specifies if the object can stack or can only be singular, like frames or bees
----@field invisible boolean [Optional] if true, this object will not be drawn - it's bounding box will still be interactive though!
----@field center boolean [Optional] if true, when this object's menu opens it will automatically be put in the center of the screen
----@field item_sprite string [Optional] if you have an object that's overworld sprite is bigger than 16x16, you can use this to specify an alternate sprite to use as the item + slot sprite
+---@field machines string[] @[Optional] a list of object oids that this object this can be used in
+---@field tools string[] @[Optional] a list of tools that can be used on this object
+---@field nature boolean @[Optional] this specifies if the object can only be placed on grass
+---@field aquatic boolean @[Optional] this specifies if the object can only be placed on shallow water
+---@field deep boolean @[Optional] this specifies if the object can only be placed on deep water
+---@field singular boolean @[Optional] this specifies if the object can stack or can only be singular, like frames or bees
+---@field invisible boolean @[Optional] if true, this object will not be drawn - it's bounding box will still be interactive though!
+---@field center boolean @[Optional] if true, when this object's menu opens it will automatically be put in the center of the screen
+---@field item_sprite string @[Optional] if you have an object that's overworld sprite is bigger than 16x16, you can use this to specify an alternate sprite to use as the item + slot sprite

datatypes/npc_definition.lua

@@ -7,5 +7,5 @@
 ---@field stock string[] a list of up to 10 item oids that this NPC will have as it's shop stock
 ---@field greeting string the default greeting message shown in the dialogue menu when it opens
 ---@field dialogue string[] a list of dialogue to show one after the other when a player clicks the "talk" button
----@field walking boolean [Optional] whether this NPC will walk around or stay still
----@field shop boolean [Optional] whether this NPC will have a shop or just be dialogue only
+---@field walking boolean @[Optional] whether this NPC will walk around or stay still
+---@field shop boolean @[Optional] whether this NPC will have a shop or just be dialogue only

datatypes/object_definition.lua

@@ -6,17 +6,17 @@
 ---@field shop_key boolean whether this is a "key" object and so cannot be sold
 ---@field shop_buy number the amount this object can be bought for if sold by an NPC
 ---@field shop_sell number the amount this object can be sold for at an NPC
----@field machines string[] [Optional] a list of object oids that this object this can be used in
----@field tools string[] [Optional] a list of tools that can be used on this object
----@field place_grass boolean [Optional] this specifies if the object can only be placed on grass
----@field place_water boolean [Optional] this specifies if the object can only be placed on shallow water
----@field place_deep boolean [Optional] this specifies if the object can only be placed on deep water
----@field durability boolean [Optional] if specified, object created with this definition will have a durability, like tools
----@field singular boolean [Optional] if specified, objects created with this definition will not be able to stack, like frames
----@field honeycore boolean [Optional] if true, this objects will be bought + sold for honeycore instead of rubees
----@field invisible boolean [Optional] if true, this object will not be drawn - it's bounding box will still be interactive though!
----@field has_shadow boolean [Optional] if true, a shadow will be automatically drawn under this object
----@field pickable boolean [Optional] if true, you'll be able to pick up this item with the mouse
----@field variants number [Optional] for nature objects, like trees, this specifies the amount of variants within the sprite for the object
----@field growth string [Optional] if set, after the object is created a timer will start, after which a new object will be created instead, for example saplings in the game use {{{i}}} to make a tree randomly after 360-560 seconds
----@field item_sprite string [Optional] if you have an object that's overworld sprite is bigger than 16x16, you can use this to specify an alternate sprite to use as the item + slot sprite
+---@field machines string[] @[Optional] a list of object oids that this object this can be used in
+---@field tools string[] @[Optional] a list of tools that can be used on this object
+---@field place_grass boolean @[Optional] this specifies if the object can only be placed on grass
+---@field place_water boolean @[Optional] this specifies if the object can only be placed on shallow water
+---@field place_deep boolean @[Optional] this specifies if the object can only be placed on deep water
+---@field durability boolean @[Optional] if specified, object created with this definition will have a durability, like tools
+---@field singular boolean @[Optional] if specified, objects created with this definition will not be able to stack, like frames
+---@field honeycore boolean @[Optional] if true, this objects will be bought + sold for honeycore instead of rubees
+---@field invisible boolean @[Optional] if true, this object will not be drawn - it's bounding box will still be interactive though!
+---@field has_shadow boolean @[Optional] if true, a shadow will be automatically drawn under this object
+---@field pickable boolean @[Optional] if true, you'll be able to pick up this item with the mouse
+---@field variants number @[Optional] for nature objects, like trees, this specifies the amount of variants within the sprite for the object
+---@field growth string @[Optional] if set, after the object is created a timer will start, after which a new object will be created instead, for example saplings in the game use {{{i}}} to make a tree randomly after 360-560 seconds
+---@field item_sprite string @[Optional] if you have an object that's overworld sprite is bigger than 16x16, you can use this to specify an alternate sprite to use as the item + slot sprite

datatypes/quest_line.lua

@@ -1,5 +1,5 @@
 ---@class quest_line
 ---@field text string the text for this line
----@field color string [Optional] the color key for the text, defaults to "FONT_BOOK"
----@field gif string [Optional] instead of text you can show a sprite by specifying the oid of the sprite. The sprite should have a width of 148 pixels and a height of either 46, 66, or 86 pixels.
----@field width number [Optional] if a gif is specified this sets the height of the gif, should be 46, 66, or 86
+---@field color string @[Optional] the color key for the text, defaults to "FONT_BOOK"
+---@field gif string @[Optional] instead of text you can show a sprite by specifying the oid of the sprite. The sprite should have a width of 148 pixels and a height of either 46, 66, or 86 pixels.
+---@field width number @[Optional] if a gif is specified this sets the height of the gif, should be 46, 66, or 86