Whirled SDK

From Whirled

Contents 1 Download 2 Documentation 3 Install and Set-up the Whirled SDK in Flash CS3 3.1 Setting Classpaths to Import Whirled's Server Code 4 Install and Set-up the Whirled SDK in Flash CS4 4.1 Setting Source Paths to Import Whirled's Server Code 5 Release Notes 5.1 Version 0.66 (November 6th, 2009) 5.2 Version 0.65 (October 23, 2009) 5.3 Version 0.64 (September 3, 2009) 5.4 Version 0.63 (August 27, 2009) 5.5 Version 0.62 (August 6, 2009) 5.6 Version 0.61 (July 31st, 2009) 5.7 Version 0.60 (June 3rd, 2009) 5.8 Version 0.59 (May 1st, 2009) 5.9 Version 0.58 (April 17th, 2009) 5.10 Version 0.57 (April 15th, 2009) 5.11 Version 0.56 (April 8th, 2009) 5.12 Version 0.55 (March 27th, 2009) 5.13 Version 0.54 (March 10th, 2009) 6 History

Herein you will find the latest version of the Whirled Software Development Kit as well as release notes.

Download

This is the latest version of the SDK:

http://www.whirled.com/whirled_sdk_0.66.zip

Documentation

• Whirled Game API Overview
• Installing the Whirled SDK for programming games
• Whirled API Documentation
• Contrib Code Documentation

Install and Set-up the Whirled SDK in Flash CS3

1. Download the latest SDK using the link above.
2. Unzip the SDK you downloaded in your chosen location. This should create a whirled folder with a few folders in it.
3. Once the Whirled SDK has been properly installed, the next step is to add the classpaths to the ActionScript files used in Flash CS3 as shown below.

Setting Classpaths to Import Whirled's Server Code

Setting a classpath in Flash's preferences means it will automatically import this code for all your future avatars or pets. Once it's set up, all your avatars or pets or other items using the SDK will export with the server code.

1. In Flash, choose Edit -> Preferences or use Ctrl-u.
2. Under Category, choose ActionScript.
3. Click the button labeled "ActionScript 3.0 Settings...".
4. Add the base Whirled classpath:
   1. Click the plus to add a new classpath.
   2. Click the crosshairs to browse to your SDK folders.
   3. Find and set the path to "...\whirled\src\as".
5. Add the contrib directory if you want to use items there:
   1. Click the plus to add a new classpath.
   2. Click the crosshairs to browse to your SDK folders.
   3. Find and set the path to "...\whirled\contrib\src\as".
6. Add the avatar or pet classpath:
   1. Click the plus to add a new classpath.
   2. Click the crosshairs to browse to your SDK folders.
   3. Find and set the path to "...\whirled\examples\avatars\uravatar\src" or "...\whirled\examples\avatars\urpet\src"

Install and Set-up the Whirled SDK in Flash CS4

1. Download the latest SDK using the link above.
2. Unzip the SDK you downloaded in your chosen location. This should create a whirled folder with a few folders in it.
3. Once the Whirled SDK has been properly installed, the next step is to add the source paths to the ActionScript files used in Flash CS4 as shown below.

Setting Source Paths to Import Whirled's Server Code

Setting a source path in Flash CS4's preferences means it will automatically import this code for all your future avatars or pets. Once it's set up, all your avatars or pets or other items using the SDK will export with the server code.

1. In Flash, choose Edit -> Preferences or use Ctrl-u.
2. Under Category, choose ActionScript.
3. Click the button labeled "ActionScript 3.0 Settings...".
4. Add the base Whirled source path:
   1. Click the plus in the source path section to add a new source path.
   2. Click the crosshairs to browse to your SDK folders.
   3. Find and set the path to "...\whirled\src\as".
5. Add the contrib directory if you want to use items there:
   1. Click the plus in the source path section to add a new source path.
   2. Click the crosshairs to browse to your SDK folders.
   3. Find and set the path to "...\whirled\contrib\src\as".
6. Add the avatar or pet source path:
   1. Click the plus in the source path section to add a new source path.
   2. Click the crosshairs to browse to your SDK folders.
   3. Find and set the path to "...\whirled\examples\avatars\uravatar\src" or "...\whirled\examples\avatars\urpet\src"

Release Notes

Version 0.66 (November 6th, 2009)

• Unused class EffectControl was removed
• The showPage method was moved to FurniControl
• New build of thane for Win32. Parlor games with server agents should now be testable again on Windows.

Version 0.65 (October 23, 2009)

• Simple game contrib library has been factored out into a new public library called flashbang, hosted on google code here.
• Fix for testing parlor games with server agents, there was a missing library in the build script
• Various other contrib code refactoring, including some moves to the flash-utils library

Version 0.64 (September 3, 2009)

• Removed the old HashMap class, it was causing the flash authoring tool to get confused because there is a class of the same name in a different package.
• More cleanup in com.threerings.util:
  • Fixed a bug with weak-value maps.
  • ExpiringSet is gone, Sets and Maps can now both be made expiring using the factory methods.
  • Changed around the Predicates functions.
  • Logging is now turned off by default in non-debug players. If you add your own LogTargets, you may want to ensure that the global level is set to debug.

Version 0.63 (August 27, 2009)

• No new SDK functionality.
• Lots of cleanup to the com.threerings.util package:
  • new Map and Set builders that allow for more functionality
  • many new Comparators
  • lots of improved documentation

Version 0.62 (August 6, 2009)

• Fixed for Windows.
• Added descriptions for the new packages

Version 0.61 (July 31st, 2009)

• A lot of our com.threerings flash utility code was moved around. Things previously in com.threerings.flash can now be found in com.threerings.display, com.threerings.geom, com.threerings.media, com.threerings.text, or com.threerings.ui. See the class documentation for details. (http://www.whirled.com/code/asdocs/)
• Experimental method setShowChrome in avrg.LocalSubControl. This will probably change but currently turns off all the Whirled user interface elements, just as if the "chromelss" tick box were used on the game configuration.
• New method setRoomViewBounds in avrg.LocalSubControl to allow a game to limit the area in which the room is drawn. This can be used for example to show user interface elements that do not overlap the room.
• New method for Facebook integrated games getFacebookInfo in avrg.PlayerSubControlClient. This will allow you to access Facebook things like friends list and profile info. (Please note the SDK does not directly support these activities).
• Some documentation fixes
• A couple of healthy handfuls of contrib code changes

Version 0.60 (June 3rd, 2009)

• Some documentation improvements
• Updates to the contrib library
  • Keith Irwin's hack-proofing support code
  • XmlReader
  • simplegame updates

Version 0.59 (May 1st, 2009)

• Parlor games now identify players with their permanent whirled memberIds, instead of ids that change each time they play your game. This is a completely under-the-hood change and works with all your old games, and nothing really changed in the API to enable this.
• PartySubControl is now shared by AVRGs and parlor games. As such, a few changes were made: party events now use ControlEvents, and the constants are defined in PartySubControl, which now lives in com.whirled.party. If you previously had an AVRG that used the party stuff, you will have to make a few simple import and rename changes.
• PartySubControl now has getLeaderId() and a PARTY_LEADER_CHANGED event.
• GameSubContol has getPartyIds() and getParty(), two new events, and PlayerSubControl has a getPartyId() method.
• GameSubControl.takeOverPlayer() has been added, which will only work for server agents. It's intended to be used when a player leaves a seated multiplayer game and you want to let the other players keep going.
• showPage() was added to LocalSubControl for both AVRGs and parlor games, to take the user to a whirled page.
• com.whirled.game.NetSubControl.players now sends to all players, but not the server agent (if any). Previously it acted the same as the sendMessage() method in that class. Sorry for any inconvenience. Old games will not be affected by this change unless you recompile with the new API.
• a new LoopbackGameControl has been added for use if you have a game that supports both single and multiplayer modes. In the single-player mode you can use the LoopbackGameControl and no data is sent over the network, improving efficiency.
• doBatch() was added to the PropertySubControl interface.
• XML objects may be sent over the wire in properties and messages.
• Various improvements to method documentations.

Version 0.58 (April 17th, 2009)

• Fixed creating a new project, was broken in 0.57.
• The AVRG Party API is here! Check out GameSubControl.getPartyIds() and getParty(), which returns the new PartySubControl. Also PlayerSubControl.getPartyId(). There will be a few more additions coming, as well as integration with non-AVRG games.
• Added getMusicOwnerId() to EntityControl and AVRG's RoomSubControl. You can find out if music is currently playing and the playerId of the person that added it to the playlist.
• Some behind-the-scenes bugfixes. If you've used some of the new music features of 0.57, try again now.

Version 0.57 (April 15th, 2009)

• Entities and AVRG agents can now listen for music events in the room and get the current music id3 tag info:
  • MUSIC_STARTED
  • MUSIC_STOPPED
  • MUSIC_ID3
  • getMusicId3
• Game item packs may now be consumed
  • PlayerSubControlClient.requestConsumeItemPack in AVRGs
  • PlayerSubControl.requestConsumeItemPack in seated games.
  • The player will be shown a popup. If they agree, an event will be sent on PlayerSubControlClient and PlayerSubControlServer for AVRGs or PlayerSubControl (both client and server) for seated games
  • The number of items owned by a player is now reported in PlayerSubControlBase.getPlayerItemPacks for AVRGs and PlayerSubControl.getPlayerItemPacks for seated games.
  • Content consumption events are not currently handled in the SDK test bed
• Really old method backToWhirled is now removed from the backend (it was removed from the API in August of last year)
• RoomSubControlBase.getOccupantName now works.
• RoomSubControlBase.getRoomName is now available on the server.
• Brand new server agent interpreter, be on the lookout for any unusual behavior
• Other minor improvements

Version 0.56 (April 8th, 2009)

• In-Whirled Games (AVRGs):
  • Added a private property space for the server agent, which also supports persistent properties.
  • Added moveToRoom() and getPlayerName() to PlayerSubControl
  • Added getOccupantName() to GameSubControl
  • Added getOccupantIds() and getOccupantName() to RoomSubControl
  • The AVRGameAvatar class now returns the entityId rather than the name.
• Entities:
  • Added getEnvironment()
  • Added showPage() to bring the user to a page on Whirled.
  • New restrictions on avatar memory: only the instance in control may update memories.
• Screen games:
  • ServicesSubControl.getDictionaryLetterSet() was renamed to getDictionaryLetters(), since the letters may contain duplicates (it's not a "set"!).

Version 0.55 (March 27th, 2009)

• Some changes to GameControl.local:
  • Added isEmbedded().
  • Added showAllGames().
  • Removed setShowReplay(). The expectation is that you'll provide your own replay/rematch buttons.
• Some changes to AVRG's RoomSubControlClient:
  • Will now dispatch a CHAT_RECEIVED event when someone talks in the room.
  • Added canManageRoom().
• There is a new uravatar base script that gives MUCH better performance, called MovieClipBody.as. Full documentation is pending.
• Tons of updates to the 'simplegame' and 'platformer' contrib libraries.

Version 0.54 (March 10th, 2009)

• AVRG server-side backend should no longer throw an exception when a room unloads that was not referenced by the server agent. This should not affect most games.
• No more rematch button in the lobbied game test bed, this now matches the behavior on whirled.com.
• New event for when the user closes the lobby. See LocalSubControl events
• Renamed AVRG coordinate transform methods roomToLocationAtDepth and roomToLocationAtHeight to paintableToLocationAtDepth and paintableToLocationAtHeight, respectively. This is to match the naming convention used in other methods.
• Missing documentation added for AVRG coordinate transform methods. See com.whirled.avrg.LocalSubControl.
• All entities can now use registerCustomConfig, not just furniture. See com.whirled.EntityControl
• FATServer should now actually work again.
• As usual, many many contrib code changes.

History

• See release notes from earlier versions

Categories: Releases | Coding terminology