functions

Functions

This is a general-purpose module that contains a variety of functions.

Functions

These are the functions of the Mobile Review extension:

• mobile_review_show

---

Back To Top

mobile_review_show

This function starts the in-app review flow and can be triggered at any time throughout the user journey of your app. During the flow, the user has the ability to rate your app using the 1 to 5 star system and to add an optional comment. Once submitted, the review is sent to the store and eventually displayed.

Note

A success result does not mean that the review prompt was shown or that the user submitted a review. On Android it means the Google Play review flow task completed; on iOS it means the request was handed to StoreKit (which never reports a result). Both stores decide whether the prompt actually appears, subject to the rules described in Limitations. Do not gate game logic on the user having left a review.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

mobile_review_show(callback)

Argument	Type	Description
callback	Function	The function to be called once the in-app review flow finishes. It receives the arguments listed in the Callback section below.

Returns:

N/A

Triggers:

Callback

Key	Type	Description
success	Boolean	Whether the in-app review flow completed without error (see the note above for what this does and does not guarantee).
error	String	A description of what went wrong when success is false; an empty string otherwise.

Example:

mobile_review_show(function(_success, _error)
{
    if (_success)
    {
        show_debug_message("Review request completed.");
    }
    else
    {
        show_debug_message("Review request failed: " + _error);
    }
});

---