com.ericramirezs.commando4j.command

Class Throttling

java.lang.Object

com.ericramirezs.commando4j.command.Throttling

public class Throttling
extends Object

Object for limiting the number of requests a guild can make in a certain period.

Constructor Summary

Constructors

Constructor and Description
Throttling(int usages, int duration, boolean globalThrottling) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addUsage(net.dv8tion.jda.api.events.Event event) Register a usage of a Command.
boolean	check(net.dv8tion.jda.api.events.Event event) Checks whether the ICommand can be used or if it has reached its limit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Throttling

public Throttling(int usages,
                  int duration,
                  boolean globalThrottling)

Creates a new instance.

Parameters:

usages - Limit of usages.

duration - how long until the command can be used again.

globalThrottling - true if limit is handled globally, false is limit is guild-based.

Method Detail

check

public boolean check(net.dv8tion.jda.api.events.Event event)

Checks whether the ICommand can be used or if it has reached its limit.

Parameters:

event - Event that triggered this call.

Returns:

true if the ICommand can be used, false otherwise..

addUsage

public void addUsage(net.dv8tion.jda.api.events.Event event)

Register a usage of a Command. It will also remove registry that are no longer valid.

Parameters:

event - Discord event that triggered this function call.