Awards the specified prize item to this client's player (the default) or a specified player. If the supplied prize identifier is not valid, this will not be known until the request is processed on the server, so the method will return successfully but no prize will have been awarded. Thus you should be careful not to misspell your prize identifier in your code or in the associated prize item.

Note: a game is only allowed to award a prize once per game session. This is to guard against bugs that might try to award many hundreds of the same prize to a user while playing a game. If you really want to award multiple instances of a prize, you will need to make different prize items with unique identifiers which all reference the same target item.

Note also: because a game can award the same prize more than once if the player earns the prize in separate game sessions, a game that wishes to only award a prize once should couple the award of the prize with the award of a trophy and then structure their code like so:

     if (_ctrl.awardTrophy("special_award_trophy")) {
         _ctrl.awardPrize("special_award_avatar");
     }
     

The first time the player accomplishes the necessary goal, they will be awarded the trophy and the prize. Subsequently, awardTrophy() will return false indicating that the player already has the trophy in question and the prize will not be awarded. Alternatively the game could store whether or not the player has earned the prize in a user cookie.

Note thirdly: Clients may only award prized to the current player. Server agents do not have a current player and therefore must pass in a valid player id.

Awards the specified trophy to this client's player (the default) or a specified player. If the supplied trophy identifier is not valid, this will not be known until the request is processed on the server, so the method will return succcessfully but no trophy will have been awarded. Thus, you should be careful not to misspell your trophy identifier in your code or in the associated trophy source item.

Note: Clients may award trophies to the current player. Server agents do not have a current player and therefore must pass in a valid player id.

Get the user-specific game data for the specified occupant. The first time this is requested per game instance it will be retrieved from the database. After that, it will be returned from memory.

      function onGotUserCookie (cookie :Object, occupantId :int) :void
      {
          // read cookie
      }
     

Get the specified player's partyId, or 0 if they're not in a party.

Returns all item packs owned by this client's player (the default) or a specified player. The packs are returned as an array of objects with the following properties:

     ident - string identifier of item pack
     name - human readable name of item pack
     mediaURL - URL for item pack content
     count - the number of copies of this item pack owned by this player
     

Note: Clients may only get the item packs of the current player. Server agents do not have a current player and therefore must pass in a valid player id.

Returns all level packs owned by this client's player (the default) or a specified player. The packs are returned as an array of objects with the following properties:

     ident - string identifier of item pack
     name - human readable name of item pack
     mediaURL - URL for item pack content
     premium - boolean indicating that content is premium or not
     

Note: Clients may only get the level packs of the current player. Server agents do not have a current player and therefore must pass in a valid player id.

Returns true if this client's player (the default) or a specified player has the trophy with the specified identifier.

Note: Clients may only test the trophies of the current player. Server agents do not have a current player and therefore must pass in a valid player id.

Returns true if this player is a full registered member of Whirled, false if they are an anonymous guest. Games that wish to grant additional functionality to fully-registered members thereby encouraging guests to register for Whirled are themselves encouraged!

Note: this will always return false in the test environment.

Requests to consume the specified item pack. The player must currently own at least one copy of the item pack. This will display a standard dialog asking the player if they wish to consume the pack.

If the player accepts the request to consume the item pack, a GameContentEvent.PLAYER_CONTENT_CONSUMED event will be dispatched on this control (on both the client and server).

Note: this method may only be called on the client. It will always return false on the server.

Store persistent data that can later be retrieved by an instance of this game. The maximum size of this data is 4096 bytes AFTER AMF3 encoding.

Note: Clients may only set the cookie of the current player. Server agents do not have a current player and therefore must pass in a valid player id.

Dispatched when this player has been awarded coins.

An event type dispatched at the end of a game (before GAME_ENDED) to inform the game that the player has earned coins.

Dispatched when this player has purchased new game content.

Indicates that the a player has purchased new game content.

Dispatched when this player has consumed an item pack.

Indicates that the a player has consumed an item pack. contentType() for this event will always be ITEM_PACK.

ID constant passed to cookie, prize and trophy functions to refer to the current player. On normal flash clients, this is used as a default value and should not be changed. On server agents, a valid playerId must be provided since there is no current player.

See also