djs-systems
Version:
The simplest way to build complex Discord bots.
40 lines (39 loc) • 1.3 kB
TypeScript
import { User } from 'discord.js';
import { ExtendedInteraction, ExtendedMessage, CustomizableButton, CustomizableEmbed } from './typedef';
/**
* **Documentation Url** of the type: https://simplyd.js.org/docs/fun/rps#rpsbuttons
*/
export interface RpsButtons {
rock?: CustomizableButton;
paper?: CustomizableButton;
scissor?: CustomizableButton;
}
/**
* **Documentation Url** of the type: https://simplyd.js.org/docs/fun/rps#rpsembeds
*/
export interface RpsEmbeds {
request?: CustomizableEmbed;
win?: CustomizableEmbed;
draw?: CustomizableEmbed;
game?: CustomizableEmbed;
timeout?: CustomizableEmbed;
decline?: CustomizableEmbed;
}
/**
* **Documentation Url** of the options: https://simplyd.js.org/docs/fun/rps#rpsoptions
*/
export declare type rpsOptions = {
embed?: RpsEmbeds;
buttons?: RpsButtons;
opponent?: User;
strict?: boolean;
};
/**
* A classic RPS game, except this time it's on Discord to play with your pals, how cool is that ?
*
* @param msgOrint
* @param options
* @link `Documentation:` https://simplyd.js.org/docs/Fun/rps
* @example simplydjs.rps(interaction)
*/
export declare function rps(msgOrint: ExtendedMessage | ExtendedInteraction, options?: rpsOptions): Promise<User>;