Merge hook-docs branch

lua/acf/ballistics/ballistics_cl.lua

@@ -19,7 +19,7 @@ local function BulletFlight(Bullet, DeltaTime)
 	Debug.Line(Bullet.SimPosLast, Bullet.SimPos, 15, Yellow)
 end
 
-hook.Add("ACF_OnClock", "ACF_ManageBulletEffects", function(_, DeltaTime)
+hook.Add("ACF_OnTick", "ACF_ManageBulletEffects", function(_, DeltaTime)
 	for _, Bullet in pairs(ACF.BulletEffect) do
 		BulletFlight(Bullet, DeltaTime)
 	end

lua/acf/ballistics/ballistics_sv.lua

@@ -1,3 +1,4 @@
+local hook       = hook
 local ACF        = ACF
 local Ballistics = ACF.Ballistics
 local Damage     = ACF.Damage
@@ -17,7 +18,6 @@ local SkyGraceZone = 100
 local FlightTr     = { start = true, endpos = true, filter = true, mask = true }
 local GlobalFilter = ACF.GlobalFilter
 local AmmoTypes    = ACF.Classes.AmmoTypes
-local HookRun      = hook.Run
 
 
 -- This will create, or update, the tracer effect on the clientside
@@ -52,7 +52,7 @@ function Ballistics.RemoveBullet(Bullet)
 	Bullet.Removed = true
 
 	if not next(Bullets) then
-		hook.Remove("ACF_OnClock", "ACF Iterate Bullets")
+		hook.Remove("ACF_OnTick", "ACF Iterate Bullets")
 	end
 end
 
@@ -148,7 +148,7 @@ function Ballistics.CreateBullet(BulletData)
 	end
 
 	if not next(Bullets) then
-		hook.Add("ACF_OnClock", "ACF Iterate Bullets", Ballistics.IterateBullets)
+		hook.Add("ACF_OnTick", "ACF Iterate Bullets", Ballistics.IterateBullets)
 	end
 
 	Bullets[Index] = Bullet
@@ -200,15 +200,17 @@ function Ballistics.TestFilter(Entity, Bullet)
 
 	if GlobalFilter[Entity:GetClass()] then return false end
 
-	if HookRun("ACF_OnFilterBullet", Entity, Bullet) == false then return false end
+	if not hook.Run("ACF_OnFilterBullet", Entity, Bullet) then return false end
 
 	if Entity._IsSpherical then return false end -- TODO: Remove when damage changes make props unable to be destroyed, as physical props can have friction reduced (good for wheels)
 
 	return true
 end
 
 function Ballistics.DoBulletsFlight(Bullet)
-	if HookRun("ACF Bullet Flight", Bullet) == false then return end
+	local CanFly = hook.Run("ACF_PreBulletFlight", Bullet)
+
+	if not CanFly then return end
 
 	if Bullet.SkyLvL then
 		if Clock.CurTime - Bullet.LifeTime > 30 then
@@ -276,7 +278,7 @@ function Ballistics.DoBulletsFlight(Bullet)
 		else
 			local Entity = traceRes.Entity
 
-			if Ballistics.TestFilter(Entity, Bullet) == false then
+			if not Ballistics.TestFilter(Entity, Bullet) then
 				table.insert(Bullet.Filter, Entity)
 				Ballistics.DoBulletsFlight(Bullet) -- Retries the same trace after adding the entity to the filter, important incase something is embedded in something that shouldn't be hit
 

lua/acf/contraption/seats_sv.lua

@@ -72,7 +72,7 @@ hook.Add("OnEntityCreated", "ACF_SeatLegality", function(Entity)
     end)
 end)
 
-hook.Add("ACF_IsLegal", "ACF_CheckLegal_SeatLegality", function(Entity)
+hook.Add("ACF_OnCheckLegal", "ACF_CheckLegal_SeatLegality", function(Entity)
     if not ACF.VehicleLegalChecks then return end
     if not Entity:IsVehicle() then return end
 

lua/acf/core/classes/entities/registration.lua

@@ -131,7 +131,7 @@ do -- Spawning and updating
 
 		local HookResult, HookMessage = hook.Run("ACF_CanCreateEntity", Class, Player, Position, Angles, Data)
 
-		if HookResult == false then return false, HookMessage end
+		if not HookResult then return false, HookMessage end
 
 		local Entity = ClassData.Spawn(Player, Position, Angles, Data)
 

lua/acf/core/classes/grouped.lua

@@ -31,7 +31,7 @@ function Classes.AddGroup(ID, Destiny, Data)
 		Group[K] = V
 	end
 
-	hook.Run("ACF_OnNewClassGroup", ID, Group)
+	hook.Run("ACF_OnCreateGroup", ID, Group)
 
 	return Group
 end
@@ -68,7 +68,7 @@ function Classes.AddGroupItem(ID, GroupID, Destiny, Data)
 		Class[K] = V
 	end
 
-	hook.Run("ACF_OnNewGroupedClass", ID, Group, Class)
+	hook.Run("ACF_OnCreateGroupItem", ID, Group, Class)
 
 	return Class
 end
@@ -188,13 +188,13 @@ function Classes.AddGroupedFunctions(Namespace, Entries)
 	end
 end
 
-hook.Add("ACF_OnNewClassGroup", "ACF Precache Model", function(_, Group)
+hook.Add("ACF_OnCreateGroup", "ACF Precache Model", function(_, Group)
 	if not isstring(Group.Model) then return end
 
 	util.PrecacheModel(Group.Model)
 end)
 
-hook.Add("ACF_OnNewGroupedClass", "ACF Precache Model", function(_, _, Class)
+hook.Add("ACF_OnCreateGroupItem", "ACF Precache Model", function(_, _, Class)
 	if not isstring(Class.Model) then return end
 
 	util.PrecacheModel(Class.Model)

lua/acf/core/classes/object.lua

@@ -64,7 +64,7 @@ local function AttachMetaTable(Class, Base)
 			Class:OnLoaded()
 		end
 
-		hook.Run("ACF_OnClassLoaded", Class.ID, Class)
+		hook.Run("ACF_OnLoadClass", Class.ID, Class)
 
 		Class.Loaded = true
 	end)
@@ -102,7 +102,7 @@ function Classes.AddObject(ID, Base, Destiny)
 	return Class
 end
 
-hook.Add("ACF_OnClassLoaded", "ACF Model Precache", function(_, Class)
+hook.Add("ACF_OnLoadClass", "ACF Model Precache", function(_, Class)
 	if not isstring(Class.Model) then return end
 
 	util.PrecacheModel(Class.Model)

lua/acf/core/classes/simple.lua

@@ -29,7 +29,7 @@ function Classes.AddSimple(ID, Destiny, Data)
 		Class[K] = V
 	end
 
-	hook.Run("ACF_OnNewSimpleClass", ID, Class)
+	hook.Run("ACF_OnCreateItem", ID, Class)
 
 	return Class
 end
@@ -101,7 +101,7 @@ function Classes.AddSimpleFunctions(Namespace, Entries)
 	end
 end
 
-hook.Add("ACF_OnNewSimpleClass", "ACF Precache Model", function(_, Class)
+hook.Add("ACF_OnCreateItem", "ACF Precache Model", function(_, Class)
 	if not isstring(Class.Model) then return end
 
 	util.PrecacheModel(Class.Model)

lua/acf/core/globals.lua

@@ -227,7 +227,7 @@ do -- Player loaded hook
 		util.AddNetworkString("ACF_PlayerLoaded")
 
 		net.Receive("ACF_PlayerLoaded", function(_, Player)
-			hook.Run("ACF_OnPlayerLoaded", Player)
+			hook.Run("ACF_OnLoadPlayer", Player)
 		end)
 	else
 		hook.Add("InitPostEntity", "ACF Player Loaded", function()
@@ -287,7 +287,7 @@ do -- Smoke/Wind -----------------------------------
 			end
 		end)
 
-		hook.Add("ACF_OnPlayerLoaded", "ACF Send Smoke Wind", function(Player)
+		hook.Add("ACF_OnLoadPlayer", "ACF Send Smoke Wind", function(Player)
 			net.Start("acf_smokewind")
 				net.WriteFloat(ACF.SmokeWind)
 			net.Send(Player)

lua/acf/core/networking/data_vars/data_vars_cl.lua

@@ -62,7 +62,7 @@ do -- Server data var syncronization
 			if Values[K] ~= V then
 				Values[K] = V
 
-				hook.Run("ACF_OnServerDataUpdate", nil, K, V)
+				hook.Run("ACF_OnUpdateServerData", nil, K, V)
 			end
 
 			Received[K] = nil
@@ -135,7 +135,7 @@ do -- Client data setter function
 		if Forced or Client[Key] ~= Value then
 			Client[Key] = Value
 
-			hook.Run("ACF_OnClientDataUpdate", LocalPlayer(), Key, Value)
+			hook.Run("ACF_OnUpdateClientData", LocalPlayer(), Key, Value)
 
 			NetworkData(Key)
 		end
@@ -162,7 +162,7 @@ do -- Server data setter function
 		if Forced or Server[Key] ~= Value then
 			Server[Key] = Value
 
-			hook.Run("ACF_OnServerDataUpdate", Player, Key, Value)
+			hook.Run("ACF_OnUpdateServerData", Player, Key, Value)
 
 			NetworkData(Key, true)
 		end

lua/acf/core/networking/data_vars/data_vars_sv.lua

@@ -119,7 +119,7 @@ do -- Data syncronization
 		end
 	})
 
-	hook.Add("ACF_OnPlayerLoaded", "ACF Data Var Syncronization", function(Player)
+	hook.Add("ACF_OnLoadPlayer", "ACF Data Var Syncronization", function(Player)
 		-- Server data var syncronization
 		for Key in pairs(Server) do
 			NetworkData(Key, Player)
@@ -198,7 +198,7 @@ do -- Server data setter function
 		if Forced or Server[Key] ~= Value then
 			Server[Key] = Value
 
-			hook.Run("ACF_OnServerDataUpdate", nil, Key, Value)
+			hook.Run("ACF_OnUpdateServerData", nil, Key, Value)
 
 			NetworkData(Key)
 		end

lua/acf/core/networking/model_data/model_data_cl.lua

@@ -22,7 +22,7 @@ end
 -- @param Model The model to queue the callback for.
 -- @param Object Anything that won't fail the IsValid check, usually panels or entities.
 -- @param Callback The function to call when the model data is received.
-function ModelData.QueueRefresh(Model, Object, Callback)
+function ModelData.CallOnReceive(Model, Object, Callback)
 	if not IsValid(Object) then return end
 	if not isfunction(Callback) then return end
 
@@ -42,6 +42,22 @@ function ModelData.QueueRefresh(Model, Object, Callback)
 	end
 end
 
+function ModelData.RunCallbacks(Model)
+	local Data = Callbacks[Model]
+
+	if not Data then return end
+
+	for Object, Callback in pairs(Data) do
+		if IsValid(Object) then
+			Callback(Object, Model)
+		end
+
+		Data[Object] = nil
+	end
+
+	Callbacks[Model] = nil
+end
+
 function ModelData.GetModelData(Model)
 	local Path = ModelData.GetModelPath(Model)
 
@@ -69,7 +85,7 @@ hook.Add("ACF_OnLoadAddon", "ACF_ModelData", function()
 			Standby[Model] = nil
 			Models[Model]  = Data
 
-			hook.Run("ACF_OnReceivedModelData", Model, Data)
+			hook.Run("ACF_OnReceiveModelData", Model, Data)
 		end
 
 		Entity:CallOnRemove("ACF_ModelData", function()
@@ -104,7 +120,7 @@ hook.Add("ACF_OnLoadAddon", "ACF_ModelData", function()
 		Standby[Model] = true
 		Queue[Model]   = true
 
-		hook.Run("ACF_OnRequestedModelData", Model)
+		hook.Run("ACF_OnRequestModelData", Model)
 	end)
 
 	Network.CreateReceiver("ACF_ModelData", function(Data)
@@ -117,15 +133,15 @@ hook.Add("ACF_OnLoadAddon", "ACF_ModelData", function()
 				Standby[Model] = nil
 				Models[Model]  = Info
 
-				hook.Run("ACF_OnReceivedModelData", Model, Info)
+				hook.Run("ACF_OnReceiveModelData", Model, Info)
 			end
 		end
 	end)
 
 	hook.Remove("ACF_OnLoadAddon", "ACF_ModelData")
 end)
 
-hook.Add("ACF_OnReceivedModelData", "ACF_ModelData_PanelRefresh", function(Model)
+hook.Add("ACF_OnReceiveModelData", "ACF_ModelData_PanelRefresh", function(Model)
 	local Data = Callbacks[Model]
 
 	if not Data then return end
@@ -139,4 +155,4 @@ hook.Add("ACF_OnReceivedModelData", "ACF_ModelData_PanelRefresh", function(Model
 	end
 
 	Callbacks[Model] = nil
-end)
+end)

lua/acf/core/networking/model_data/model_data_sv.lua

@@ -43,7 +43,7 @@ do -- Pointer entity creation
 		hook.Remove("InitPostEntity", "ACF_ModelData")
 	end)
 
-	hook.Add("ACF_OnPlayerLoaded", "ACF_ModelData", function(Player)
+	hook.Add("ACF_OnLoadPlayer", "ACF_ModelData", function(Player)
 		Network.Send("ACF_ModelData_Entity", Player, ModelData.Entity)
 	end)
 

lua/acf/core/utilities/clock/clock.lua

@@ -10,5 +10,5 @@ hook.Add("Think", "ACF Clock Update", function()
 	Clock.DeltaTime = Delta
 	Clock.CurTime   = Now
 
-	hook.Run("ACF_OnClock", New, Delta)
+	hook.Run("ACF_OnTick", New, Delta)
 end)

lua/acf/core/validation_sv.lua

@@ -42,9 +42,9 @@ function ACF.IsLegal(Entity)
 	if Entity.IsACFWeapon and not ACF.GunsCanFire then return false, "Cannot fire", "Firing disabled by the servers ACF settings." end
 	if Entity.IsRack and not ACF.RacksCanFire then return false, "Cannot fire", "Firing disabled by the servers ACF settings." end
 
-	local Legal, Reason, Message, Timeout = hook.Run("ACF_IsLegal", Entity)
+	local Legal, Reason, Message, Timeout = hook.Run("ACF_OnCheckLegal", Entity)
 
-	if Legal ~= nil then return Legal, Reason, Message, Timeout end
+	if not Legal then return Legal, Reason, Message, Timeout end
 
 	return true
 end
@@ -171,7 +171,7 @@ function ACF.UpdateThickness(Entity, PhysObj, Area, Ductility)
 	return math.Clamp(Armor, MinimumArmor, MaximumArmor)
 end
 
-hook.Add("ACF_OnServerDataUpdate", "ACF_MaxThickness", function(_, Key, Value)
+hook.Add("ACF_OnUpdateServerData", "ACF_MaxThickness", function(_, Key, Value)
 	if Key ~= "MaxThickness" then return end
 
 	MaximumArmor = math.floor(ACF.CheckNumber(Value, ACF.MaximumArmor))

lua/acf/core/version/version_cl.lua

@@ -25,7 +25,7 @@ do -- Server syncronization and status printing
 
 			ACF.CheckLocalStatus(Name)
 
-			hook.Run("ACF_UpdatedRepository", Name, Repos[Name])
+			hook.Run("ACF_OnFetchRepository", Name, Repos[Name])
 		end
 	end)
 

lua/acf/core/version/version_sv.lua

@@ -121,7 +121,7 @@ end
 do -- Client syncronization
 	util.AddNetworkString("ACF_VersionSync")
 
-	hook.Add("ACF_OnPlayerLoaded", "ACF_VersionSync", function(Player)
+	hook.Add("ACF_OnLoadPlayer", "ACF_VersionSync", function(Player)
 		local JSON = util.TableToJSON(Repos)
 
 		net.Start("ACF_VersionSync")

lua/acf/damage/explosion_sv.lua

@@ -29,7 +29,7 @@ function Damage.isValidTarget(Entity)
 	local Type = EntACF and EntACF.Type or ACF.Check(Entity)
 
 	if not Type then return false end
-	if Ballistics.TestFilter(Entity) == false then return false end
+	if not Ballistics.TestFilter(Entity) then return false end
 
 	if Type ~= "Squishy" then return true end
 

lua/acf/damage/ke_shove_sv.lua

@@ -8,7 +8,7 @@ function ACF.KEShove(Target, Pos, Vec, KE)
 	if not IsValid(Target) then return end
 	if Target.ACF_Killed then return end
 
-	if hook.Run("ACF_KEShove", Target, Pos, Vec, KE) == false then return end
+	if not hook.Run("ACF_OnPushEntity", Target, Pos, Vec, KE) then return end
 
 	local Ancestor = Target:GetAncestor()
 	local Phys = Ancestor:GetPhysicsObject()

lua/acf/damage/permissions/permissions_sv.lua

@@ -627,4 +627,4 @@ local m = table.KeyFromValue(this.Modes, this.DamagePermission)
 if not m then
 	this.DamagePermission = function() end
 	hook.Run("ACF_ProtectionModeChanged", "default", nil)
-end
+end