Matter Hooks

The Matter Hooks plugin provides a way to use the Matter topoRuntime to use any hook made for Matter.

You can install it with,

[dependencies]
MatterHooks = "yetanotherclown/planck-matter-hooks@0.1.0-rc.1"

Then to set it up,

local Planck = require("@packages/Planck")
local Scheduler = Planck.Scheduler

local MatterHooks = require("@packages/MatterHooks")

local useDeltaTime = MatterHooks.useDeltaTime
local useEvent = MatterHooks.useEvent
local useThrottle = MatterHooks.useThrottle

local hooksPlugin = MatterHooks.new()

local scheduler = scheduler.new()
    :addPlugin(hooksPlugin)
    :addSystems(function()
        if useThrottle(5) then
            print("Throttled for 5 seconds")
        end
    end)

Using with Matter

To use Matter's Hooks in Matter, you still need to use this Plugin.

By default, the Plugin will look for the official Matter library in ReplicatedStorage/Packages/_Index. This should work if you're installing from Wally. If you're not, you can pass in a reference to the Matter library in the Plugin constructor.

local hooksPlugin = MatterHooks.new(ReplicatedStorage.Matter)

local scheduler = scheduler.new()
    :addPlugin(hooksPlugin)