docs updated now with fields

This commit is contained in:
Evil Factory
2021-09-15 19:17:31 -03:00
parent a07ca2fd62
commit beb9b10eb3
8 changed files with 129 additions and 10 deletions
@@ -75,6 +75,8 @@ namespace Barotrauma
}
}
// TODO: REMOVE
partial class LuaPlayer
{
+1
View File
@@ -49,6 +49,7 @@ end
new_type("code", "Code", true)
new_type("enum", "Enum", true)
tparam_alias("Client", "client")
tparam_alias("Character", "character")
+6 -1
View File
@@ -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;
+2 -2
View File
@@ -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
+4 -4
View File
@@ -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 = {}
---
-- Item.ItemList, Table containing all items.
-- @realm shared
-- @Item Item.ItemList
+3 -3
View File
@@ -3,9 +3,9 @@
--[[--
Class providing vector functionality.
These are the XNA Vectors, you can find all the functions and fields here: <br>
<a href="https://docs.microsoft.com/en-us/previous-versions/windows/silverlight/dotnet-windows-silverlight/bb199660(v=xnagamestudio.35">XNA Vector2</a> <br>
<a href="https://docs.microsoft.com/en-us/previous-versions/windows/silverlight/dotnet-windows-silverlight/bb199670(v=xnagamestudio.35">XNA Vector3</a> <br>
<a href="https://docs.microsoft.com/en-us/previous-versions/windows/silverlight/dotnet-windows-silverlight/bb199679(v=xnagamestudio.35">XNA Vector4</a> <br>
<a href="https://docs.microsoft.com/en-us/previous-versions/windows/silverlight/dotnet-windows-silverlight/bb199660(v=xnagamestudio.35)">XNA Vector2</a> <br>
<a href="https://docs.microsoft.com/en-us/previous-versions/windows/silverlight/dotnet-windows-silverlight/bb199670(v=xnagamestudio.35)">XNA Vector3</a> <br>
<a href="https://docs.microsoft.com/en-us/previous-versions/windows/silverlight/dotnet-windows-silverlight/bb199679(v=xnagamestudio.35)">XNA Vector4</a> <br>
Access them via Vector2.\*, Vector3.\*, Vector4.\* <br>
CreateVector2, CreateVector3, CreateVector4 are globals.
+64
View File
@@ -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
+47
View File
@@ -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 %}
<li>
<label class="colorful-label">FUNCTIONS</label>
</li>
{% end %}
{% for k, v in pairs(currentMod.items) do %}
{% if (v.kind == "functions") then %}
<li>
@@ -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 %}
<li>
<label class="colorful-label">FIELDS</label>
</li>
{% end %}
{% for k, v in pairs(currentMod.items) do %}
{% if (v.kind == "fields" or v.kind == "tables") then %}
<li>
{* ldoc.realm_icon(v.tags.realm[1]) *}
<a href="{* ldoc.ref_to_module(currentMod) *}#{{v.name}}">
{% if (ldoc.is_kind_classmethod(currentMod.kind)) then
echo((v.name:gsub(".+:", "")))
else
echo((v.name:gsub(currentMod.name .. ".", "")))
end %}
</a>
</li>
{% end %}
{% end %}
{% if (isKindExpandable(kind)) then %}
</ul>
</details>