Packagecom.myflashlab.air.extensions.googleGames
Classpublic class Achievement
InheritanceAchievement Inheritance Object

Data interface for retrieving achievement information.



Public Properties
 PropertyDefined By
  currentSteps : int
[read-only] Retrieves the number of steps this user has gone toward unlocking this achievement; only applicable for Achievement.TYPE_INCREMENTAL achievement types.
Achievement
  description : String
[read-only] Retrieves the description for this achievement.
Achievement
  formattedCurrentSteps : String
[read-only] Retrieves the number of steps this user has gone toward unlocking this achievement (formatted for the user's locale); only applicable for Achievement.TYPE_INCREMENTAL achievement types.
Achievement
  formattedTotalSteps : String
[read-only] Retrieves the total number of steps necessary to unlock this achievement, formatted for the user's locale; only applicable for Achievement.TYPE_INCREMENTAL achievement types.
Achievement
  id : String
[read-only] Retrieves the ID of this achievement.
Achievement
  lastUpdatedTimestamp : Number
[read-only] Retrieves the timestamp at which this achievement was last updated.
Achievement
  name : String
[read-only] Retrieves the name of this achievement.
Achievement
  state : int
[read-only] Retrieves the state of the achievement - one of Achievement.STATE_UNLOCKED, Achievement.STATE_REVEALED, or Achievement.STATE_HIDDEN.
Achievement
  totalSteps : int
[read-only] Retrieves the total number of steps necessary to unlock this achievement; only applicable for Achievement.TYPE_INCREMENTAL achievement types.
Achievement
  type : int
[read-only] Retrieves the type of this achievement - one of Achievement.TYPE_STANDARD or Achievement.TYPE_INCREMENTAL.
Achievement
  xpValue : Number
[read-only] Retrieves the XP value of this achievement.
Achievement
Public Methods
 MethodDefined By
  
loadRevealedImage($forceReload:Boolean, $callback:Function):void
Achievement
  
loadUnlockedImage($forceReload:Boolean, $callback:Function):void
Achievement
Public Constants
 ConstantDefined By
  STATE_HIDDEN : int = 2
[static]
Achievement
  STATE_REVEALED : int = 1
[static]
Achievement
  STATE_UNLOCKED : int = 0
[static]
Achievement
  TYPE_INCREMENTAL : int = 1
[static]
Achievement
  TYPE_STANDARD : int = 0
[static]
Achievement
Property Detail
currentStepsproperty
currentSteps:int  [read-only]

Retrieves the number of steps this user has gone toward unlocking this achievement; only applicable for Achievement.TYPE_INCREMENTAL achievement types.


Implementation
    public function get currentSteps():int
descriptionproperty 
description:String  [read-only]

Retrieves the description for this achievement.


Implementation
    public function get description():String
formattedCurrentStepsproperty 
formattedCurrentSteps:String  [read-only]

Retrieves the number of steps this user has gone toward unlocking this achievement (formatted for the user's locale); only applicable for Achievement.TYPE_INCREMENTAL achievement types.


Implementation
    public function get formattedCurrentSteps():String
formattedTotalStepsproperty 
formattedTotalSteps:String  [read-only]

Retrieves the total number of steps necessary to unlock this achievement, formatted for the user's locale; only applicable for Achievement.TYPE_INCREMENTAL achievement types.


Implementation
    public function get formattedTotalSteps():String
idproperty 
id:String  [read-only]

Retrieves the ID of this achievement.


Implementation
    public function get id():String
lastUpdatedTimestampproperty 
lastUpdatedTimestamp:Number  [read-only]

Retrieves the timestamp at which this achievement was last updated. If the achievement has never been updated, this will return null.


Implementation
    public function get lastUpdatedTimestamp():Number
nameproperty 
name:String  [read-only]

Retrieves the name of this achievement.


Implementation
    public function get name():String
stateproperty 
state:int  [read-only]

Retrieves the state of the achievement - one of Achievement.STATE_UNLOCKED, Achievement.STATE_REVEALED, or Achievement.STATE_HIDDEN.


Implementation
    public function get state():int
totalStepsproperty 
totalSteps:int  [read-only]

Retrieves the total number of steps necessary to unlock this achievement; only applicable for Achievement.TYPE_INCREMENTAL achievement types.


Implementation
    public function get totalSteps():int
typeproperty 
type:int  [read-only]

Retrieves the type of this achievement - one of Achievement.TYPE_STANDARD or Achievement.TYPE_INCREMENTAL.


Implementation
    public function get type():int
xpValueproperty 
xpValue:Number  [read-only]

Retrieves the XP value of this achievement.


Implementation
    public function get xpValue():Number
Method Detail
loadRevealedImage()method
public function loadRevealedImage($forceReload:Boolean, $callback:Function):void

Parameters

$forceReload:Boolean
 
$callback:Function — expects two params, Achievement reference to the related achievement. And File object to the image file.

loadUnlockedImage()method 
public function loadUnlockedImage($forceReload:Boolean, $callback:Function):void

Parameters

$forceReload:Boolean
 
$callback:Function — expects two params, Achievement reference to the related achievement. And File object to the image file.

Constant Detail
STATE_HIDDENConstant
public static const STATE_HIDDEN:int = 2

STATE_REVEALEDConstant 
public static const STATE_REVEALED:int = 1

STATE_UNLOCKEDConstant 
public static const STATE_UNLOCKED:int = 0

TYPE_INCREMENTALConstant 
public static const TYPE_INCREMENTAL:int = 1

TYPE_STANDARDConstant 
public static const TYPE_STANDARD:int = 0