Packagecom.adobe.ane.gameCenter
Classpublic class GameCenterAchievement
InheritanceGameCenterAchievement Inheritance flash.events.EventDispatcher

Allows you to handle a game center achievement.



Public Properties
 PropertyDefined By
  achievedDescription : String
[read-only] Retrieves the description appears after a user achieves the achievement, as configured on iTunes connect.
GameCenterAchievement
  hidden : Boolean
[read-only] Indicates whether the user has completed this achievement.
GameCenterAchievement
  identifier : String
[read-only] Retrieves the achievement identifier as defined on iTunes connect.
GameCenterAchievement
  maximumPoints : int
[read-only] Retrieves the number of points a user can achieve by completing this achievement.
GameCenterAchievement
  title : String
[read-only] Retrieves the title of the achievement, as configured on iTunes connect.
GameCenterAchievement
  unachievedDescription : String
[read-only] Retrieves the description that appears before a user achieves the achievement, as configured on iTunes connect.
GameCenterAchievement
Public Methods
 MethodDefined By
  
GameCenterAchievement(identifier:String, title:String, hidden:Boolean, maximumPoints:int, achievedDescription:String, unachievedDescription:String)
GameCenterAchievement object.
GameCenterAchievement
  
Requests the image corresponding to the achievement.
GameCenterAchievement
Events
 Event Summary Defined By
  Dispatched when the requestImage method fails to fetch the achievement image.GameCenterAchievement
  Dispatched on successful completion of requestImage method.GameCenterAchievement
Property Detail
achievedDescriptionproperty
achievedDescription:String  [read-only]

Retrieves the description appears after a user achieves the achievement, as configured on iTunes connect.


Implementation
    public function get achievedDescription():String
hiddenproperty 
hidden:Boolean  [read-only]

Indicates whether the user has completed this achievement.


Implementation
    public function get hidden():Boolean
identifierproperty 
identifier:String  [read-only]

Retrieves the achievement identifier as defined on iTunes connect.


Implementation
    public function get identifier():String
maximumPointsproperty 
maximumPoints:int  [read-only]

Retrieves the number of points a user can achieve by completing this achievement.


Implementation
    public function get maximumPoints():int
titleproperty 
title:String  [read-only]

Retrieves the title of the achievement, as configured on iTunes connect.


Implementation
    public function get title():String
unachievedDescriptionproperty 
unachievedDescription:String  [read-only]

Retrieves the description that appears before a user achieves the achievement, as configured on iTunes connect.


Implementation
    public function get unachievedDescription():String
Constructor Detail
GameCenterAchievement()Constructor
public function GameCenterAchievement(identifier:String, title:String, hidden:Boolean, maximumPoints:int, achievedDescription:String, unachievedDescription:String)

GameCenterAchievement object.

Parameters
identifier:String — Identifier string as configured on iTunes connect.
 
title:String — Title string as configured on iTunes connect.
 
hidden:Boolean — Boolean value indicating whether the achievement is hidden.
 
maximumPoints:int — Maximum points that can be earned using this achievement.
 
achievedDescription:String — Description to be displayed after achievement completion as configured on iTunes connect.
 
unachievedDescription:String — Description to be displayed before achievement completion as configured on iTunes connect.
Method Detail
requestImage()method
public function requestImage():void

Requests the image corresponding to the achievement.

See also

com.adobe.ane.gameCenter.GameCenterAchievementEvent.ACHIEVEMENT_IMAGE_LOADED
Event Detail
achievementImageFailed Event
Event Object Type: com.adobe.ane.gameCenter.GameCenterAchievementEvent
GameCenterAchievementEvent.type property = com.adobe.ane.gameCenter.GameCenterAchievementEvent.ACHIEVEMENT_IMAGE_FAILED

Dispatched when the requestImage method fails to fetch the achievement image. The image property of this event is then set to null.

achievementImageLoaded Event  
Event Object Type: com.adobe.ane.gameCenter.GameCenterAchievementEvent
GameCenterAchievementEvent.type property = com.adobe.ane.gameCenter.GameCenterAchievementEvent.ACHIEVEMENT_IMAGE_LOADED

Dispatched on successful completion of requestImage method. The requested achievement can then be accessed using the image property of this event.