Merge branch 'latest' into docs-test

Author: FrostSource

.gitignore

@@ -1,12 +1,16 @@
 
+# Source Engine
 /_bakeresourcecache/
 *bakeresourcecache.vpk
+
+# Tooling
 __pycache__
 /release/
 /test_release/
 __test*
 *.bak
-check_lua_versions.sh
 
 # MkDocs
-.cache
+.cache/
+check_lua_versions.sh
+serve_mobile.bat

.vscode/alyxlib.code-snippets

@@ -10,7 +10,7 @@
 			"if thisEntity then",
 			"\t-- Inherit this script if attached to entity",
 			"\t-- Will also load the script at the same time if needed",
-			"\tinherit(GetScriptFile())",
+			"\tinherit(\"${1:EntityName}\")",
 			"\treturn",
 			"end",
 			"",
@@ -45,8 +45,8 @@
 		"scope": "lua",
 		"prefix": ["Game Event"],
 		"body": [
-			"---@param params GAME_EVENT_$2",
-			"base:GameEvent(${1:\"event\"}, function(self, params)",
+			"---@param event GAME_EVENT_$2",
+			"base:GameEvent(${1:\"event\"}, function(self, event)",
 			"\t---@cast self ${3:ClassName}",
 			"",
 			"\t$0",
@@ -59,8 +59,8 @@
 		"scope": "lua",
 		"prefix": ["Player Event"],
 		"body": [
-			"---@param params PLAYER_EVENT_$2",
-			"base:PlayerEvent(${1:\"event\"}, function(self, params)",
+			"---@param event PLAYER_EVENT_$2",
+			"base:PlayerEvent(${1:\"event\"}, function(self, event)",
 			"\t---@cast self ${3:ClassName}",
 			"",
 			"\t$0",

.vscode/vlua_snippets.code-snippets

@@ -48,7 +48,7 @@
 
 	"Hook: OnTakeDamage":{
 		"scope": "lua",
-		"prefix": ["Hook", "OnTakeDamage", "Snippet"],
+		"prefix": ["Hook", "OnTakeDamageTable", "Snippet"],
 		"body": [
 			"---@param damageTable TypeDamageTable",
 			"function OnTakeDamage(damageTable)",

deployment_manifest.json

@@ -113,6 +113,34 @@
       }
     ],
 
+    "upload_removal": [
+      {
+        "type": "delete",
+        "description": "Delete compiled panorama_lua.js",
+        "source": "{AddonGame}/panorama/scripts/custom_game/panorama_lua.vjs_c"
+      },
+      {
+        "type": "delete",
+        "description": "Delete compiled panoramadoc.js",
+        "source": "{AddonGame}/panorama/scripts/custom_game/panoramadoc.vjs_c"
+      },
+      {
+        "type": "delete",
+        "description": "Delete compiled alyxlib_debug_menu.xml",
+        "source": "{AddonGame}/panorama/layout/custom_game/alyxlib_debug_menu.vxml_c"
+      },
+      {
+        "type": "delete",
+        "description": "Delete compiled alyxlib_debug_menu.js",
+        "source": "{AddonGame}/panorama/scripts/custom_game/alyxlib_debug_menu.vjs_c"
+      },
+      {
+        "type": "delete",
+        "description": "Delete compiled alyxlib_debug_menu.css",
+        "source": "{AddonGame}/panorama/styles/custom_game/alyxlib_debug_menu.vcss_c"
+      }
+    ],
+
     "sounds": [
       {
         "type": "copy",

scripts/vscripts/alyxlib/class.lua

@@ -110,7 +110,7 @@ local function _inherit(base, self, fenv)
                 break
             end
         end
-        Warning("Trying to inherit an already inherited class ( "..class_name.." -> ["..tostring(self)..","..self:GetClassname()..","..self:GetName().."] )\n")
+        warn("Trying to inherit an already inherited class ( "..class_name.." -> ["..tostring(self)..","..self:GetClassname()..","..self:GetName().."] )")
         return
     end
 
@@ -133,7 +133,7 @@ local function _inherit(base, self, fenv)
     }
     -- Used to automatically save values
     meta.__newindex = function(table, key, value)
-        if not key:startswith("__") and type(value) ~= "function" then
+        if not key:startswith("_") and type(value) ~= "function" then
             meta.__values[key] = value
             self:Save(key, value)
         else
@@ -438,6 +438,7 @@ end
 ---@field OnBreak fun(self: EntityClass, inflictor: EntityHandle) # Called when a breakable entity is broken.
 ---@field OnTakeDamage fun(self: EntityClass, damageTable: OnTakeDamageTable) # Called when entity takes damage.
 ---@field Precache fun(self: EntityClass, context: CScriptPrecacheContext) # Called before Spawn for precaching.
+---@field Think function # Entity think function.
 EntityClass = entity("EntityClass")
 
 ---Assign a new value to entity's field `name`.
@@ -461,24 +462,26 @@ function EntityClass:Save(name, value)
 
     if name then
         Storage.Save(self, name, value~=nil and value or self[name])
+        return
     end
+
     for key, val in pairs(self) do
-        if not key:startswith("__") and type(val) ~= "function" then
+        if not key:startswith("_") and type(val) ~= "function" then
             Storage.Save(self, key, val)
         end
     end
 end
 
----Main entity think function which auto resumes on game load.
----@luadoc-ignore
-function EntityClass:Think()
-    Warning("Trying to think on entity class with no think defined ["..self.__name.."]\n")
-end
+-- ---Main entity think function which auto resumes on game load.
+-- ---@luadoc-ignore
+-- function EntityClass:Think()
+--     Warning("Trying to think on entity class with no think defined ["..self.__name.."]\n")
+-- end
 
 ---Resume the entity think function.
 ---@luadoc-ignore
 function EntityClass:ResumeThink()
-    if not self:IsNull() then
+    if not self:IsNull() and type(self.Think) == "function" then
         self:SetContextThink("__EntityThink", function()
             -- Handle dead entity and user PauseThink used without returning nil
             if not IsValidEntity(self) or not self.IsThinking then return nil end
@@ -507,14 +510,14 @@ end
 
 ---Define a function for listening to a game event.
 ---@param gameEvent GameEventsAll
----@param func fun(self: EntityClass, params):any
+---@param func fun(self: EntityClass, event):any
 function EntityClass:GameEvent(gameEvent, func)
     self.__game_events[gameEvent] = func
 end
 
 ---Define a function for listening to a player event.
 ---@param playerEvent PLAYER_EVENTS_ALL
----@param func fun(self, params):any
+---@param func fun(self, event):any
 function EntityClass:PlayerEvent(playerEvent, func)
     self.__player_events[playerEvent] = func
 end
@@ -590,6 +593,8 @@ end
 ---@return boolean # True if `ent` inherits `class`, false otherwise.
 ---@diagnostic disable-next-line:lowercase-global
 function isinstance(ent, class)
+    if not IsEntity(ent, true) then return false end
+
     local inherits = rawget(ent, "__inherits")
     if inherits then
         for _, inherit in ipairs(inherits) do
@@ -621,4 +626,41 @@ function IsClassEntity(ent)
     return type(name) == "string" and EntityClassNameMap[name] ~= nil
 end
 
+---
+---Binds a class to an already spawned entity so it remains attached between game loads.
+---
+---@param entity EntityHandle # Entity to bind to.
+---@param script string|table # Script, class, or class name to bind.
+---@param activateType any
+local function doClassBind(entity, script, activateType)
+    local scope = entity:GetOrCreatePrivateScriptScope()
+    print("inheriting", scope, script)
+    inherit(script, scope)
+    if activateType and type(scope.Activate) == "function" then
+        scope.Activate(activateType)
+    end
+end
+
+---
+---Binds a class to an already spawned entity so it remains attached between game loads.
+---
+---@param entity EntityHandle # Entity to bind to.
+---@param script string # Script, class, or class name to bind.
+function BindClass(entity, script)
+    doClassBind(entity, script, 0)
+    entity:SetContext("BoundEntityClassScript", script, 0)
+end
+
+---@param event PlayerEventPlayerActivate
+ListenToPlayerEvent("player_activate", function(event)
+    local ent = Entities:First()
+    while ent do
+        local script = ent:GetContext("BoundEntityClassScript")
+        if type(script) == "string" then
+            doClassBind(ent, script)
+        end
+        ent = Entities:Next(ent)
+    end
+end)
+
 return version

scripts/vscripts/alyxlib/controls/input.lua

@@ -400,7 +400,7 @@ end
 function Input:StopListening(id)
     for _id, tbl in pairs(buttonCallbacks) do
         if _id == id then
-            tbl[_id] = nil
+            buttonCallbacks[_id] = nil
             return
         end
     end

scripts/vscripts/alyxlib/debug/commands.lua

@@ -449,7 +449,8 @@ RegisterAlyxLibCommand("sphere", function (_, x, y, z, r)
     z = tonumber(z) or 0
     r = tonumber(r) or 16
 
-    DebugDrawSphere(Vector(x, y, z), Vector(255, 255, 255), 255, r, false, 10)
+    DebugDrawSphere(Vector(x, y, z), Vector(255, 255, 255), 255, r, false, 15)
+    DebugDrawSphere(Vector(x, y, z), Vector(255, 255, 255), 255, r, true, 10)
 
 end, "Draws a debug sphere at 3D position with a radius", 0)
 

scripts/vscripts/alyxlib/debug/common.lua

@@ -187,7 +187,7 @@ function Debug.PrintEntityList(list, properties)
     lenHandle = lenHandle + 1
     local formatStr   = "%-"..lenIndex.."s %-"..lenHandle.."s"
     for propertyIndex, propertyTable in ipairs(propertyMetaData) do
-        formatStr = formatStr .. " | %-"..propertyTable.max.."s"
+        formatStr = formatStr .. " | %-"..math.min(propertyTable.max, 99).."s"
     end
     formatStr = formatStr .. " | %-"..lenParent.."s"
 
@@ -591,7 +591,7 @@ end
 ---        val2 = RandomFloat(0, 1),
 ---        val3 = RandomFloat(0, 1)
 ---    })
----    ->
+---    
 ---    1^ []        
 ---     | []    []  
 ---     | [] [] []  
@@ -759,7 +759,7 @@ end
 ---
 ---Returns a simplified vector string with decimal places truncated.
 ---
----@param vector Vector
+---@param vector Vector|QAngle|table
 ---@return string
 function Debug.SimpleVector(vector)
     return "[" .. math.trunc(vector.x, 3) .. ", " .. math.trunc(vector.y, 3) .. ", " .. math.trunc(vector.z, 3) .. "]"

scripts/vscripts/alyxlib/debug/debug_menu.lua

@@ -867,7 +867,7 @@ function DebugMenu:SendCategoryToPanel(category)
 
                 if default ~= nil then
                     -- find the index of the default value
-                    local index = TableFindIndex(item.values, function(v) return tostring(v.value) == tostring(default) end)
+                    local index = TableFindKey(item.values, function(v) return tostring(v.value) == tostring(default) end)
                     if index > 0 then
                         default = index
                     else

scripts/vscripts/alyxlib/globals.lua

@@ -610,14 +610,14 @@ end
 ---
 ---@param list table
 ---@param predicate fun(value:any):boolean
----@return integer
-function TableFindIndex(list, predicate)
-    for i, v in ipairs(list) do
+---@return any
+function TableFindKey(list, predicate)
+    for i, v in pairs(list) do
         if predicate(v) then
             return i
         end
     end
-    return 0
+    return nil
 end
 
 ---