A list of all Actions, Conditions and Expressions supported in this addon.
Authentication
-
Actions
Login in {0}
Open Newgrounds login page. Login times out after 60 seconds.
Logout
Closes the session by logging out the user.
-
Conditions
On Version Mismatch
Triggered when NGIO API finds a newer version of the game.
On Ready
Triggered when NGIO API is initialized and ready to operate. Do not call any ACE before the API is ready.
On Logout
Triggered after the user logs out of Newgrounds.
On Login
Triggered after the user successfully logs into Newgrounds.
On Login Cancelled
Triggered after the user cancels logging into Newgrounds.
Is Waiting
Returns true if the API is waiting for an event response of any kind.
On Waiting
Triggered when the API is waiting for a response of any kind. Use this event to show a spinner or a 'please wait' message when needed.
On Waiting Finished
Triggered after the API is done waiting and changes its status.
Is Logged In
Indicates if the user is already logged in the NGIO session.
Is Ready
Returns true if the NGIO API is ready. Do not call any ACE before the API is ready.
On Error
Triggered whenever the API fails after a call.
-
Expressions
LastError
Returns the last error message received by NGIO. This field populates for these triggers: On Scores Post Error, On Login Cancelled.
NewestVersion
Returns the newest version number reported by NewgroundsIO API.
User Data
-
Conditions
Is Supporter
Indicates if the user is a Newgrounds supporter.
-
Expressions
UserID
Returns the numeric user ID.
UserName
Returns the user name.
IconSmall
User icon (small).
IconMedium
User icon (medium).
IconLarge
User icon (large).
Scoreboards
-
Actions
Get Scores of {0}, period: {1}, tag: {2}, social: {3}, skip: {4}, limit: {5}
Retrieves the scores of the given Board ID and applies the filter criteria.
Post {1} to {0}, tag: {2}
Posts a score to a given Board ID with specific criteria.
Show Scoreboard {0}, period: {1}, tag: {2}, social: {3}, skip: {4}, limit: {5}
Display a default modal dialog with the scores for the given scoreboard.
-
Conditions
For Each Score
Iterates over the last list of scores retrieved.
For Each Scoreboard
Iterates over all the available scoreboards.
On Scores Ready
Triggered when the scores are ready after a Get Scores action call.
On Scores Posted
Triggered when the score is posted after a Post Scores action call.
-
Expressions
ScoreboardsAsJSON
Returns the array of scoreboards available to a string in JSON format.
LastScoresAsJSON
Returns the array of the last retrieved scores as a string in JSON format. This expression is valid only after a Get Scores action call.
ScoreboardID
Returns the numeric Scoreboard ID. Call first Get Scores.
ScoreboardName
Returns the Scoreboard Name. Call first Get Scores.
ScoreUserID
Scoreboard entry user ID.
ScoreUserName
Scoreboard entry user name. Call first Get Scores.
ScoreUserIconSmall
Scoreboard User icon (small). Call first Get Scores.
ScoreUserIconMedium
Scoreboard User icon (medium). Call first Get Scores.
ScoreUserIconLarge
Scoreboard User icon (large). Call first Get Scores.
ScoreValue
Scoreboard value entry for the current user. Call first Get Scores.
ScoreFormattedValue
Scoreboard formatted value entry for the current user. Call first Get Scores.
ScoreTag
Scoreboard entry tag. Call first Get Scores.
Medals
-
Actions
Get {0} Medal
Read a medal by its Id. Use MedalID, MedalName, MedalDescription, MedalDifficulty, MedalIcon and MedalValue to retrieve its data.
Unlock {0}
Unlocks a medal by its Id.
Show Medals
Display a default modal dialog with all the game medals. If the user is logged in, only the medals awarded are displayed.
-
Conditions
For Each Medal
Iterates over the list of medals available.
Is {0} Secret
Indicates if the given medal is a secret medal (hidden).
Is {0} Unlocked
Indicates if the given medal is unlocked.
On {0} Unlocked
Triggered when the indicated medal is unlocked
On Any Medal Unlocked
Triggered when any medal is unlocked
-
Expressions
MedalsAsJSON
Returns the array of medals to a string in JSON format.
MedalID
Medal Id.
MedalName
Medal Name.
MedalDescription
Medal Description.
MedalDifficulty
Medal Difficulty.
MedalIcon
Medal Icon.
MedalValue
Medal Value.
Cloudsave
-
Actions
Queue {0} for Saving
Queues data to be saved later in the Show Saved Slots built-in dialog. If the user presses save, the queued data will be saved to the slot selected by the user.
Save {1} to Slot {0}
Saves the data to the given slot, and triggers On Saved.
Load Slot {0}
Retrieves the saved slot data, and triggers On Loaded.
Show Saved Slot
Displays a dialog containing the list of saved slots.
-
Conditions
For Each Saved Slot
Iterates over all the available saved-slot metadata, not the data itself.
On Loaded
Triggered when the data is successfully retrieved after a Get Saved Slot Data call.
On Saved
Triggered when the data is successfully saved after a Save Slot Data call.
-
Expressions
SlotData
Returns the last slot-data retrieved by Get Saved-Slot Data in a string in JSON format.
SlotID
Returns the current Slot ID.
SlotTimestamp
Returns the current slot timestamp in milliseconds of the last save.
SlotSize
Returns the current slot size in bytes.
SlotURL
Returns the URL containing the actual save data for this slot, or blank if this slot has no data.
Events & Loaders
-
Actions
Log Event: {0}
Logs a custom event to your App Stats board. Newgrounds provides basic analytics capabilities for you to track your game's performance. Custom events must be created in the Events & Loaders page of your game before you log them.
Load Author URL
Loads the author's official web page. The official page must be registered in the Events & Loaders page of your game before you call this action.
Load Official URL
Loads the game's official web page. The official page must be registered in the Events & Loaders page of your game before you call this action.
Load More Games
Loads Newgrounds' games page.
Load Referral {0}
Loads a referral web page. The referrals must be registered in the Events & Loaders page of your game before you call this action.