Interface CFToolsClient

Hierarchy

  • CFToolsClient

Methods

  • Deletes an entry on the ban list for the provided player or ban. Given the player is not banned, this method does nothing. If the player has multiple bans in the ban list, an error will be thrown. Delete the ban by providing the ban you want to delete (as requested with the listBans method).

    This method will delete the ban, instead of just revoking it. The ban details will not be available in the banlist afterward anymore.

    Parameters

    Returns Promise<void>

  • Same as deleteBan(request: DeleteBanRequest) with the only difference, that this method will delete all bans of the player in that banlist. This includes expired and revoked bans!

    WARNING: This method will attempt to permanently delete all bans in the banlist for that player without any further confirmation.

    The performance of that operation depends on the underlying implementation. However, the time the operation takes may scale linear to the amount of entries for that player on the ban list. Consult the documentation of the implementation, if any, to find out more about this implementation detail.

    Parameters

    Returns Promise<void>

  • Executes a raw GameLabs action. Use this method only when you want to have more control over the parameters passed to GameLabs, which is not possible with the higher-level methods (like #spawnItem() o #teleport()), or when you want to execute an action that is not defined by GameLabs itself but by another extension integrating with GameLabs.

    Parameters

    Returns Promise<void>

  • Returns a list of CFTools resources that have authorized the application to access them.

    This request requires an authenticated client.

    Returns Promise<AppGrants>

  • Returns basic information of the CFTools server. This is information of the server entry in the CFTools Cloud platform. It does not contain the game server information, use getGameServerDetails() for such information.

    Parameters

    Returns Promise<ServerInfo>

  • Heals the player associated with the GameSession. Does nothing if the player is already healed.

    Requires the GameLabs integration to be installed on the server (the default serverApiId or the one provided in the request)

    Parameters

    Returns Promise<void>

  • Kills the player associated with the GameSession.

    Requires the GameLabs integration to be installed on the server (the default serverApiId or the one provided in the request)

    Parameters

    Returns Promise<void>

  • Creates a priority queue entry for the given player. The entry will grant the player either permanent or temporary priority queue access for the server. If the player already has a priority queue entry, this entry will be deleted before the new one is created.

    This request requires an authenticated client.

    Parameters

    Returns Promise<void>

  • Spawns the requested item class, if it exists, to the player associated with the requested GameSession ID. You can request a specific quantity; if you omit the parameter, the default value (1) will be used.

    Requires the GameLabs integration to be installed on the server (the default serverApiId or the one provided in the request)

    Parameters

    Returns Promise<void>

  • Teleports the player associated with the requested GameSession to the coordinates requested.

    Requires the GameLabs integration to be installed on the server (the default serverApiId or the one provided in the request)

    Parameters

    Returns Promise<void>

Generated using TypeDoc