stingray.Achievements object reference

Description

Interface to access achievements on xbox one.

Constructors and accessors

stingray.Achievements()

Other related reference items

	stingray.Network
	Xbox One

Functions

destroy ( self ) Destroys the specified Achievements object.

Parameters

self :

stingray.Achievements

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

info ( self, id ) : table This function fires an event (e.g. EnemyDefeated etc).

Parameters

self :	stingray.Achievements	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
id :	string	The id for the achievement we want info for (this id is defined on XDP).

Returns

table

The details of the achievement (name, description and whether it has been achieved).

is_refreshing ( self ) : boolean Indicates whether or not the specified Achievements object has finished refreshing.

Parameters

self :

stingray.Achievements

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

boolean

Whether refresh is still ongoing or not.

refresh ( self ) Refreshes the specified Achievements object.

Parameters

self :

stingray.Achievements

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.