GameJolt-API-Haxe-bindings

Library-independent Haxe bindings for the GameJolt API. Works with Haxe 3.3.0

This library follows the same structure as the official GameJolt Game API.

Package overview

• package gameJoltAPI
  • class Batch
    • function getRequestSucess
    • function getResponse
    • function start
    • function request
    • function end
  • class Users
    • function fetch
    • function auth
  • class Sessions
    • function open
    • function ping
    • function check
    • function close
  • class Trophies
    • function fetch
    • function addAchieved
  • class Scores
    • function fetch
    • function add
    • function getRank
    • function tables
  • class DataStore
    • function fetch
    • function set
    • function update
    • function remove
    • function getKeys
  • class GetTime
    • function fetch
  • class Utils
    • var game_id
    • var gamePrivKey
    • var user_id
    • var user_token
    • var username

The library works as follows :

• First of all, you, the developer, must set the variables Utils.game_id : Int and Utils.gamePrivKey : String. No call to the GameJolt API will work if you skip this step.
• Any call made using this library follows the documentation you can find on the actual GameJolt API pages. Version 1.1 adds support for the unreleased additional GameJolt API functions which can be found here.
• Every class has their own result : Dynamic and lastRequestSuccess : Bool variable. They are used to store a call's return value, once parsed through Json.parse() in the case of result. Thus, to access return values as described in the GameJolt API doc, you must use result.response as a base variable.

Example :

import gameJoltAPI.Users;
import gameJoltAPI.Utils;

class Main
{
    static public function main()
    {
        Utils.game_id = 12345;
        Utils.gamePrivKey = "12345678912345678912345678912345";
        Users.fetch("matrefeytontias");
        if(Users.lastRequestSuccess)
        {
            var d = Users.result.users[0];
            trace(d.id, d.type, d.last_logged_in);
        }
    }
}

Differences from the original API

The main difference is that every parameter that could be given as a comma-separated list of numbers with the original API must here be Array<Int>, even if a single number is given. Examples include the user_id parameter of Users.fetch. Additionally, this library implements its own way of dealing with Batch requests, which is documented in Batch.hx.

Contact

If you have any question or suggestion, feel free to send a mail to mattias@refeyton.fr .