Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.


 ClassPackageDescription
 Actor
com.whirled.contrib.platformer.piece A game actor that has orientation, acceleration and health.
 ActorBounds
com.whirled.contrib.platformer.board 
 ActorController
com.whirled.contrib.platformer.game 
 ActorSprite
com.whirled.contrib.platformer.display 
 ActorSpriteLayer
com.whirled.contrib.platformer.display 
 ApplicationDomainSoundFactory
com.whirled.contrib.sound A flash9-compatible SoundFactory that simply pulls sounds out of a provided ApplicationDomain.
 ArrayParameter
com.whirled.contrib.avrg.probe Parameter type used when an array is expected.
 Attachable
com.whirled.contrib.platformer.piece 
 AttackCollisionHandler
com.whirled.contrib.platformer.game 
 AttackController
com.whirled.contrib.platformer.game 
 BackgroundMusicAction
com.whirled.contrib.platformer.game 
 BaseGameMessage
com.whirled.contrib.platformer.net 
 BasicMessageManager
com.whirled.contrib.messagemgr 
 BidEvent
com.whirled.contrib.card.trick Event for something that happens to a bid.
 Bids
com.whirled.contrib.card.trick Manages the player bids for a trick taking card game such as spades.
 BitmapParallax
com.whirled.contrib.platformer.display 
 BitmapParallaxBackground
com.whirled.contrib.platformer.display 
 BitmapPool
com.whirled.contrib.platformer.display 
 BitmapSectionalLayer
com.whirled.contrib.platformer.display 
 Board
com.whirled.contrib.platformer.board The base class for a board which contains pieces.
 BoardSprite
com.whirled.contrib.platformer.display Displays a board.
 BounceCollisionHandler
com.whirled.contrib.platformer.game 
 BoundData
com.whirled.contrib.platformer.piece Constants for BoundedPiece.
 BoundedPiece
com.whirled.contrib.platformer.piece A piece that has a bounding polygon.
 BoundedPieceSprite
com.whirled.contrib.platformer.display 
 Button
com.whirled.contrib.avrg.probe Displays some text and dispatches an event when clicked.
 ButtonEvent
com.whirled.contrib.avrg.probe Sent when a click occurs in a Button.
 ByteArrayEvaluator
com.whirled.contrib.cache ByteArrays have a known size, and are therefore easy to calculate a sensible value for.
 Cache
com.whirled.contrib.cache 
 CacheObjectEvaluator
com.whirled.contrib.cache In order to determine whether a given cache is full, the cache must evaluate the value of each item, and compare that total to a configured max value.
 CacheStats
com.whirled.contrib.cache 
 CacheWrapper
com.whirled.contrib.platformer.display 
 CallbackParameter
com.whirled.contrib.avrg.probe Parameter type to use when a Function is expected.
 CameraController
com.whirled.contrib.platformer.display 
 Card
com.whirled.contrib.card Represents a card for use with game logic, rendering and UI.
 CardArray
com.whirled.contrib.card An ordered container of cards with event dispatching.
 CardArrayEvent
com.whirled.contrib.card Represents something that happens to a card array.
 CardArraySprite
com.whirled.contrib.card.graphics Superclass to display of an array of cards.
 CardDeck
com.whirled.contrib A simple card deck for use with games that encodes cards as a string like "Ac" for the ace of clubs, or "Td" for the 10 of diamonds.
 CardException
com.whirled.contrib.card Thrown when something goes wrong in a card game.
 CardSprite
com.whirled.contrib.card.graphics Represents a card graphic with a few appearance flags.
 CardSpriteFactory
com.whirled.contrib.card.graphics Defines functions to be used by classes that need to interact with card graphics, mainly CardArraySprite and subclasses.
 CardState
com.whirled.contrib.card.graphics Represents the state of a card sprite.
 Checksum
com.whirled.contrib.messagemgr 
 Chunker
com.whirled.contrib Chunks data to other instances of the entity being used.
 CircleBounds
com.whirled.contrib.platformer.board 
 ClickAnimateFurniture
com.whirled.contrib.display This class creates a furniture item which can respond to clicks and be animated.
 ClientPanel
com.whirled.contrib.avrg.probe The main interface for calling all AVRG functions on the client and on the server.
 ClientPlatformerContext
com.whirled.contrib.platformer.client 
 ClientPlatformerController
com.whirled.contrib.platformer.client 
 Collider
com.whirled.contrib.platformer.board 
 ColliderDetails
com.whirled.contrib.platformer.board 
 ColliderTask
com.whirled.contrib.platformer.board 
 Collision
com.whirled.contrib.platformer.game 
 CollisionController
com.whirled.contrib.platformer.game 
 CollisionHandler
com.whirled.contrib.platformer.game 
 ColorConversion
com.whirled.contrib Various tools for converting between different color models and applying colors to Movie Clips.
 Configurator
com.whirled.contrib Entites that need initial configuration, e.g.
 CookieFactory
com.whirled.contrib.persist 
 CookieManager
com.whirled.contrib.persist 
 CookieProperty
com.whirled.contrib.persist 
 CookiePropertyBase
com.whirled.contrib.persist 
 CookiePrototype
com.whirled.contrib.persist 
 DataSource
com.whirled.contrib.cache 
 DeathEventTrigger
com.whirled.contrib.platformer.game An event trigger that occurs when all the supplied actor ids are dead.
 Debug
com.whirled.contrib.card Debugging utilities.
 DecorationSprite
com.whirled.contrib.avrg.probe A test sprite for use as an AVRG mob decoration.
 Definitions
com.whirled.contrib.avrg.probe Declares all of the code objects available in the AVRG client and server api.
 DestructableGate
com.whirled.contrib.platformer.piece A gate that can be destroyed by shooting.
 DestructableGateController
com.whirled.contrib.platformer.game 
 DestructableGateSprite
com.whirled.contrib.platformer.display 
 DisplayUtils
com.whirled.contrib.platformer.display 
 Dynamic
com.whirled.contrib.platformer.piece Base class for any object that can move in the world.
 DynamicBounds
com.whirled.contrib.platformer.board 
 DynamicController
com.whirled.contrib.platformer.game 
 DynamicFactory
com.whirled.contrib.platformer.piece 
 DynamicMessage
com.whirled.contrib.platformer.net 
 DynamicSprite
com.whirled.contrib.platformer.display 
 DynamicSpriteLayer
com.whirled.contrib.platformer.display 
 Effect
com.whirled.contrib.platformer.util 
 EffectSet
com.whirled.contrib.sound 
 EnableActorEventAction
com.whirled.contrib.platformer.game 
 EnableSpawnerEventAction
com.whirled.contrib.platformer.game 
 EventAction
com.whirled.contrib.platformer.game 
 EventMessage
com.whirled.contrib.platformer.net 
 EventTrigger
com.whirled.contrib.platformer.game 
 FloatCookieProperty
com.whirled.contrib.persist 
 FlyTask
com.whirled.contrib.platformer.board 
 ForkingToyState
com.whirled.contrib ForkingToyState manages the state of a toy such that more than one person can play with it simultaneously.
 FunctionPanel
com.whirled.contrib.avrg.probe Panel to display an array of FunctionSpec objects.
 FunctionSpec
com.whirled.contrib.avrg.probe Holds everything needed to generate the parameters for and call a function.
 GameController
com.whirled.contrib.platformer.game 
 GameEvent
com.whirled.contrib.platformer.game A game event that has a trigger and an action.
 GameMessage
com.whirled.contrib.platformer.net 
 GameMode
com.whirled.contrib Interface for game modes, handled by the GameModeStack.
 GameModeStack
com.whirled.contrib GameModeStack implements a stack of user-specific game modes.
 Gate
com.whirled.contrib.platformer.piece A walkable solid dynamic that can be removed.
 GateController
com.whirled.contrib.platformer.game 
 GateSprite
com.whirled.contrib.platformer.display 
 GridPanel
com.whirled.contrib.avrg.probe A panel to display objects in a simple grid with fixed row and column heights and widths.
 HackDetectedEvent
com.whirled.contrib.hackproof This is the event thrown when an HPInt, HPUInt, HPNumber, or HPBoolean either has their value changed or frozen.
 Hand
com.whirled.contrib.card Represents the local player's hand in a card game.
 HandEvent
com.whirled.contrib.card Represents something that happens to a hand of cards.
 HandSprite
com.whirled.contrib.card.graphics Display for a hand of cards
 Hover
com.whirled.contrib.platformer.piece A simple dynamic that changes it's image when hovered.
 HoverCollisionHandler
com.whirled.contrib.platformer.game 
 HoverController
com.whirled.contrib.platformer.game 
 HoverMessage
com.whirled.contrib.platformer.net 
 HoverSprite
com.whirled.contrib.platformer.display 
 HPBoolean
com.whirled.contrib.hackproof This class holds a boolean (true/false) value.
 HPInt
com.whirled.contrib.hackproof This class holds an integer value.
 HPNumber
com.whirled.contrib.hackproof This class holds a floating point number value.
 HPReuseManager
com.whirled.contrib.hackproof This is a class which aids in the management of using and reusing HPInts, HPUInts, HPBooleans, and HPNumbers.
 HPUInt
com.whirled.contrib.hackproof This class holds an unsigned integer value.
 ImmediateEventTrigger
com.whirled.contrib.platformer.game 
 ImmediatePropControl
com.whirled.contrib Provides a safe way of managing "immediate" properties on an entity, as long as the entity is the ONLY thing modifying those properties.
 InitController
com.whirled.contrib.platformer.game 
 IntArrayCookieProperty
com.whirled.contrib.persist 
 IntCookieProperty
com.whirled.contrib.persist 
 Jukebox
com.whirled.contrib A Jukebox class for handling looping background music.
 KeyboardController
com.whirled.contrib.platformer.client 
 LaserShot
com.whirled.contrib.platformer.piece 
 LaserShotController
com.whirled.contrib.platformer.game 
 LaserShotSprite
com.whirled.contrib.platformer.display 
 LaserShotTask
com.whirled.contrib.platformer.board 
 LastTrickSprite
com.whirled.contrib.card.graphics Graphics for the cards in the last trick.
 Layer
com.whirled.contrib.platformer.display 
 LeastRecentlyUsedCache
com.whirled.contrib.cache 
 LevelPack
com.whirled.contrib Represents the data from WhirledGameControl.getLevelPacks() in a type-safe manner.
 LevelPackManager
com.whirled.contrib 
 LevelPacks
com.whirled.contrib 
 LFUWeightedAgeCache
com.whirled.contrib.cache There are a variety of Least Frequently Used replacement policies used.
 LineCollisionDetail
com.whirled.contrib.platformer.board 
 LineData
com.whirled.contrib.platformer.board Information aboult a line segment in 2-dimensional space that allows some quick efficient operations and comparisons.
 LocalTweener
com.whirled.contrib.card.graphics Wrapper for caurina.transitions.Tweener.
 MainTrickSprite
com.whirled.contrib.card.graphics Graphic for the cards in the main trick (in the center of the table).
 ManagedTimer
com.whirled.contrib 
 Maths
com.whirled.contrib.platformer.util Some useful math functions.
 Message
com.whirled.contrib.messagemgr 
 MessageManager
com.whirled.contrib.platformer.net 
 MessageManager
com.whirled.contrib.messagemgr 
 Metrics
com.whirled.contrib.platformer.util Various global metrics.
 MobSprite
com.whirled.contrib.avrg.probe A very simple sprite that may be used to test mobs.
 MultiEventAction
com.whirled.contrib.platformer.game 
 MultiEventTrigger
com.whirled.contrib.platformer.game 
 NamespaceMessageControl
com.whirled.contrib.namespc 
 NamespacePropControl
com.whirled.contrib.namespc 
 NamespacePropGetControl
com.whirled.contrib.namespc 
 NameUtil
com.whirled.contrib.namespc 
 NetArray
com.whirled.contrib.card Encapsulates the access and schema information for maintaining a fixed size array of integers on a whirled game server using NetSubControl.
 NormalBiddingSprite
com.whirled.contrib.card.graphics Represents the interface for normal bidding (nil to 13).
 ObjectCountEvaluator
com.whirled.contrib.cache A simple implementation of CacheObjectEvaluator that gives each object a value of 1 so that the cache in question is strictly evaluating its state based on the number of objects it contains.
 ObjectParameter
com.whirled.contrib.avrg.probe Parameter type for automatically parsing any basic actionscript object type.
 OneRoomGameRoom
com.whirled.contrib.avrg.oneroom Room type superclass for games that take place in exactly one room.
 OneRoomGameServer
com.whirled.contrib.avrg.oneroom Server agent for games that take place in exactly one room.
 OpenGateEventAction
com.whirled.contrib.platformer.game 
 ParallaxBackground
com.whirled.contrib.platformer.display A layer that displays one or more parallax background layers.
 ParallaxBitmap
com.whirled.contrib.platformer.display 
 ParallaxLayer
com.whirled.contrib.platformer.display 
 Parameter
com.whirled.contrib.avrg.probe Represents a named, typed parameter to an action script function.
 ParameterPanel
com.whirled.contrib.avrg.probe A panel for displaying controls for an array of Parameter objects and returning the parsed values.
 ParticleLayer
com.whirled.contrib.platformer.display 
 PauseController
com.whirled.contrib.platformer.game 
 PersistenceManager
com.whirled.contrib.persist 
 PersistentProperty
com.whirled.contrib.persist 
 PersistUtil
com.whirled.contrib.persist 
 PhysicalBase
com.whirled.contrib.display This class allows Movie Clips to move in accordance with simple physics including acceleration and drag.
 Piece
com.whirled.contrib.platformer.piece The base class for any object that will exist in the platformer.
 PieceFactory
com.whirled.contrib.platformer.piece 
 PieceSprite
com.whirled.contrib.platformer.display Visualizer for the base piece object.
 PieceSpriteFactory
com.whirled.contrib.platformer.display Generates a piece sprite from the supplied piece.
 PieceSpriteLayer
com.whirled.contrib.platformer.display A simple layer that just displays every piece sprite added to it.
 PlatformerContext
com.whirled.contrib.platformer 
 PlatformerController
com.whirled.contrib.platformer 
 PlayerSprite
com.whirled.contrib.card.graphics Flash object for a player sitting at a trick-taking card game.
 PlayType
com.whirled.contrib.sound 
 PointParameter
com.whirled.contrib.avrg.probe Parameter type to be used when a Point is expected.
 PoolCache
com.whirled.contrib.platformer.display 
 Preferences
com.whirled.contrib.platformer.client 
 PreferredCamera
com.whirled.contrib Handles saving the user's preferred camera to the flash player's local persistent memory.
 PrizeProperty
com.whirled.contrib.persist 
 PrizePrototype
com.whirled.contrib.persist 
 PropertyPrototype
com.whirled.contrib.persist 
 PropertyType
com.whirled.contrib.persist 
 QueueMessage
com.whirled.contrib.platformer.net 
 Rect
com.whirled.contrib.platformer.piece 
 RectangleParameter
com.whirled.contrib.avrg.probe Parameter type to be used when a Rectangle is expected.
 RectDynamic
com.whirled.contrib.platformer.piece A simple dynamic that has height and width
 RectDynamicBounds
com.whirled.contrib.platformer.board 
 RectDynamicController
com.whirled.contrib.platformer.game 
 RemoteEntity
com.whirled.contrib A helper proxy for accessing properties of another entity in the room.
 RemoveGatesEventAction
com.whirled.contrib.platformer.game 
 Scoreboard
com.whirled.contrib A class to manage game scores as a Dictionary property and send updates to the Whirled-provided scoreboard display.
 ScoreBreakdown
com.whirled.contrib.card.trick Holds the transient breakdown of the scores for a trick taking or other team card game.
 Scores
com.whirled.contrib.card.trick Models the current scores for a trick taking card game.
 ScoresEvent
com.whirled.contrib.card.trick Represents something that happens to scores.
 SectionalIndex
com.whirled.contrib.platformer.util A utility that indexes a first quadrant space into equal sized areas.
 SectionalLayer
com.whirled.contrib.platformer.display A layer that is divided into sections which are dynamically added and removed from the display tree depending on what's currently in the view.
 Server
com.whirled.contrib.platformer.server 
 ServerController
com.whirled.contrib.platformer.server 
 ServerDefinitions
com.whirled.contrib.avrg.probe Encapsulates the function definitions available to an AVRG server agent.
 ServerDynamicController
com.whirled.contrib.platformer.server 
 ServerModule
com.whirled.contrib.avrg.probe Object to serve the ClientPanel's request to invoke server API calls.
 ServerSpawnerController
com.whirled.contrib.platformer.server 
 ServerStub
com.whirled.contrib.avrg.probe Class to quietly listen for the ClientPanel to notify that it is time to instantiate a full ServerModule and later shut it down on request.
 SetGateEventAction
com.whirled.contrib.platformer.game 
 ShootableController
com.whirled.contrib.platformer.game 
 Shot
com.whirled.contrib.platformer.piece A base class for shots as dynamic objects.
 ShotCollisionHandler
com.whirled.contrib.platformer.game 
 ShotController
com.whirled.contrib.platformer.game 
 ShotMessage
com.whirled.contrib.platformer.net 
 ShotSprite
com.whirled.contrib.platformer.display 
 ShotTask
com.whirled.contrib.platformer.board 
 ShutdownController
com.whirled.contrib.platformer.game 
 SimpleActorBounds
com.whirled.contrib.platformer.board Provides collision detection support for an actor that has an axis aligned rectangular bounding box.
 SimpleBounds
com.whirled.contrib.platformer.board 
 SimpleCollision
com.whirled.contrib.platformer.game 
 SimpleSoundEffect
com.whirled.contrib.sound 
 SimpleSoundManager
com.whirled.contrib A very simple sound manager for letting you globally adjust the volume on a number of different sounds.
 Sorter
com.whirled.contrib.card Sorts cards so that it is easy for a player to assess his hand.
 SoundBytesDataSource
com.whirled.contrib.sound This class will take sounds from a SoundFactory and supply the decompressed wave bytes in ByteArray form as a DataSource.
 SoundBytesSoundFactory
com.whirled.contrib.sound This class will take bytes from a DataSource and supply a Sound that will play those bytes.
 SoundController
com.whirled.contrib.sound 
 SoundEffect
com.whirled.contrib.sound 
 SoundFactory
com.whirled.contrib.sound 
 Spawner
com.whirled.contrib.platformer.piece 
 SpawnerController
com.whirled.contrib.platformer.game 
 SpawnerDeathEventTrigger
com.whirled.contrib.platformer.game 
 SpawnerMessage
com.whirled.contrib.platformer.net 
 SpawnerSprite
com.whirled.contrib.platformer.display 
 SpawnMessage
com.whirled.contrib.platformer.net 
 StaticTask
com.whirled.contrib.platformer.board 
 StringArrayCookieProperty
com.whirled.contrib.persist 
 StringCookieProperty
com.whirled.contrib.persist 
 Table
com.whirled.contrib.card Class to perform various transformations between player id, absolute seats and relative seats.
 TabPanel
com.whirled.contrib.avrg.probe Displays a sequence of buttons along the top and makes a different child visible in the central part when each button is pressed.
 TargetedSubCtrlDef
com.whirled.contrib.avrg.probe Builds a list of method definitions that target a specific subcontrol instance that is retrieved by id.
 Team
com.whirled.contrib.card Contains the players on a card game team.
 TeamSprite
com.whirled.contrib.card.graphics Represents a team display.
 Text
com.whirled.contrib.card.graphics Simple text field supporting outlines and vertical positioning.
 ThrottlingMessageManager
com.whirled.contrib.platformer.net 
 TickController
com.whirled.contrib.platformer.game 
 TickMessage
com.whirled.contrib.platformer.net 
 TimerManager
com.whirled.contrib A class for managing a group of timers.
 TimerMovie
com.whirled.contrib.card.graphics Class to flip through the frames in a movie, allowing client code to control the duration.
 Trick
com.whirled.contrib.card.trick Represents the trick in a trick-taking card game such as spades.
 TrickEvent
com.whirled.contrib.card.trick Represents something that happens to a trick.
 TrickSprite
com.whirled.contrib.card.graphics Graphics for the cards in the trick.
 TrickTurnTimer
com.whirled.contrib.card.trick Provides different turn timings for bidding and leading a trick.
 TrophyPrizeProperty
com.whirled.contrib.persist 
 TrophyProperty
com.whirled.contrib.persist 
 TrophyPrototype
com.whirled.contrib.persist 
 TurnTimer
com.whirled.contrib.card Regulates the length of time consumed by a player making a move.
 TurnTimerEvent
com.whirled.contrib.card 
 TypedArrayCookieProperty
com.whirled.contrib.persist 
 UserCookie
com.whirled.contrib

A class to manage complicated user cookies on a GameControl.

 WalkableCollisionHandler
com.whirled.contrib.platformer.game 
 WalkableController
com.whirled.contrib.platformer.game 
 WalkTask
com.whirled.contrib.platformer.board 
 WinnersAndLosers
com.whirled.contrib.card.trick Represents the winning and losing teams of a game and provides conversion to players.
 WrapperMessage
com.whirled.contrib.platformer.net 
 ZipMultiLoader
com.whirled.contrib Utility class for MultiLoading all the files contained in a zip.