UgCore.RateLimit

Server Runs in your resource. Net events and callbacks already have rate limits. Use this for your own checks, such as commands or server-side actions.

Create

UgCore.RateLimit.Create({ max, per }) -> limiter

integer

required

Burst size.

integer

required

Milliseconds to refill an empty bucket.

limiter:Consume

limiter:Consume(key) -> allowed, retryAfter

integer | string

required

Usually the player source.

boolean

integer

Milliseconds until a token is available. 0 when allowed.

limiter:Reset

limiter:Reset(key)

Called for you on playerDropped.

limiter:Prune

limiter:Prune() -> pruned

Drops full buckets. Behavior is unchanged. Called for you every 60 seconds.

limiter:Clear

limiter:Clear()

Drops every bucket.

Example

local limiter = UgCore.RateLimit.Create({ max = 3, per = 10000 })

local allowed, retryAfter = limiter:Consume(source)

if not allowed then
    UgCore.Guard.Flag(source, UgCore.Enums.Violations.RateLimited, 'my-shop:Rob')
    return
end

Overview

Core

Networking and security

Modules

Reference

UgCore.RateLimit

Create

limiter:Consume

limiter:Reset

limiter:Prune

limiter:Clear

Example

​Create

​limiter:Consume

​limiter:Reset

​limiter:Prune

​limiter:Clear

​Example

Create

limiter:Consume

limiter:Reset

limiter:Prune

limiter:Clear

Example