minecraftcommandapi/src/commands/Achievement/AchievementCommandTo.ts

An API, which provides functions to generate Minecraft Commands

import { ICommand } from '../../core';
import { Achievement, AchievementCommandCommand } from './';

/**
 * @name IAchievementCommandTo
 * @description
 * Builder part of the AchievementCommand.
 * Adds a playername to a command.
 * Is used when calling 'Give' on IAchievementCommand
 */
export interface IAchievementCommandTo {
    /**
     * @name To
     * @description
     * Registers the given name to the command
     * @param {String} player Adds the given name to the command. Can also be @a or @p
     * @returns {ICommand} The final command, which can be generated.
     */
    To(player: String): ICommand
}

/**
 * @name AchievementCommandTo
 * @description
 * Builder part of the AchievementCommand.
 * Adds a playername to a command.
 * Is used when calling 'Give' on IAchievementCommand
 */
export class AchievementCommandTo implements IAchievementCommandTo {
    private isGiven: Boolean;
    private achievement: Achievement;
    /**
     * @description
     * Initializes the Object.
     * @param {Achievement} achievement The achievement to give to a player 
     */
    constructor(achievement: Achievement) {
        this.achievement = achievement;
    }
    /**
     * @name To
     * @description
     * Registers the playername to the command
     * @param {String} player The player you want to give the achievement.
     * @returns {AchievementCommandCommand} The final command, which can generate it as a string.
     */
    public To(player: String): ICommand {
        return new AchievementCommandCommand(true, this.achievement, player);
    }
}