From beb9b10eb357fda5df0468971744b946a732c6c3 Mon Sep 17 00:00:00 2001 From: Evil Factory <36804725+evilfactory@users.noreply.github.com> Date: Wed, 15 Sep 2021 19:17:31 -0300 Subject: [PATCH] docs updated now with fields --- .../ServerSource/Lua/LuaClasses.cs | 2 + config.ld | 1 + docs/css/ldoc.css | 7 +- docs/lua/Character.lua | 4 +- docs/lua/Item.lua | 8 +-- docs/lua/Vectors.lua | 6 +- docs/lua/enums/ChatMessageType.lua | 64 +++++++++++++++++++ docs/templates/sidebar.ltp | 47 ++++++++++++++ 8 files changed, 129 insertions(+), 10 deletions(-) create mode 100644 docs/lua/enums/ChatMessageType.lua diff --git a/Barotrauma/BarotraumaServer/ServerSource/Lua/LuaClasses.cs b/Barotrauma/BarotraumaServer/ServerSource/Lua/LuaClasses.cs index 31368f1cb..fb3e34419 100644 --- a/Barotrauma/BarotraumaServer/ServerSource/Lua/LuaClasses.cs +++ b/Barotrauma/BarotraumaServer/ServerSource/Lua/LuaClasses.cs @@ -75,6 +75,8 @@ namespace Barotrauma } } + + // TODO: REMOVE partial class LuaPlayer { diff --git a/config.ld b/config.ld index 26e3bce6f..c9a8ceebd 100644 --- a/config.ld +++ b/config.ld @@ -49,6 +49,7 @@ end new_type("code", "Code", true) +new_type("enum", "Enum", true) tparam_alias("Client", "client") tparam_alias("Character", "character") diff --git a/docs/css/ldoc.css b/docs/css/ldoc.css index 8f37135c2..80655c6b5 100644 --- a/docs/css/ldoc.css +++ b/docs/css/ldoc.css @@ -114,7 +114,7 @@ span.realm { height: 14px; border-radius: 3px; display: inline-block; - margin-right: 6px; + margin-right: 5px; } span.realm.shared { @@ -129,6 +129,11 @@ span.realm.server { background-color: #08f; } + +.colorful-label { + color: rgb(31, 141, 155); +} + /* wrapper element for sidebar/content */ main { display: flex; diff --git a/docs/lua/Character.lua b/docs/lua/Character.lua index b1b5cfa73..0ec44cac8 100644 --- a/docs/lua/Character.lua +++ b/docs/lua/Character.lua @@ -31,9 +31,9 @@ function TeleportTo(position) end --- --- Character.CharacterList, List of all characters. +-- Character.CharacterList, Table containing all characters. -- @realm shared --- @table Character.CharacterList +-- @Character Character.CharacterList diff --git a/docs/lua/Item.lua b/docs/lua/Item.lua index bc1008b3c..fdc3411f1 100644 --- a/docs/lua/Item.lua +++ b/docs/lua/Item.lua @@ -30,7 +30,7 @@ function Item:SendSignal(signalOrString, connectionOrConnectionName) end -- @usage -- Item.ItemList[1].body.position = CreateVector2(0, 0) -- teleports first item created to 0, 0 of the level ---- List of all items. --- @treturn table --- @realm shared -Item.ItemList = {} \ No newline at end of file +--- +-- Item.ItemList, Table containing all items. +-- @realm shared +-- @Item Item.ItemList diff --git a/docs/lua/Vectors.lua b/docs/lua/Vectors.lua index f4a2c1861..a5a74d3c4 100644 --- a/docs/lua/Vectors.lua +++ b/docs/lua/Vectors.lua @@ -3,9 +3,9 @@ --[[-- Class providing vector functionality. These are the XNA Vectors, you can find all the functions and fields here:
-XNA Vector2
-XNA Vector3
-XNA Vector4
+XNA Vector2
+XNA Vector3
+XNA Vector4
Access them via Vector2.\*, Vector3.\*, Vector4.\*
CreateVector2, CreateVector3, CreateVector4 are globals. diff --git a/docs/lua/enums/ChatMessageType.lua b/docs/lua/enums/ChatMessageType.lua new file mode 100644 index 000000000..6100518d0 --- /dev/null +++ b/docs/lua/enums/ChatMessageType.lua @@ -0,0 +1,64 @@ +--[[-- +ChatMessageType enum. +]] +-- @enum ChatMessageType + +--- +-- ChatMessageType.Default = 0 +-- @realm shared +-- @number ChatMessageType.Default + +--- +-- ChatMessageType.Error = 1 +-- @realm shared +-- @number ChatMessageType.Error + +--- +-- ChatMessageType.Dead = 2 +-- @realm shared +-- @number ChatMessageType.Dead + +--- +-- ChatMessageType.Server = 3 +-- @realm shared +-- @number ChatMessageType.Server + +--- +-- ChatMessageType.Radio = 4 +-- @realm shared +-- @number ChatMessageType.Radio + +--- +-- ChatMessageType.Private = 5 +-- @realm shared +-- @number ChatMessageType.Private + +--- +-- ChatMessageType.Console = 6 +-- @realm shared +-- @number ChatMessageType.Console + +--- +-- ChatMessageType.MessageBox = 7 +-- @realm shared +-- @number ChatMessageType.MessageBox + +--- +-- ChatMessageType.Order = 8 +-- @realm shared +-- @number ChatMessageType.Order + +--- +-- ChatMessageType.ServerLog = 9 +-- @realm shared +-- @number ChatMessageType.ServerLog + +--- +-- ChatMessageType.ServerMessageBox = 9 +-- @realm shared +-- @number ChatMessageType.ServerMessageBox + +--- +-- ChatMessageType.ServerMessageBoxInGame = 9 +-- @realm shared +-- @number ChatMessageType.ServerMessageBoxInGame diff --git a/docs/templates/sidebar.ltp b/docs/templates/sidebar.ltp index 2b4642b77..c3f6dc3dc 100644 --- a/docs/templates/sidebar.ltp +++ b/docs/templates/sidebar.ltp @@ -40,6 +40,22 @@ end end) end %} + {% + local isThereFunctions = false + for k, v in pairs(currentMod.items) do + if (v.kind == "functions") then + isThereFunctions = true + break + end + end + %} + + {% if isThereFunctions then %} +
  • + +
    • + {% end %} + {% for k, v in pairs(currentMod.items) do %} {% if (v.kind == "functions") then %}
  • @@ -55,6 +71,37 @@ end {% end %} {% end %} + {% + local isThereFields = false + for k, v in pairs(currentMod.items) do + if (v.kind == "fields" or v.kind == "tables") then + isThereFields = true + break + end + end + %} + + {% if isThereFields then %} +
  • + +
    • + {% end %} + + {% for k, v in pairs(currentMod.items) do %} + {% if (v.kind == "fields" or v.kind == "tables") then %} +
  • + {* ldoc.realm_icon(v.tags.realm[1]) *} + + {% if (ldoc.is_kind_classmethod(currentMod.kind)) then + echo((v.name:gsub(".+:", ""))) + else + echo((v.name:gsub(currentMod.name .. ".", ""))) + end %} + +
    • + {% end %} + {% end %} + {% if (isKindExpandable(kind)) then %}