eh_GJBaseRequest

Inherits: HTTPRequest > Node > Object
Inherited by: eh_GJUsersAuthRequest, eh_GJUsersFetchRequest

Description

This Class is not to be used directly, rather it is the base class for all of GameJolt’s Endpoint Requests. This contains the base to build urls and manage responses

Properties

type property default value
String game_id Null
String private_key Null
String username Null
String user_token Null

Signals

  • gj_request_failed(error_dict)

Signal sent when requests fail. Sends an dictionary with details about the error.

Constants

  • USER_CREDENTIALS_PATH = res://addons/eh_jogos_game_jolt_api/gj_user_credentials.res — Path where user credentials are saved as a binary file custom resource.
  • GAME_CREDENTIALS = res://addons/eh_jogos_game_jolt_api/gj_game_credentials.res — Path where game credentials are saved as a binary file custom resource.
  • API_URL = https://api.gamejolt.com/api/game/ — Base url for api calls.
  • API_VERSION = v1_2 — API version to use. Will be added to base url to build request urls.
  • API_GAME_ID_PARAMETER = ?game_id= — Game Parameter string that will be added to all request urls.

Properties Descriptions

game_id

The game_id in Gamejolt. Should be set in the “GameJolt” Tab that appears in Project Settings after enabling the plugin.

private_key

The game’s private_key in Gamejolt. Should be set in the “GameJolt” Tab that appears in Project Settings after enabling the plugin.

username

The player’s username. Will be aquired automatically if the game was downloaded through GameJolt’s client. Otherwise, will be set by a login screen, but player only needs to login once.

user_token

The player’s game_token. Will be aquired automatically if the game was downloaded through GameJolt’s client. Otherwise, will be set by a login screen, but player only needs to login once.