The SDK

Everything a script has as phantom, and a plugin has from ctx.phantom(): phantom.aj (Animal Jam, area by area), phantom.flash (the whole client, typed) and phantom.packets (its traffic). 53 areas, 3291 members and 418 examples. Each page covers one area: every property, method and event, with its parameters, return value, types and an example.

It’s generated from the SDK’s source when the site builds, and the tests compile every example against the SDK.

// Every area of Animal Jam is reached the same way, under `phantom.aj`.
await phantom.aj.chat.say('hello');
const here = await phantom.aj.room.players.all();

// What no area reaches, the client itself does.
const audio = phantom.flash.use('com.sbi.corelib.audio.SBAudio');
await audio.muteSounds(true);

A script has phantom already. A plugin gets it from ctx.phantom(), and its manifest asks to read the game or act in it. For anything the areas don’t cover, see the game client.

You and your animal

You and your animalphantom.aj.playerThe player: their avatar, animals, looks, pets and belongings.200 membersMembershipphantom.aj.membershipMembership.10 membersGems and diamondsphantom.aj.currencyGems, diamonds and tickets.16 membersAchievementsphantom.aj.achievementsAchievements and stats.24 membersThe Jamaa Journalphantom.aj.newspaperThe Jamaa Journal.15 members

Where you are

Roomsphantom.aj.roomThe room the player is in: its players, camera, scene, volumes, music and items.63 membersGetting aboutphantom.aj.navigationWalking: the room's grid, routes, walks that resolve with where the player arrived.15 membersThe worldphantom.aj.worldServers, shards, room counts and parties.33 membersThe map and the server listphantom.aj.mapThe world map and travelling by it.19 membersDensphantom.aj.densDens: visiting, rooms, items, privacy, guests.111 membersCustom roomsphantom.aj.customRoomsBuilding and playing custom rooms.24 members

The connection

The connectionphantom.aj.sessionThe connection and login: connected, in the world, keeping active.20 members

How assets load

How assets loadphantom.aj.assetsThe client's art and media.8 membersWhat the game loadsphantom.aj.contentReplacing the game's content.7 members

Other players

Animals on screenphantom.aj.avatarsEveryone in the room, by user id: how they are drawn and how they move.59 membersChatphantom.aj.chatChat: saying things, hearing them, emotes, balloons, the chat bar.75 membersPhantom communityphantom.aj.communityPhantom's community: who nearby uses Phantom.8 membersReal-time channelsphantom.aj.realtimeA plugin's real-time channels.33 membersBuddiesphantom.aj.buddiesThe player's buddies, requests and the buddy card.46 membersJam-a-gramsphantom.aj.ecardsJam-a-grams.38 membersThe player wallphantom.aj.playerWallJammer walls: posts, likes, privacy.48 membersTradesphantom.aj.tradesTrading: trade lists, offers, the trade window.37 membersReporting a playerphantom.aj.reportsReporting players.9 membersRefer a friendphantom.aj.referralsReferrals.12 members

Things you own

Inventoryphantom.aj.inventoryWhat the player owns: clothing and den items, wearing, recycling.32 membersShopsphantom.aj.shopsShops: catalogues, buying, selling, the shop window.68 membersThe den shopphantom.aj.denShopPlayers' den shops.13 membersMasterpiecesphantom.aj.masterpiecesMasterpieces: in dens, their creators, likes and previews.12 membersThe daily giftphantom.aj.dailyGiftThe daily gift and the spin wheel.14 members

Playing

Adventuresphantom.aj.adventuresAdventures: lobby, actors, combat, treasure, rewards, routes.181 membersMinigamesphantom.aj.minigamesMinigames: playing, lobbies, PvP, scores, and each of the 64 games by name.1329 membersThe Journey Bookphantom.aj.journeyBookThe journey book.23 membersFactsphantom.aj.factsFacts collected in the world.32 membersPollsphantom.aj.pollsPolls in the world.20 membersThe theatrephantom.aj.moviesThe theatre: the movie player, selector and chapters.49 members

Making art

The art studiophantom.aj.artStudioThe art studio: canvas, grid, painting pictures stroke by stroke, pottery, prints.77 members

The screen and sound

Building interfacesphantom.aj.uiThe client's interface by name: restyle, attach, replace, dialogs.67 membersOn-screen elementsphantom.aj.guiThe client's display tree: find, click, type, wait for.22 membersItem pictures in the interfacephantom.aj.guiItemsItem buttons across the client.4 membersThe HUDphantom.aj.hudThe HUD: labels, buttons, parts, counters, the room label.30 membersThe avatar, den and pet editorsphantom.aj.editorThe avatar, den and pet editors.67 membersDialogs and popupsphantom.aj.popupsThe client's plain dialogs.19 membersThe game’s own windowsphantom.aj.screensThe client's windows, all with the same calls: open, close, waitFor, press, text.81 membersThe game’s settingsphantom.aj.settingsThe client's settings.17 membersSound and musicphantom.aj.soundSound and music volume.16 membersLanguage and textphantom.aj.localizationThe client's text in the player's language.16 membersFeedbackphantom.aj.feedbackThe feedback form.7 membersThe viewphantom.aj.viewWhat of the game is drawn: HUD parts, clean screenshots, zoom kept.5 membersWhat the room holdsphantom.aj.entitiesThe room's players, NPCs and objects as things to tag, highlight and click.5 membersHow the game is drawnphantom.aj.renderHow the game is drawn: quality, frame rate, the GPU.19 membersKeyboard shortcutsphantom.aj.inputKeys and the mouse.13 members

The game client

The game clientphantom.flashThe game client itself, for what the SDK does not wrap: every public class, object, property and method in it, typed from the client's own declarations, and what runs inside Flash for scripts: hooks, watches, the overlay, highlights, keys and the view.115 membersPacketsphantom.packetsThe game's traffic, typed by @phantom/protocol.8 members