FlxGameJolt Update #461

GamerPablito · 2025-05-01T18:52:57Z

fixes #406
I've implemented the new functions the GameJolt API v1.2 has to offer, including batch requests and better load of the images.

Geokureli

In the future please make a feature branch on your fork, rather than using GamerPablito:dev, but this is fine
Keep the old FlxGameJolt and deprecate it
You should update the FlxPongAPI demo, which is our demonstration of the FlxGameJolt api. this will allow people to learn the new system, and it will allow me to test this branch

Geokureli · 2025-05-06T12:35:46Z

flixel/addons/api/gamejolt/FlxGameJoltScore.hx

+/**
+ * The way the scores are fetched from your game API.
+ * 
+ * @param score The display text of the Score.
+ * @param sort The Score value.
+ * @param extra_data If some extra data is attached to this Score, it'll be shown here.
+ * @param user The username of the User who achieved this Score, if it's a registered User.
+ * @param user_id The user ID of the User who achieved this Score, if it's a registered User.
+ * @param guest The name of the user who achieved this Score, if it's a guest user.
+ * @param stored A short description about when the Score was achieved by the User or Guest.
+ * @param stored_timestamp A long time stamp (in seconds) of when the Score was achieved by the User or Guest.
+ */
+typedef FlxGameJoltScore =
+{
+	score:String,
+	sort:Int,
+	extra_data:String,
+	user:String,
+	user_id:Int,
+	guest:String,
+	stored:String,
+	stored_timestamp:Int
+}


This style of comment isn't as helpful as the following, which shows a description for each field on hover:

Suggested change

/**

* The way the scores are fetched from your game API.

*

* @param score The display text of the Score.

* @param sort The Score value.

* @param extra_data If some extra data is attached to this Score, it'll be shown here.

* @param user The username of the User who achieved this Score, if it's a registered User.

* @param user_id The user ID of the User who achieved this Score, if it's a registered User.

* @param guest The name of the user who achieved this Score, if it's a guest user.

* @param stored A short description about when the Score was achieved by the User or Guest.

* @param stored_timestamp A long time stamp (in seconds) of when the Score was achieved by the User or Guest.

*/

typedef FlxGameJoltScore =

{

score:String,

sort:Int,

extra_data:String,

user:String,

user_id:Int,

guest:String,

stored:String,

stored_timestamp:Int

}

/**

* A score fetched from the gamejolt server.

*/

typedef FlxGameJoltScore =

{

/** The display text of the Score. */

var score:String;

/** The Score value. */

var sort:Int;

/** If some extra data is attached to this Score, it'll be shown here. */

var extra_data:String;

/** The username of the User who achieved this Score, if it's a registered User. */

var user:String;

/** The user ID of the User who achieved this Score, if it's a registered User. */

var user_id:Int;

/** The name of the user who achieved this Score, if it's a guest user. */

var guest:String;

/** A short description about when the Score was achieved by the User or Guest. */

var stored:String;

/** A long time stamp (in seconds) of when the Score was achieved by the User or Guest. */

var stored_timestamp:Int;

}

Also note: Wherever possible you should copy the documentation of these fields directly from gamejolt's api. specifically, the phrasing "The way the ___ are fetched" is not ideal, that describes a process, when these typedefs describe objects

Apply these changes to every typedef

Geokureli · 2025-05-06T12:37:54Z

flixel/addons/api/gamejolt/FlxGameJoltScore.hx

+	user_id:Int,
+	guest:String,
+	stored:String,
+	stored_timestamp:Int


If this is described as a "long" does it need to use Int64

Geokureli · 2025-05-06T12:55:28Z

flixel/addons/api/gamejolt/FlxGameJolt.hx

+	 * Creates a new section for URL creation. The `requestBatch()` function requires this for its entries to work correctly.
+	 * @param command The command of the call section.
+	 * @param action The action (if there's any) of the call section.
+	 * @param params The parameters the call will take in count when requested.
+	 * @param encode Whether to encode along with a signature at its end or not.
+	 * @return The resulting section.
+	 */


Please use the following doc format:

Suggested change

* Creates a new section for URL creation. The `requestBatch()` function requires this for its entries to work correctly.

* @param command The command of the call section.

* @param action The action (if there's any) of the call section.

* @param params The parameters the call will take in count when requested.

* @param encode Whether to encode along with a signature at its end or not.

* @return The resulting section.

*/

* Creates a new section for URL creation. The `requestBatch()` function requires this for its entries to work correctly.

* @param command The command of the call section.

* @param action The action (if there's any) of the call section.

* @param params The parameters the call will take in count when requested.

* @param encode Whether to encode along with a signature at its end or not.

* @return The resulting section.

*/

Note: 3 spaces after @param, all param names have spaces so the descriptions start on the same column, 2 spaces after @return

You missed the note at the bottom

Note: 3 spaces after @param, all param names have spaces so the descriptions start on the same column, 2 spaces after @return

I've already rewritten the entire FlxGameJolt class, and the descriptions finally fit according to how did you describe it to me, check it out

Geokureli · 2025-05-06T12:56:32Z

flixel/addons/api/gamejolt/FlxGameJolt.hx

+	/**
+	 * Sends multiple calls in a single request to the GameJolt API to process.
+	 * @see 	https://gamejolt.com/game-api/doc/batch/
+	 * @param	calls The list of calls to send to the batch. You can set up to 50 calls per batch. NOTE: Use `buildURLSection()` with its parameter `encode` set to `true` for the creation of every call you want to add here.
+	 * @param	parallel Whether to run every call at once (true) or in the order they were set (false).
+	 * @param	break_on_error Whether to return an error message in the main response body if one or more calls fail or not.
+	 * @param	onComplete	Callback that will contain the requested data, if the request ends successfully.
+	 * @param	onError	Callback that will contain the error information of the request, if the request fails.
+	 * @param	onProgress	Callback that will be called while the request is loading results.
+	 * @return The request instance.
+	 */
+	public static function requestBatch(calls:Array<String>, parallel:Bool = false, break_on_error:Bool = true, ?onComplete:Array<FlxGameJoltResponse>->Void,
+			?onError:String->Void,
+			?onProgress:Float->Float->Void):URLLoader
+	{
+		var params:Array<Param> = calls.map(c -> {key: "responses[]", value: c.urlEncode()});
+		params.push({key: "parallel", value: '$parallel'});
+		params.push({key: "break_on_error", value: '$break_on_error'});
+		return initRequest(buildURL("batch", params), data -> data.responses, onComplete, onError, onProgress);
+	}


Use the format I gave, never put a tab character unless it's to indent a line

GamerPablito · 2025-05-11T08:48:51Z

In the future please make a feature branch on your fork, rather than using GamerPablito:dev, but this is fine

Keep the old FlxGameJolt and deprecate it

You should update the FlxPongAPI demo, which is our demonstration of the FlxGameJolt api. this will allow people to learn the new system, and it will allow me to test this branch

I will keep this in mind

Co-authored-by: George Kurelic <[email protected]>

GamerPablito · 2025-05-12T23:57:15Z

The only thing left is to update the FlxPongAPI demo to fit with the new functions.
I'm on it rn.

Geokureli · 2025-05-13T16:06:54Z

I unresolved a conversation you closed, please read it and apply the requested changes

Geokureli · 2025-05-13T16:08:19Z

flixel/addons/api/gamejolt/FlxGameJoltScoreTable.hx

+/**
+ * The way the score tables are fetched from your game API.
+ * 
+ * @param id The ID of the Score Table.
+ * @param name The name of the Score Table.
+ * @param description The description of the Score Table.
+ * @param primary Whether if this is the Primary Score Table in your game (1) or not (0).
+ */
+typedef FlxGameJoltScoreTable =
+{
+	id:Int,
+	name:String,
+	description:String,
+	primary:Bool
+}


apply the same doc format I requested for FlxGameJoltScore

Geokureli · 2025-05-13T16:08:29Z

flixel/addons/api/gamejolt/FlxGameJoltTrophy.hx

+/**
+ * The way the trophies are fetched from your game API.
+ * 
+ * @param id The ID of the Trophy.
+ * @param title The title of the Trophy.
+ * @param description The description of the Trophy.
+ * @param difficulty The difficulty rank of the Trophy.
+ * @param image_url The link of the image that represents the Trophy.
+ * @param achieved Whether this Trophy was achieved or not, it can be a string if it was (with info about how much time ago it was achieved) or bool if not (false).
+ */
+typedef FlxGameJoltTrophy =
+{
+	id:Int,
+	title:String,
+	description:String,
+	difficulty:String,
+	image_url:String,
+	achieved:String
+}


apply the same doc format I requested for FlxGameJoltScore

Geokureli · 2025-05-13T16:08:56Z

flixel/addons/api/gamejolt/FlxGameJoltUser.hx

+/**
+ * The way the user data is fetched from the GameJolt API.
+ * 
+ * @param id The ID of the User.
+ * @param type The cathegory the User is cataloged like in GameJolt.
+ * @param username The username of the User. (Also available for guests).
+ * @param avatar_url The link of the avatar of the User.
+ * @param signed_up A short description about how long the User have been in GameJolt.
+ * @param signed_up_timestamp A long time stamp (in seconds) of when the User signed up.
+ * @param last_logged_in A short description about the last time the User was found active in GameJolt.
+ * @param last_logged_in_timestamp A long time stamp (in seconds) of the last time the User logged in GameJolt.
+ * @param status The actual status of the User.
+ * @param developer_name The display name of the User. (Also available for guests).
+ * @param developer_website The website of the User.
+ * @param developer_description The description of the User.
+ */
+typedef FlxGameJoltUser =
+{
+	id:Int,
+	type:String,
+	username:String,
+	avatar_url:String,
+	signed_up:String,
+	signed_up_timestamp:Int,
+	last_logged_in:String,
+	last_logged_in_timestamp:Int,
+	status:String,
+	developer_name:String,
+	developer_website:String,
+	developer_description:String
+}


apply the same doc format I requested for FlxGameJoltScore

GamerPablito · 2025-05-17T10:37:04Z

Ok, here you go, I fixed descriptions and other stuff as well, I hope this time the changes will suffice your expectations

GamerPablito · 2025-05-21T04:45:38Z

I guess nothing else needs to be added at this point.

Geokureli · 2025-05-21T16:01:06Z

You still never did this:

Which I reiterated several times: including here:

and as i said before:

GamerPablito · 2025-05-22T16:56:07Z

Ok, what do you think about this change?

GamerPablito · 2025-05-24T15:46:02Z

I'm currently trying to update the FlxPongApi thing at this time.
I'll let you know when changes are done!

GamerPablito · 2025-05-27T04:16:58Z

@Geokureli check the changes pls

Geokureli · 2025-05-27T13:03:23Z

I keep requesting the same changes, I feel like you're just not fully reading what I've said, I can go in and make these changes myself when I have time, but please reread what I've said numerous times

GamerPablito · 2025-05-29T14:12:21Z

I've corrected the spacing in descriptions, I've set them up like you said they have to be, idk what else am I missing, I did everything you told me so far to do. Maybe try to be more specific?

Geokureli · 2025-05-29T14:28:44Z

I don't know how to be any clearer than this:

never put a tab character unless it's to indent a line

and

Note: 3 spaces after @param, all param names have spaces so the descriptions start on the same column, 2 spaces after @return

In all of the places I said to use spaces rather than tabs, you have used tabs. I even gave an example

I also mentioned that this will not be merged until I can test it in an updated FlxPongApi demo

Are ya happy now?

GamerPablito · 2025-05-30T14:17:47Z

Ok, I've removed the tabs and replace them by spaces as you said.
Is that it?

Geokureli

Various doc changes

flixel/addons/api/gamejolt/FlxGameJoltRequest.hx

flixel/addons/api/gamejolt/FlxGameJoltRequestType.hx

flixel/addons/api/gamejolt/FlxGameJoltResponse.hx

applied changes

Geokureli · 2025-06-02T15:05:10Z

I'll try to get to this, soon, but I'm kinda swamped right now

GamerPablito · 2025-06-04T04:07:07Z

It's ok, thanks for correcting my descriptions btw.
Hope you get to test FlxPongAPI pull request soon!

GamerPablito added 2 commits May 1, 2025 12:33

FlxGameJolt has been updated!

353a2d4

Update FlxGameJolt.hx

c8c424c

Geokureli requested changes May 6, 2025

View reviewed changes

Geokureli reviewed May 6, 2025

View reviewed changes

GamerPablito and others added 3 commits May 11, 2025 02:49

Update flixel/addons/api/gamejolt/FlxGameJoltScore.hx

6cec0c0

Co-authored-by: George Kurelic <[email protected]>

Update flixel/addons/api/gamejolt/FlxGameJolt.hx

e604f86

Co-authored-by: George Kurelic <[email protected]>

Great Improvement

d03ba3b

Geokureli reviewed May 13, 2025

View reviewed changes

GamerPablito added 3 commits May 17, 2025 04:22

Fixed descriptions and other upgrades

8a89ac7

Small fix

e09c22a

Spacings

68c75d1

GamerPablito requested a review from Geokureli May 17, 2025 10:59

This might do the trick now

bef6fcf

Changed Tabs for Spaces

7e22169

Are ya happy now?

Geokureli previously requested changes Jun 2, 2025

View reviewed changes

Apply suggestions from code review

a7adf0b

FlxGameJolt Update #461

Are you sure you want to change the base?

FlxGameJolt Update #461

Uh oh!

Conversation

GamerPablito commented May 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Geokureli left a comment

Choose a reason for hiding this comment

Uh oh!

Geokureli May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GamerPablito commented May 11, 2025

Uh oh!

GamerPablito commented May 12, 2025

Uh oh!

Geokureli commented May 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GamerPablito commented May 17, 2025

Uh oh!

GamerPablito commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Geokureli commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GamerPablito commented May 22, 2025

Uh oh!

GamerPablito commented May 24, 2025

Uh oh!

GamerPablito commented May 27, 2025

Uh oh!

Geokureli commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GamerPablito commented May 29, 2025

Uh oh!

Geokureli commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GamerPablito commented May 30, 2025

Uh oh!

Geokureli left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Geokureli commented Jun 2, 2025

Uh oh!

GamerPablito commented Jun 4, 2025

Uh oh!

GamerPablito commented May 1, 2025 •

edited

Loading

Geokureli May 6, 2025 •

edited

Loading

GamerPablito commented May 21, 2025 •

edited

Loading

Geokureli commented May 21, 2025 •

edited

Loading

Geokureli commented May 27, 2025 •

edited

Loading

Geokureli commented May 29, 2025 •

edited

Loading