Takaro - v0.4.9
    Preparing search index...

    GameServerApi - object-oriented interface

    GameServerApi

    Hierarchy

    • BaseAPI
      • GameServerApi
    Index

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: Configuration | undefined

    Methods

    • Give an item to a player. Accepts item UUID (preferred) or item code. Requires gameserver to be online and reachable. Depending on the underlying game implementation, it's possible that the item is dropped on the ground instead of placed directly in the player's inventory. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerGiveItem

      Parameters

      Returns Promise<AxiosResponse<void, any>>

      GameServerApi

    • Shuts down the gameserver. This is a 'soft' shutdown, meaning the gameserver will be stopped gracefully. If the gameserver is not reachable, this will have no effect. Note that most hosting providers will automatically restart the gameserver after a shutdown, which makes this operation act as a 'restart' instead. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerShutdown

      Parameters

      Returns Promise<AxiosResponse<void, any>>

      GameServerApi