discord-leveling-super/typings/managers/XPManager.d.ts

Easy and customizable leveling framework for your Discord bot.

// This file was generated automatically!
// I'm not responsible for the quality of this code!

// The module is made in TypeScript.
// See the source code here:
// https://github.com/shadowplay1/discord-leveling-super

// Thanks!

import { Guild, GuildMember, User } from 'discord.js';
import { LevelingOptions } from '../../typings/interfaces/LevelingOptions';
import Emitter from '../classes/Emitter';
/**
 * XP manager methods class.
 * @extends {Emitter}
 */
declare class XPManager extends Emitter {
    /**
     * Database Manager.
     * @type {DatabaseManager}
     * @private
     */
    private database;
    /**
     * XP manager methods class.
     * @param {LevelingOptions} options Leveling options object.
     */
    constructor(options: LevelingOptions);
    /**
     * Gets the XP for specified user.
     * @param {string | GuildMember | User} member Member or it's ID.
     * @param {string | Guild} guild Guild or it's ID.
     * @returns {number} Amount of XP.
     */
    get(member: string | GuildMember | User, guild: string | Guild): number;
    /**
     * Sets the XP for specified user.
     * @fires Leveling#setXP
     * @param {number} xp Amount of XP.
     * @param {string | GuildMember | User} member Member or it's ID.
     * @param {string | Guild} guild Guild or it's ID.
     * @param {boolean} onMessage The value will be true if the method was called on 'messageCreate' bot event.
     * @returns {boolean} If set successfully: true, else: false.
     */
    set(xp: number, member: string | GuildMember | User, guild: string | Guild, onMessage?: boolean): boolean;
    /**
     * Adds the XP for specified user.
     * @fires Leveling#addXP
     * @param {number} xp Amount of XP.
     * @param {string | GuildMember | User} member Member or it's ID.
     * @param {string | Guild} guild Guild or it's ID.
     * @param {boolean} onMessage The value will be true if the method was called on 'messageCreate' bot event.
     * @returns {boolean} If added successfully: true, else: false.
     */
    add(xp: number, member: string | GuildMember | User, guild: string | Guild, onMessage?: boolean): boolean;
    /**
     * Subtracts the XP for specified user.
     * @fires Leveling#subtractXP
     * @param {number} xp Amount of XP.
     * @param {string | GuildMember | User} member Member or it's ID.
     * @param {string | Guild} guild Guild or it's ID.
     * @returns {boolean} If subtracted successfully: true, else: false.
     */
    subtract(xp: number, member: string | GuildMember | User, guild: string | Guild): boolean;
}
export = XPManager;