@ariusii/intersect.ts/dist/endpoints/variables.d.ts

The Intersect Engine API Client Library based on TS.

/**
 * This is the Variables Class, it contains all the methods to handle the Variables.
 * Those actions do not require any Query Role.
 * @class Variables
 * @link https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/variables.html
 * @author AriusII
 */
export declare class Variables {
    private _url;
    private _token;
    constructor(_url: string, _token: string);
    /**
     * Retrieves global variables from the server along with their ids and values.
     * @param page - The page number you want to retrieve.
     * @param count - The number of variables you want to retrieve.
     * @returns - The response from the server.
     */
    getVariables(page: number, count: number): Promise<any>;
    /**
     * Retrieves a variable and it's value from the server by id.
     * @param variableid - The variable ID you want to retrieve the value for.
     * @returns - The response from the server.
     */
    getVariable(variableid: string): Promise<any>;
    /**
     * Sets a specified variable's value given it's id.
     * @param variableid - The variable ID you want to set the value for.
     * @param value - The value you want to set the variable to.
     * @returns - The response from the server.
     */
    setVariableValue(variableid: string, value: number): Promise<any>;
    /**
     * Retrieves the stored value of a variable from the server by id.
     * @param variableid - The variable ID you want to retrieve the value for.
     * @returns - The response from the server.
     */
    getVariableValue(variableid: string): Promise<any>;
}
//# sourceMappingURL=variables.d.ts.map