docs: fixup and add some TODOs

DESIGNGUIDELINES.md

@@ -14,8 +14,8 @@ The icons are always white on a transparent background, no other colors or backg
 
 ## Role Icons
 
-Different to the shop icons the role icons do need mipmapping to allow for clean rescaling (TODO: more mipmapping filter information). Since the icons can be rendered quite large, they should be saved in a resolution of 512x512px. They are always white on transparent background without a shadow and a padding of x pixels.
+Different to the shop icons the role icons do need mipmapping to allow for clean rescaling (TODO more mipmapping filter information). Since the icons can be rendered quite large, they should be saved in a resolution of 512x512px. They are always white on transparent background without a shadow and a padding of x pixels.
 
 ## Workshop
 
-TODO: Link example files of workshop designs
+TODO Link example files of workshop designs

gamemodes/terrortown/gamemode/client/cl_equip.lua

@@ -183,7 +183,7 @@ local function PreqLabels(parent, x, y)
         end
     end
 
-    -- TODO add global limited
+    -- TODO: add global limited
     tbl.bought = vgui.Create("DLabel", parent)
     --tbl.bought:SetTooltip(GetTranslation("equip_help_stock"))
     tbl.bought:CopyPos(tbl.credits)

gamemodes/terrortown/gamemode/client/cl_main.lua

@@ -479,7 +479,7 @@ net.Receive("TTT_RoleList", ReceiveRoleList)
 function GM:ClearClientState()
     self:HUDClear()
 
-    -- todo: stuff like this should be in their respective files inside the hooks
+    -- TODO: stuff like this should be in their respective files inside the hooks
     -- maybe even the prepare round hook? this mess has to go
 
     local client = LocalPlayer()

gamemodes/terrortown/gamemode/client/cl_player_ext.lua

@@ -237,6 +237,7 @@ end
 net.Receive("TTT_Equipment", UpdateEquipment)
 
 -- Deletes old avatars and caches new ones
+-- TODO: I don't like that this is called "Cache" but really it refreshes ...
 local function CacheAllPlayerAvatars(ply)
     local plys = IsPlayer(ply) and { ply } or player.GetAll()
 

gamemodes/terrortown/gamemode/client/cl_search.lua

@@ -38,6 +38,12 @@ net.Receive("TTT2SendConfirmMsg", function()
     end
 
     -- checking for bots
+    -- TODO: This is not how this works
+    -- see the note about bots here: https://wiki.facepunch.com/gmod/Player:SteamID64#description
+    -- GMOD uses Universe=1 Type=4 Instance=1 and an incrementing ID
+    -- we could theoretically check for this, but just setting an empty string
+    -- for every bot seems easier
+    -- ref: https://developer.valvesoftware.com/wiki/SteamID
     if sid64 == "" then
         sid64 = nil
     end

gamemodes/terrortown/gamemode/server/sv_main.lua

@@ -694,8 +694,8 @@ function PrintResultMessage(result)
             end
         end
 
-        LANG.Msg("win_" .. result) -- TODO translation
-        ServerLog("Result: " .. result .. " wins.\n") -- TODO translation
+        LANG.Msg("win_" .. result) -- TODO: translation
+        ServerLog("Result: " .. result .. " wins.\n") -- TODO: translation
 
         return
     end

gamemodes/terrortown/gamemode/server/sv_networking.lua

@@ -56,7 +56,7 @@ function SendRoleListMessage(subrole, team, sids, ply_or_rf)
                 if
                     p:GetSubRoleData().disableSync
                     and rs == ROUND_ACTIVE
-                    -- TODO this has to be reworked
+                    -- TODO: this has to be reworked
                     and not p:RoleKnown()
                     ---
                     -- @realm server
@@ -196,7 +196,7 @@ function SendConfirmedTeam(team, ply_or_rf)
     end
 
     local _func = function(p)
-        return p:RoleKnown() -- TODO rework
+        return p:RoleKnown() -- TODO: rework
     end
 
     SendTeamList(team, ply_or_rf, _func)
@@ -236,7 +236,7 @@ function SendFullStateUpdate()
 
             if
                 not roleDataSyncTo.unknownTeam and teamSyncFrom == teamSyncTo
-                or plySyncFrom:RoleKnown() -- TODO rework
+                or plySyncFrom:RoleKnown() -- TODO: rework
                 or table.HasValue(roleDataSyncFrom.visibleForTeam, teamSyncTo)
                 or table.HasValue(roleDataSyncTo.networkRoles, roleDataSyncFrom)
                 or roleDataSyncFrom.isPublicRole
@@ -336,7 +336,7 @@ local function ttt_request_rolelist(plySyncTo)
 
             if
                 not roleDataSyncTo.unknownTeam and plySyncFrom:GetTeam() == team
-                or plySyncFrom:RoleKnown() -- TODO rework
+                or plySyncFrom:RoleKnown() -- TODO: rework
                 or table.HasValue(roleDataSyncFrom.visibleForTeam, plySyncTo:GetTeam())
                 or table.HasValue(roleDataSyncTo.networkRoles, roleDataSyncFrom)
                 or roleDataSyncFrom.isPublicRole

gamemodes/terrortown/gamemode/server/sv_player.lua

@@ -614,7 +614,7 @@ function GM:PlayerDisconnected(ply)
             ply:Kill()
         end
 
-        -- TODO ?
+        -- TODO: ?
         -- Prevent the disconnected player from being in the resends
         ply:SetRole(ROLE_NONE)
     end

gamemodes/terrortown/gamemode/server/sv_player_ext.lua

@@ -1270,7 +1270,7 @@ function plymeta:AnimPerformGesture(act)
     net.Broadcast()
 end
 
--- TODO REMOVE THIS
+-- TODO: REMOVE THIS (???)
 
 hook.Add("TTTBeginRound", "TTT2GivePendingItems", function()
     for ply, tbl in pairs(pendingItems) do

gamemodes/terrortown/gamemode/shared/hud_elements/tttminiscoreboard/pure_skin_miniscoreboard.lua

@@ -145,7 +145,8 @@ local function GetMSBColorForPlayer(ply)
 end
 
 function HUDELEMENT:Draw()
-    -- just update every 0.1 seconds; TODO maybe add a client ConVar
+    -- TODO: maybe add a client ConVar
+    -- just update every 0.1 seconds
     if self.lastUpdate + 0.1 < CurTime() then
         local plys = util.GetFilteredPlayers(function(ply)
             return ply:WasActiveInRound()

gamemodes/terrortown/gamemode/shared/sh_equip_items.lua

@@ -586,6 +586,8 @@ if SERVER then
                 for k = 1, #cachedTbl do
                     local equip = cachedTbl[k]
 
+                    -- TODO: This is duplicated code from `sh_shop.lua` `shop.CanBuyEquipment()`
+                    -- and additionally is missing checks for the various item limitations
                     if equip.notBuyable then
                         continue
                     end
@@ -1186,7 +1188,7 @@ if SERVER then
 
         if fallback ~= roleData.name then
             return
-        end -- TODO why? remove and replace SHOP_UNSET with index of the current role
+        end -- TODO: why? remove and replace SHOP_UNSET with index of the current role
 
         ---
         -- @realm server
@@ -1380,7 +1382,7 @@ else -- CLIENT
             Equipment = Equipment or {}
 
             if not Equipment[subrole] then
-                GetEquipmentForRole(nil, subrole, true) -- TODO test
+                GetEquipmentForRole(nil, subrole, true) -- TODO: test
             end
 
             for _, equip in pairs(tbl) do

gamemodes/terrortown/gamemode/shared/sh_init.lua

@@ -139,6 +139,7 @@ REVIVAL_BITS = 2
 -- @see roles.GetList
 -- @realm shared
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetRoles()
     return roles.GetList()
 end
@@ -150,6 +151,7 @@ end
 -- @see roles.GetList
 -- @realm shared
 -- @deprecated
+-- TODO: Log Deprecation message
 function SortRolesTable(tbl)
     roles.SortTable(tbl)
 end
@@ -161,6 +163,7 @@ end
 -- @see roles.GetByIndex
 -- @realm shared
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetRoleByIndex(index)
     return roles.GetByIndex(index)
 end
@@ -172,6 +175,7 @@ end
 -- @see roles.GetByName
 -- @realm shared
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetRoleByName(name)
     return roles.GetByName(name)
 end
@@ -183,6 +187,7 @@ end
 -- @see roles.GetByAbbr
 -- @realm shared
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetRoleByAbbr(abbr)
     return roles.GetByAbbr(abbr)
 end
@@ -194,6 +199,7 @@ end
 -- @realm shared
 -- @see ROLE:GetStartingCredits
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetStartingCredits(abbr)
     local roleData = roles.GetByAbbr(abbr)
 
@@ -207,6 +213,7 @@ end
 -- @realm shared
 -- @see ROLE:IsShoppingRole
 -- @deprecated
+-- TODO: Log Deprecation message
 function IsShoppingRole(subrole)
     local roleData = roles.GetByIndex(subrole)
 
@@ -219,6 +226,7 @@ end
 -- @realm shared
 -- @see roles.GetShopRoles
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetShopRoles()
     return roles.GetShopRoles()
 end
@@ -230,6 +238,7 @@ end
 -- @realm shared
 -- @see ROLE:IsBaseRole
 -- @deprecated
+-- TODO: Log Deprecation message
 function IsBaseRole(roleData)
     return roleData:IsBaseRole()
 end
@@ -241,6 +250,7 @@ end
 -- @realm shared
 -- @see ROLE:GetBaseRole
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetBaseRole(subrole)
     return roles.GetByIndex(subrole):GetBaseRole()
 end
@@ -254,6 +264,7 @@ if SERVER then
     -- @realm server
     -- @see ROLE:IsSelectable
     -- @deprecated
+-- TODO: Log Deprecation message
     function IsRoleSelectable(roleData, avoidHook)
         return roleData:IsSelectable(avoidHook)
     end
@@ -266,6 +277,7 @@ end
 -- @realm shared
 -- @see ROLE:GetSubRoles
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetSubRoles(subrole)
     local roleData = roles.GetByIndex(subrole)
 
@@ -279,6 +291,7 @@ end
 -- @realm shared
 -- @see roles.GetDefaultTeamRole
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetDefaultTeamRole(team)
     return roles.GetDefaultTeamRole(team)
 end
@@ -290,6 +303,7 @@ end
 -- @realm shared
 -- @see roles.GetDefaultTeamRoles
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetDefaultTeamRoles(team)
     return roles.GetDefaultTeamRoles(team)
 end
@@ -301,6 +315,7 @@ end
 -- @realm shared
 -- @see roles.GetTeamMembers
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetTeamMembers(team)
     return roles.GetTeamMembers(team)
 end
@@ -311,6 +326,7 @@ end
 -- @realm shared
 -- @see roles.GetWinTeams
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetWinTeams()
     return roles.GetWinTeams()
 end
@@ -321,6 +337,7 @@ end
 -- @realm shared
 -- @see roles.GetAvailableTeams
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetAvailableTeams()
     return roles.GetAvailableTeams()
 end
@@ -331,6 +348,7 @@ end
 -- @realm shared
 -- @see roles.GetSortedRoles
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetSortedRoles()
     return roles.GetSortedRoles()
 end
@@ -367,6 +385,7 @@ end
 -- @return table list of @{Player}
 -- @realm shared
 -- @deprecated
+-- TODO: Log Deprecation message
 function GetTraitors()
     local trs = {}
     local plys = player.GetAll()
@@ -388,11 +407,12 @@ end
 -- @return number
 -- @realm shared
 -- @deprecated
+-- TODO: Log Deprecation message
 function CountTraitors()
     return #GetTraitors()
 end
 
--- TODO move to client file
+-- TODO: move to client file
 if CLIENT then
     local SafeTranslate
 
@@ -513,13 +533,14 @@ OPEN_NOTOGGLE = 4 -- movelinear
 MUTE_NONE = 0
 MUTE_TERROR = 1
 MUTE_ALL = 2
-MUTE_SPEC = 1002 -- TODO why not 3?
+MUTE_SPEC = 1002 -- TODO: why not 3?
 
 -- Drop On Death override types
 DROP_ON_DEATH_TYPE_DEFAULT = 0
 DROP_ON_DEATH_TYPE_FORCE = 1
 DROP_ON_DEATH_TYPE_DENY = 2
 
+-- TODO: Move to colors/global library/extension/class
 COLOR_SPEC = Color(155, 155, 15)
 
 COLOR_WHITE = Color(255, 255, 255, 255)

lua/autorun/gs_crazyphysics.lua

@@ -6,14 +6,18 @@ end
 -- Entity Crash Catcher v2
 -- This script detects entities that are moving too fast, leading to a potential server crash
 -- Original by code_gs, Ambro, DarthTealc, TheEMP, and LuaTenshi; v2 by code_gs
--- GitHub: https://github.com/Kefta/Entity-Crash-Catcher
+-- GitHub: https://github.com/Kefta/gs_crazyphysics
 -- Facepunch: http://facepunch.com/showthread.php?t=1347114
+-- Webarchive (Jul 2016):
+-- https://web.archive.org/web/20160715215105/https://facepunch.com/showthread.php?t=1347114
 
 -- Use in conjunction with these convars:
 RunConsoleCommand("sv_crazyphysics_defuse", "1")
 RunConsoleCommand("sv_crazyphysics_remove", "1")
 --RunConsoleCommand("sv_crazyphysics_warning", "1") -- Enable if you want to be warned about bodies being removed
 
+-- TODO: Investigate possible improvements and move File to a better place?
+
 ------------------- Script -------------------
 local function DebugMessage(
     bRemove,
@@ -210,7 +214,7 @@ local function SetAbsVelocity(pEntity, vAbsVelocity)
             -- First subtract out the parent's abs velocity to get a relative
             -- velocity measured in world space
             -- Transform relative velocity into parent space
-            -- FIXME
+            -- FIXME:
             --pEntity:SetSaveValue("m_vecVelocity", (vAbsVelocity - pMoveParent:_GetAbsVelocity()):IRotate(pMoveParent:EntityToWorldTransform()))
             pEntity:SetSaveValue("velocity", vAbsVelocity)
         else
@@ -282,7 +286,7 @@ local function IdentifyCorpse(pCorpse)
     end
 
     if cv_ttt_announce_body_found:GetBool() then
-        if GetGlobalBool("ttt2_confirm_team") then -- TODO adjust the new messages
+        if GetGlobalBool("ttt2_confirm_team") then -- TODO: adjust the new messages
             LANG.Msg("body_found", {
                 finder = "The Server",
                 victim = CORPSE.GetPlayerNick(pCorpse, nil) or pPlayer:GetName(),

lua/ttt2/libraries/none.lua

@@ -6,6 +6,8 @@
 -- @author tkindanight
 -- @module none
 
+-- TODO: Rename to `global`? Maybe move (some) global vars here?
+
 if SERVER then
     AddCSLuaFile()
 end