thepaperpilot/unofficial-galaxy-sdk
1
0
Fork 0
Code Issues Pull requests Releases 2 Activity Actions

Remove ambiguous unicode characters

Browse source
This commit is contained in:
thepaperpilot 2024-02-15 13:43:51 +00:00
parent b77dd8afa8
commit 5d95a0a474
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
galaxy.d.ts vendored
View file

@ -10,7 +10,7 @@ interface SupportsAction {
}
/**
* The save_list action sends a retrieval request to Galaxy to get the player’s cloud save list which contains all the save data the player has. The actual save data then will be retrieved through the save_list response.
* The save_list action sends a retrieval request to Galaxy to get the player's cloud save list which contains all the save data the player has. The actual save data then will be retrieved through the save_list response.
* @see {@link SaveListResponse}
*/
interface SaveListAction {
@ -25,7 +25,7 @@ interface SaveAction {
action: "save";
/** The save slot number. Must be an integer between 0 and 10, inclusive. */
slot: number;
/** The optional label of the save file. It is recommended for this to be a quick summary of the player’s current progress (e.g. e1,000 points, Stage 64-25, Arcana level 308). Must be 100 characters in length or fewer. */
/** The optional label of the save file. It is recommended for this to be a quick summary of the player's current progress (e.g. e1,000 points, Stage 64-25, Arcana level 308). Must be 100 characters in length or fewer. */
label?: string;
/** The actual save data. Must be 256,000 characters in length or fewer. */
data: string;
@ -47,11 +47,11 @@ interface LoadAction {
*/
interface InfoResponse {
type: "info";
/** Whether you’re talking to Galaxy. This should always be true. */
/** Whether you're talking to Galaxy. This should always be true. */
galaxy: boolean;
/** The version of the API. Will only increment for every breaking API change. It is not a bad idea to disable your implementation if this does not match. */
api_version: number;
/** The player’s theme preference. Valid values are none, light, and dark. Use this to determine the color scheme of your game on the first startup. */
/** The player's theme preference. Valid values are none, light, and dark. Use this to determine the color scheme of your game on the first startup. */
theme_preference: string;
/** Whether the player is logged in. Certain features (like cloud saving) require the player to be logged into a Galaxy account in order to work. */
logged_in: boolean;
@ -76,13 +76,13 @@ interface SaveListResponse {
* Present when error is true, tells the reason why the action encountered an error.
* Valid values are:
* - "no_account": The player was logged out.
* - "server_error": The game couldn’t connect to Galaxy’s servers.
* - "server_error": The game couldn't connect to Galaxy's servers.
*/
message?: "no_account" | "server_error";
}
/**
* The save_content response is requested by the load action and contains information about the action’s load request along with the requested save data.
* The save_content response is requested by the load action and contains information about the action's load request along with the requested save data.
* @see {@link LoadAction}
*/
interface SaveContentResponse {
@ -95,19 +95,19 @@ interface SaveContentResponse {
* - "no_account": The player was logged out.
* - "empty_slot": The save slot is empty.
* - "invalid_slot": The slot value was invalid.
* - "server_error": The game couldn’t connect to Galaxy’s servers.
* - "server_error": The game couldn't connect to Galaxy's servers.
*/
message?: "no_account" | "empty_slot" | "invalid_slot" | "server_error";
/** The save slot number. */
slot: number;
/** The save’s label, or null if error is true. */
/** The save's label, or null if error is true. */
label?: string;
/** The save’s actual data, or null if error is true. */
/** The save's actual data, or null if error is true. */
content?: string;
}
/**
* The saved response is requested by the save action and contains information about the action’s save request.
* The saved response is requested by the save action and contains information about the action's save request.
* @see {@link SaveAction}
*/
interface SavedResponse {
@ -122,7 +122,7 @@ interface SavedResponse {
* - "too_big": The save data exceeded the 256,000 character limit
* - "no_account": The player was logged out.
* - "invalid_slot": The slot value was invalid.
* - "server_error": The game couldn’t connect to Galaxy’s servers.
* - "server_error": The game couldn't connect to Galaxy's servers.
*/
message?: "no_account" | "empty_slot" | "invalid_slot" | "server_error";
}