0.6.2

* Remove e2 preprocessor usage for e2 core, allowing for linting and a simpler ci.

* Add runtime ``@strict`` only errors if you try and use xwa method functions on an invalid object

* Fix issue where WebAudio messages wouldn't go through in the same tick for a client. This would sometimes leave webaudios alive on your client while they were purged on the server.

Author: vurvdev

.github/workflows/linter.yml

@@ -7,11 +7,9 @@ on:
   push:
     paths:
     - 'lua/**'
-    - '!lua/entities/gmod_wire_expression2/**' # Ignore E2 path since it uses preprocessor stuff.
   pull_request:
     paths:
     - 'lua/**'
-    - '!lua/entities/gmod_wire_expression2/**'
   workflow_dispatch:
 
 
@@ -26,8 +24,5 @@ jobs:
         curl -o glualint.zip -L https://github.com/FPtje/GLuaFixer/releases/download/1.18.2/glualint-1.18.2-linux.zip
         unzip glualint.zip
 
-    - name: Remove E2 Extension Folder
-      run: rm -r lua/entities/gmod_wire_expression2/
-
     - name: Lint Code
       run: ./glualint lua

definitions.lua

@@ -1,7 +1,52 @@
+---@diagnostic disable:lowercase-global
+
 ---@type boolean
 SERVER = nil
 
 ---@type boolean
 CLIENT = nil
 
-E2Helper = {}
+E2Helper = {}
+E2Lib = {}
+
+wire_expression2_funcs = {}
+
+---@param msg string
+---@param level integer?
+---@param trace table
+---@param can_catch boolean? Default true
+function E2Lib.raiseException(msg, level, trace, can_catch)
+end
+
+---@param name string
+---@param value number
+function E2Lib.registerConstant(name, value, literal)
+
+end
+
+---@param num integer
+function __e2setcost(num) end
+
+---@param name string
+---@param id string
+---@param def any
+function registerType(name, id, def, ...)
+
+end
+
+---@param name string name of the function
+---@param pars string params
+---@param rets string ret
+---@param func function
+---@param cost number?
+---@param argnames table?
+function registerOperator(name, pars, rets, func, cost, argnames)
+
+end
+
+
+registerFunction = registerOperator
+
+---@param name string
+---@param cb function
+function registerCallback(name, cb) end

lua/autorun/webaudio.lua

@@ -7,20 +7,44 @@
 -- If you ever change a setting of the Interface object, will add one of these flags to it.
 -- This will be sent to the client to know what to read in the net message to save networking
 local Modify = {
-	volume = 1,
-	time = 2,
-	pos = 4,
-	playing = 8,
-	playback_rate = 16,
-	direction = 32,
-	parented = 64,
-	radius = 128,
-	looping = 256,
-	mode = 512,
-
-	destroyed = 1024
+	volume        = 0b000000000001,
+	time          = 0b000000000010,
+	pos           = 0b000000000100,
+	playing       = 0b000000001000,
+	playback_rate = 0b000000010000,
+	direction     = 0b000000100000,
+	parented      = 0b000001000000,
+	radius        = 0b000010000000,
+	looping       = 0b000100000000,
+	mode          = 0b001000000000,
+	reserved      = 0b010000000000, -- pan maybe?
+
+	destroyed     = 0b100000000000,
+
+	all           = 0b111111111111
 }
 
+-- Bits needed to send a bitflag of all the modifications
+local MODIFY_LEN = math.ceil( math.log(Modify.all, 2) )
+
+-- Max 1024 current streams
+local ID_LEN = math.ceil( math.log(1024, 2) )
+
+local FFTSAMP_LEN = 8
+
+local function toBinary(n, bits)
+	bits = bits or 32
+
+	local t = {}
+	for i = bits, 1, -1 do
+		-- Basically go by each bit and use bit32.extract. Inlined the function here with width as 1.
+		-- https://github.com/AlberTajuelo/bitop-lua/blob/8146f0b323f55f72eacbb2a8310922d50ae75ddf/src/bitop/funcs.lua#L92
+		t[bits - i] = bit.band(bit.rshift(n, i), 1)
+	end
+
+	return "0b" .. table.concat(t)
+end
+
 local function hasModifyFlag(first, ...)
 	return bit.band(first, ...) ~= 0
 end
@@ -85,6 +109,7 @@ end
 
 --- Initiate WebAudio struct for both realms
 ---@class WebAudio
+---@field url string # SHARED
 ---@field stopwatch Stopwatch # SERVER
 ---@field radius number # SHARED
 ---@field radius_sqr number # SHARED
@@ -105,6 +130,10 @@ end
 _G.WebAudio = {}
 WebAudio.__index = WebAudio
 
+WebAudio.MODIFY_LEN = MODIFY_LEN
+WebAudio.ID_LEN = ID_LEN
+WebAudio.FFTSAMP_LEN = FFTSAMP_LEN
+
 ---@alias WebAudioMode 0|1
 
 ---@type WebAudioMode
@@ -169,7 +198,7 @@ function WebAudio:IsDestroyed()
 end
 
 --- Destroys a webaudio object and makes it the same (value wise) as WebAudio.getNULL()
---- @param transmit boolean If SERVER, should we transmit the destruction to the client? Default true
+--- @param transmit boolean? If SERVER, should we transmit the destruction to the client? Default true
 function WebAudio:Destroy(transmit)
 	if self:IsDestroyed() then return end
 	if transmit == nil then transmit = true end
@@ -280,15 +309,6 @@ function WebAudioStatic.getNULL()
 	return setmetatable({ destroyed = true }, WebAudio)
 end
 
--- Bit lengths
-local ID_LEN = 10
-local MODIFY_LEN = 11
-local FFTSAMP_LEN = 8
-
-WebAudio.ID_LEN = ID_LEN
-WebAudio.MODIFY_LEN = MODIFY_LEN
-WebAudio.FFTSAMP_LEN = FFTSAMP_LEN
-
 --- Same as net.ReadUInt but doesn't need the bit length in order to adapt our code more easily.
 ---- @return number # # UInt10
 function WebAudioStatic.readID()
@@ -437,7 +457,7 @@ local function createWebAudio(_, url, owner, bassobj, id)
 	self.needs_info = SERVER -- Whether this stream still needs information from the client.
 	self.length = -1
 	self.filename = ""
-	self.fft = {} -- SERVER will receive this every think by default.
+	self.fft = {}
 
 	if CLIENT then
 		self.bass = bassobj
@@ -456,7 +476,7 @@ local function createWebAudio(_, url, owner, bassobj, id)
 			WebAudio.writeID(self.id)
 			net.WriteString(self.url)
 			net.WriteEntity(self.owner)
-		self:Broadcast() -- Defined in wa_interface
+		self:Broadcast(false) -- Defined in wa_interface
 	end
 
 	WebAudios[self.id] = self
@@ -660,8 +680,9 @@ concommand.Add("wa_list", function()
 	local stream_list, n = {}, 0
 	for id, stream in WebAudio.getIterator() do
 		local owner = stream.owner
-		if IsValid(owner) then
+		if IsValid(owner) and owner:IsPlayer() then
 			n = n + 1
+			---@diagnostic disable-next-line (Emmylua definitions don't cover the Player class well.)
 			stream_list[n] = string.format("[%d] %s(%s): '%s'", stream.id, owner:GetName(), owner:SteamID64() or "multirun", stream.url)
 		end
 	end
@@ -685,6 +706,7 @@ if CLIENT then
 			local owner = stream.owner
 			if owner and owner:IsValid() and stream.pos then
 				local pos = stream.pos:ToScreen()
+				---@diagnostic disable-next-line (Emmylua definitions don't cover the Player class well.)
 				local txt = string.format("[%u] %s (%s)", id, owner:GetName(), owner:SteamID64() or "multirun")
 				draw.DrawText( txt, "DermaDefault", pos.x, pos.y, Color_Aqua, TEXT_ALIGN_CENTER)
 			end
@@ -715,6 +737,7 @@ WebAudio.Common = {
 
 	Modify = Modify,
 	hasModifyFlag = hasModifyFlag,
+	toBinary = toBinary,
 	getFlags = getFlags,
 
 	--- Convars

lua/entities/gmod_wire_expression2/core/custom/cl_webaudio.lua

@@ -5,25 +5,32 @@ local function desc(name, description)
 	tbl[name] = description
 end
 
+--#region Base
 desc("webAudio(s)", "Returns a WebAudio object of that URL as long as it is whitelisted by the server. Has a 500 ms cooldown between calls. If you can't create a webAudio object, will error, so check webAudioCanCreate before calling this!")
 desc("webAudiosLeft()", "Returns the number of WebAudio objects you can create in total for your player")
 desc("webAudioCanCreate()", "Returns whether you can create a WebAudio object. Checks cooldown and whether you have another slot for a webaudio stream left.")
 desc("webAudioCanCreate(s)", "Same as webAudioCanCreate() but also checks if a URL is whitelisted on the server to use.")
+--#endregion
 
---- Misc
+--#region Misc
 desc("nowebaudio()", "Returns an invalid webaudio object")
+desc("toString(xwa)", "Returns the something like ``WebAudio [<ID>]`` with <ID> being the ID of the stream")
+desc("toString(xwa:)", "Returns the something like ``WebAudio [<ID>]`` with <ID> being the ID of the stream")
+--#endregion
 
---- Permissions
+--#region Permissions
 desc("webAudioEnabled()", "Returns whether WebAudio playing is enabled on the server for E2")
 desc("webAudioAdminOnly()", "Returns whether WebAudio playing is restricted to admins or super admins. 0 for everyone, 1 for admins, 2 for superadmins")
+--#endregion
 
---- WebAudio Methods
+--#region Special Methods
 desc("update(xwa:)", "Sends all of the information of the object given by functions like setPos and setTime to the client. You need to call this after running functions without running ``:play()`` or ``:pause()`` on them since those sync with the client. Returns 1 if could update, 0 if hit transmission quota")
 desc("destroy(xwa:)", "Destroys the WebAudio object, rendering it useless. It will silently fail when trying to use it from here on! This gives you another slot to make a WebAudio object. Check if an object is destroyed with isValid!")
 desc("pause(xwa:)", "Pauses the stream where it is currently playing, Returns 1 or 0 if could successfully do so, because of quota. Automatically calls updates self internally.")
 desc("play(xwa:)", "Starts the stream or continues where it left off after pausing, Returns 1 or 0 if could successfully do so from quota. Automatically updates self internally.")
+--#endregion
 
--- Modify Object
+--#region Modify Object
 desc("setDirection(wxa:v)", "Sets the direction in which the WebAudio stream is playing towards without updating it. Remember to call ``self:update()`` when you are done modifying the object!")
 desc("setPos(xwa:v)", "Sets the 3D Position of the WebAudio stream without updating it. Remember to call ``self:update()`` when you are done modifying the object!")
 desc("setVolume(xwa:n)", "Sets the volume of the WebAudio stream, in percent format. 200 is 2x as loud as normal, 100 is default. Will error if it is past ``wa_volume_max``")
@@ -34,31 +41,39 @@ desc("setParent(xwa:)", "Unparents the stream")
 desc("setRadius(xwa:n)", "Sets the radius in which to the stream will be heard in. Default is 200 and (default) max is 1500.")
 desc("setLooping(xwa:n)", "If n is not 0, sets the stream to loop. Else stops looping.")
 desc("set3DEnabled(xwa:n)", "If n is not 0, sets the stream to be 3D. By default streams are 3D. Else, sets the audio to play directly on clients (mono audio).")
+--#endregion
 
--- is* Getters
+--#region is* Getters
 desc("isValid(xwa:)", "Returns 1 or 0 for whether the webaudio object is valid (If it is not destroyed & Not invalid from quota)")
 desc("isParented(xwa:)", "Returns 1 or 0 for whether the webaudio object is parented or not. Note that if the stream is parented, you cannot set it's position!")
+--#endregion
 
---- Getters
+--#region Getters
 desc("getPos(xwa:)", "Returns the current position of the WebAudio object. This does not work with parenting.")
 desc("getVolume(xwa:)", "Returns the volume of the WebAudio object set by setVolume")
 desc("getRadius(xwa:)", "Returns the radius of the WebAudio object set by setRadius")
 desc("getLooping(xwa:)", "Returns if the stream is looping, set by setLooping")
 desc("get3DEnabled(xwa:)", "Returns if the stream's 3D is enabled, set by set3DEnabled")
+--#endregion
 
--- Replicated Clientside behavior on server
+--#region Replicated Clientside behavior on server
 desc("getTime(xwa:)", "Returns the playback time of the stream in seconds.")
 desc("getState(xwa:)", "Returns the state of the stream. 0 is Stopped, 1 is Playing, 2 is Paused. See the CHANNEL_* constants")
+--#endregion
 
--- Info received from client
+--#region Info received from client
 desc("getLength(xwa:)", "Returns the playback duration of the stream in seconds. Will return -1 if couldn't get length.")
 desc("getFileName(xwa:)", "Returns the file name of the WebAudio stream. Will usually be the URL you give, but not always. Will return \"\" if we haven't received the name yet.")
 desc("getFFT(xwa:)", "Returns the fast fourier transform of the webaudio stream. It is an array of 64 numbers or less, ranging from 0 to 255")
+--#endregion
 
--- Aliases
+--#region Aliases
 desc("unparent(xwa:)", "Alias of xwa:setParent(), Unparents the stream")
 desc("parentTo(xwa:e)", "Alias of xwa:setParent(), Parents the stream to entity e")
+--#endregion
 
+--#region Ignore System
 desc("setIgnored(xwa:en)", "If n is not 0, blocks the given user from hearing the stream. Else, unblocks the user.")
 desc("setIgnored(xwa:rn)", "If n is not 0, sets the stream to ignore certain players. Else, unblocks them.")
 desc("getIgnored(xwa:e)", "Returns if the user is blocked from hearing the stream. Note this also counts if they purged the webaudio stream themself, but doesn't count if they have webaudio disabled. Set by setIgnored")
+--#endregion