Add @meta for all files. Mark couple params as optional.
This commit is contained in:
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class ABMDefinition
|
||||
local ABMDefinition = {
|
||||
--- Descriptive label for profiling purposes (optional).
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
--- @diagnostic disable: missing-return
|
||||
--- @meta
|
||||
|
||||
|
||||
---@class AuthenticationHandlerGetAuth
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class BiomeDefinition
|
||||
--- Definition of a biome for use with `core.register_biome`.
|
||||
local BiomeDefinition = {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
--- @diagnostic disable: missing-return
|
||||
--- @meta
|
||||
|
||||
|
||||
--- Used by `core.register_chatcommand`.
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class DetachedInventoryCallbacksDef
|
||||
local DetachedInventoryCallbacksDef = {
|
||||
--- Called when a player wants to move items inside the inventory.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
--- @diagnostic disable: missing-return
|
||||
--- @meta
|
||||
|
||||
|
||||
--- Used by `core.register_entity`.
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
|
||||
---@class HTTPRequest: table
|
||||
local HTTPRequest = {
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- Passed to `HTTPApiTable.fetch` callback. Returned by `HTTPApiTable.fetch_async_get`.
|
||||
---@class HTTPRequestResult: table
|
||||
local HTTPRequestResult = {
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class HudDefinition
|
||||
local HudDefinition = {
|
||||
--- Name of the HUD element.
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class ItemDefinition: table
|
||||
local ItemDefinition = {
|
||||
--- Can contain new lines. "\n" has to be used as new line character.
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class LBMDefinition
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class LSystemTreeDefinition
|
||||
--- @field axiom string initial tree axiom
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class NodeDefinition: ItemDefinition
|
||||
local NodeDefinition = {
|
||||
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- For 2D or 3D value noise or value noise maps:
|
||||
---
|
||||
--- ```lua
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class ObjectProperties
|
||||
local ObjectProperties = {
|
||||
--- Defines the maximum and default HP of the entity
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class OreDefinition
|
||||
--- Defines an ore to be registered with `core.register_ore`.
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
--- @diagnostic disable: missing-return
|
||||
--- @meta
|
||||
|
||||
|
||||
--- Used by `core.register_privilege`.
|
||||
--- @class PrivilegeDefinition
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class TileAnimationDefinition: table
|
||||
local TileAnimationDefinition = {
|
||||
--- @type string one of {"vertical_frames"|"sheet_2d"}
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
--- @meta
|
||||
|
||||
|
||||
--- @class TileDefinition
|
||||
local TileDefinition = {
|
||||
--- @type string
|
||||
|
||||
Reference in New Issue
Block a user