API Reference

Parameters
island - The codename of the island to teleport to. Defaults to "hub" unless the request is determined to be AS2, in which it will be "Early".
scene - The scene to teleport to. If not supplied, the island's main street will be used. If no main street scene is found, the AS2 GlobalAS3Embassy will be used instead.
path - The AS2 startup path. Defaults to "gameplay". For a list of all startup paths, see below.
advanced - A list of flags/commands separated by commas to apply specific actions. See below for more information.
short - A shortened link preset by the website owner. See below for more information.
format - The game format to load in. Defaults to "as3". For a list of every game format, see below.
sub - A subdomain on the Poptropica site that the game will be loaded in. This can only contain regular expression word characters, dashes, and periods. Defaults to "www".


AS2 Startup Paths
gameplay - The default startup path. Loads the game normally.
home - Opens the old homepage. May not be functional.
stats - Opens the old store, which is nonfunctional.
dailypop - Opens the Daily Pop. May not be functional.
friendshub - Opens the old friends page, which has more features than its AS3 counterpart. May not be functional.
friends - A seemingly unfinished startup path that opens the AS2 friends page's multiverse menu.
items - Opens the inventory menu of the island that is currently loaded.
map - This startup path was never fully implemented. It was likely intended to open the island map, but now it just pauses the game.


Advanced Flags
cmg - (AS2, AS3, Haxe) Loads the Cool Math Games version of Poptropica. It has a darker background color, less ads, and possibly a different island map layout.
commonRoom - (AS2, AS3, Haxe) Sets the scene parameter to the common room of the specified island. If no common room scene is found, the AS2 GlobalAS3Embassy will be used instead.
class - (AS3, Haxe) Specifies that the supplied scene is already in its class name form and does not need further modification. This causes the island parameter to be ignored.
dirClimb - (AS2) Prepends a two-length dot segment to the URL of the scene. Can be used multiple times.


Short Links
storeInventory - Displays all store items in the AS2 inventory menu, across multiple pages if needed. New AS3/Haxe items may not appear.
storeInventory2 - Displays all store items in the AS2 inventory menu on one page. New AS3/Haxe items may not appear.


Game Formats
as2 - Old islands are all categorized as AS2 islands.
as3 - Adobe Flash islands that use the current game engine are categorized as being AS3. This is the default game format.
haxe - Haxe (HTML5/JS) islands use this format. The teleporter currently will not automatically determine requests to be in this game format, but it will replace AS3 as the default format near the end of the year.


Request Type Determination
1. Startup Path - If supplied, even as an empty string (not null), the request will be interpreted as AS2.
2. Scene - If the first character is uppercase alphabetical, non alphabetical, or if the parameter is an empty string (not null), the request will be interpreted as AS2.
3. Island - If the first character is uppercase alphabetical, non alphabetical, or if the parameter is an empty string (not null), the request will be interpreted as AS2.
4. Scene (Again) - If the parameter is an empty string or not supplied, and no main street scene is found for the given island, the request will be interpreted as AS2.