gm_throttle

A library for Garry's Mod that allows simple, dynamic, and feature-rich rate limiting of functions

Installation

Simple

• You can download the latest release .zip from the Releases tab. Extract that and place it in your addons directory.

Source Controlled

• You can clone this repository directly into your addons directory, but be sure to check out the lua branch which contains the compiled Lua from the latest release.
• e.g. git clone --single-branch --branch lua [email protected]:CFC-Servers/gm_throttle.git

Assuming you can get the project cloned (some hosting interfaces may not support this), any auto-updater software should work just fine.

Usage

There are some comprehensive examples in the examples folder, but a very simple usage example follows:

( Read more about the Throttle Struct below )

require( "throttler" )

-- The first step is to create a Throttler struct
-- You can build a generic pre-filled structure and overwrite specific values:
local struct = Throttler:build()
struct.delay = 0.5 -- In seconds
struct.budget = 500

struct.failure = function( ent )
    ent.Owner:ChatPrint( "The thing was throttled!" )
end

struct.shouldSkip = function( ent )
    if ent.Owner:IsAdmin() then return true end
end

-- Once you have your Throttle Struct, you can use it to stub a function:
MyLib = {
    spammyFunction = function( ent )
        local data = ent:GetExpensiveThing()
        performExpensiveCalculation( data )
    end
}

local throttle = Throttler:create( MyLib.spammyFunction, struct )
MyLib.spammyFunction = throttle

The Throttle Structure