Add devtools interface

Author: marchc1

lua/acf_devtools/cfw_contraption_funcs.lua

@@ -0,0 +1,76 @@
+local ACF_DevTools = ACF_DevTools
+local EventViewer = ACF_DevTools.EventViewer
+
+do
+    local Created = EventViewer.DefineEvent("CFW.Contraption.Created")
+    Created.Icon = "icon16/add.png"
+
+    function Created.BuildNode(Node)
+
+    end
+end
+
+local function RenderEntity3D(Entity)
+    if not IsValid(Entity) then return end
+
+    local pulse = Lerp((math.sin(CurTime() * 7) + 1) / 2, 0.33, 1)
+
+    render.SuppressEngineLighting(true)
+    render.ModelMaterialOverride(Material("models/debug/debugwhite"))
+    render.SetColorModulation(pulse, pulse, pulse)
+
+    render.DepthRange(0, 0)
+    Entity:DrawModel()
+    render.DepthRange(0, 1)
+
+    render.SetColorModulation(1, 1, 1)
+    render.ModelMaterialOverride(nil)
+    render.SuppressEngineLighting(false)
+end
+
+do
+    local EntityAdded = EventViewer.DefineEvent("CFW.Contraption.EntityAdded")
+    EntityAdded.Icon = "icon16/basket_put.png"
+
+    function EntityAdded.BuildNode(Node, Entity)
+        EventViewer.AddKeyValueNode(Node, "Entity", Entity, "icon16/brick.png")
+    end
+    EntityAdded.Render3D = RenderEntity3D
+end
+
+do
+    local EntityRemoved = EventViewer.DefineEvent("CFW.Contraption.EntityRemoved")
+    EntityRemoved.Icon = "icon16/basket_remove.png"
+
+    function EntityRemoved.BuildNode(Node, Entity)
+        EventViewer.AddKeyValueNode(Node, "Entity", Entity, "icon16/brick.png")
+    end
+    EntityRemoved.Render3D = RenderEntity3D
+end
+
+do
+    local Merged = EventViewer.DefineEvent("CFW.Contraption.Merged")
+    Merged.Icon = "icon16/arrow_merge.png"
+
+    function Merged.BuildNode(Node, Other)
+        EventViewer.AddKeyValueNode(Node, "Merged Into", Other, "icon16/bricks.png")
+    end
+end
+
+do
+    local Split = EventViewer.DefineEvent("CFW.Contraption.Split")
+    Split.Icon = "icon16/arrow_divide.png"
+
+    function Split.BuildNode(Node, Other)
+        EventViewer.AddKeyValueNode(Node, "Split Into", Other, "icon16/bricks.png")
+    end
+end
+
+do
+    local Removed = EventViewer.DefineEvent("CFW.Contraption.Removed")
+    Removed.Icon = "icon16/cancel.png"
+
+    function Removed.BuildNode(Node)
+
+    end
+end

lua/cfw/core/devtools_interface.lua

@@ -0,0 +1,33 @@
+-- Generic interface for ACF-3 Devtools
+-- https://github.com/ACF-Team/ACF-3-DevTools
+local AddonName = "CFW"
+local Addon     = _G[AddonName]
+Addon.EventViewer = Addon.EventViewer or {}
+Addon.EntityKeyValues = Addon.EntityKeyValues or {}
+
+function Addon.EventViewer.Enabled() return false end
+function Addon.EntityKeyValues.Enabled() return false end
+
+hook.Add("Initialize", AddonName .. "_SetupStubForDevTools", function()
+    table.Empty(Addon.EventViewer)
+    table.Empty(Addon.EntityKeyValues)
+
+    if not ACF_DevTools then
+        -- NOTHING should run event viewer code unless this is enabled
+        function Addon.EventViewer.Enabled() return false end
+        function Addon.EntityKeyValues.Enabled() return false end
+        -- ^^^ respect this 100%
+        -- I don't want to maintain a bunch of stubs here.
+    else
+        -- This may become a real function sometime in the underlying implementation.
+        -- For now, this is just an easier way to handle this.
+        -- I would rename it to Available to be more clear, but I don't want to have to
+        -- do like, .Available() and .Enabled() in the future...
+        function Addon.EntityKeyValues.Enabled() return true end
+
+        setmetatable(Addon.EventViewer, {__index = ACF_DevTools.EventViewer})
+        setmetatable(Addon.EntityKeyValues, {__index = ACF_DevTools.EntityKeyValues})
+
+        hook.Run(AddonName .. "_ACF3DevToolsInitialized")
+    end
+end)

lua/cfw/devtools_hooks.lua

@@ -0,0 +1,53 @@
+local EventViewer = CFW.EventViewer
+
+local function GetEventViewerName(Contraption) return "Contraption: " .. tostring(Contraption):sub(8) end
+local function InitializeHooks(Enabled)
+    if not Enabled then
+        hook.Remove("cfw.contraption.created", "CFW_DevtoolsHooks")
+        hook.Remove("cfw.contraption.entityAdded", "CFW_DevtoolsHooks")
+        hook.Remove("cfw.contraption.entityRemoved", "CFW_DevtoolsHooks")
+        hook.Remove("cfw.contraption.merged", "CFW_DevtoolsHooks")
+        hook.Remove("cfw.contraption.split", "CFW_DevtoolsHooks")
+        hook.Remove("cfw.contraption.removed", "CFW_DevtoolsHooks")
+        return
+    end
+
+    hook.Add("cfw.contraption.created", "CFW_DevtoolsHooks", function(self)
+        if EventViewer.Enabled() then
+            EventViewer.AppendEvent(GetEventViewerName(self), "CFW.Contraption.Created")
+        end
+    end)
+
+    hook.Add("cfw.contraption.entityAdded", "CFW_DevtoolsHooks", function(self, ent)
+        if EventViewer.Enabled() then
+            EventViewer.AppendEvent(GetEventViewerName(self), "CFW.Contraption.EntityAdded", ent)
+        end
+    end)
+
+    hook.Add("cfw.contraption.entityRemoved", "CFW_DevtoolsHooks", function(self, ent)
+        if EventViewer.Enabled() then
+            EventViewer.AppendEvent(GetEventViewerName(self), "CFW.Contraption.EntityRemoved", ent)
+        end
+    end)
+
+    hook.Add("cfw.contraption.merged", "CFW_DevtoolsHooks", function(self, mergedInto)
+        if EventViewer.Enabled() then
+            EventViewer.AppendEvent(GetEventViewerName(self), "CFW.Contraption.Merged", GetEventViewerName(mergedInto))
+        end
+    end)
+
+    hook.Add("cfw.contraption.split", "CFW_DevtoolsHooks", function(self, mergedInto)
+        if EventViewer.Enabled() then
+            EventViewer.AppendEvent(GetEventViewerName(self), "CFW.Contraption.Split", GetEventViewerName(mergedInto))
+        end
+    end)
+
+    hook.Add("cfw.contraption.removed", "CFW_DevtoolsHooks", function(self)
+        if EventViewer.Enabled() then
+            EventViewer.AppendEvent(GetEventViewerName(self), "CFW.Contraption.Removed")
+        end
+    end)
+end
+
+hook.Add("ACF3_DevTools_EnableChanged", "CFW_Hook", InitializeHooks)
+InitializeHooks(CFW.EventViewer.Enabled())