Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . FacebookInstantGamesLeaderboard

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . FacebookInstantGamesLeaderboard

This class represents one single Leaderboard that belongs to a Facebook Instant Game.

You do not need to instantiate this class directly, it will be created when you use the getLeaderboard() method of the main plugin.

Constructor:

new FacebookInstantGamesLeaderboard(plugin, data)

Parameters:

name type description
plugin Phaser.FacebookInstantGamesPlugin

A reference to the Facebook Instant Games Plugin.

data any

An Instant Game leaderboard instance.

Since: 3.13.0
Source: src//Leaderboard.js (Line 11)

Extends


Members

contextID: string
Focus
Focus

Description:

The ID of the context that the leaderboard is associated with, or null if the leaderboard is not tied to a particular context.

Type:
string
Since: 3.13.0
Source: src//Leaderboard.js (Line 64)
Focus
Focus
entryCount: integer
Focus
Focus

Description:

The total number of player entries in the leaderboard. This value defaults to zero. Populate it via the getEntryCount() method.

Type:
integer
Since: 3.13.0
Source: src//Leaderboard.js (Line 73)
Focus
Focus
name: string
Focus
Focus

Description:

The name of the leaderboard.

Type:
string
Since: 3.13.0
Source: src//Leaderboard.js (Line 55)
Focus
Focus
playerScore: LeaderboardScore
Focus
Focus

Description:

The players score object. This value defaults to null. Populate it via the getPlayerScore() method.

Type:
LeaderboardScore
Since: 3.13.0
Source: src//Leaderboard.js (Line 83)
Focus
Focus

Description:

A reference to the Facebook Instant Games Plugin.

Type:
Since: 3.13.0
Source: src//Leaderboard.js (Line 37)
Focus
Focus
ref: any
Focus
Focus

Description:

An Instant Game leaderboard instance.

Type:
any
Since: 3.13.0
Source: src//Leaderboard.js (Line 46)
Focus
Focus
scores: Array.<LeaderboardScore>
Focus
Focus

Description:

The scores in the Leaderboard from the currently requested range. This value defaults to an empty array. Populate it via the getScores() method. The contents of this array are reset each time getScores() is called.

Type:
Array.<LeaderboardScore>
Since: 3.13.0
Source: src//Leaderboard.js (Line 93)
Focus
Focus

Methods

addListener(event, fn, [context])
Focus
Focus

Description:

Add a listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#addListener
Examples:
Since: 3.0.0
Focus
Focus
destroy()
Focus
Focus

Description:

Removes all listeners.

Inherited from: Phaser.Events.EventEmitter#destroy
Examples:
Since: 3.0.0
Focus
Focus
emit(event, [args])
Focus
Focus

Description:

Calls each of the listeners registered for a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

args * <optional>

Additional arguments that will be passed to the event handler.

Returns:
Description:

true if the event had listeners, else false.

Type:
  • boolean
Inherited from: Phaser.Events.EventEmitter#emit
Examples:
Since: 3.0.0
Focus
Focus
eventNames()
Focus
Focus

Description:

Return an array listing the events for which the emitter has registered listeners.

Type:
  • Array.<(string
  • symbol)>
Inherited from: Phaser.Events.EventEmitter#eventNames
Examples:
Since: 3.0.0
Focus
Focus
getConnectedScores()
Focus
Focus

Description:

Retrieves a set of leaderboard entries, based on the current player's connected players (including the current player), ordered by local rank within the set of connected players.

The data is requested in an async call, so the result isn't available immediately.

When the call completes this Leaderboard will emit the getconnectedscores event along with an array of LeaderboardScore entries and the name of the Leaderboard.

Returns:
Description:

This Leaderboard instance.

Examples:
Since: 3.16.0
Source: src//Leaderboard.js (Line 271)
Focus
Focus
getEntryCount()
Focus
Focus

Description:

Fetches the total number of player entries in the leaderboard.

The data is requested in an async call, so the result isn't available immediately.

When the call completes this Leaderboard will emit the getentrycount event along with the count and name of the Leaderboard.

Returns:
Description:

This Leaderboard instance.

Examples:
Since: 3.13.0
Source: src//Leaderboard.js (Line 107)
Focus
Focus
getPlayerScore()
Focus
Focus

Description:

Gets the players leaderboard entry and stores it in the playerScore property.

The data is requested in an async call, so the result isn't available immediately.

When the call completes this Leaderboard will emit the getplayerscore event along with the score and the name of the Leaderboard.

If the player has not yet saved a score, the event will send null as the score value, and playerScore will be set to null as well.

Returns:
Description:

This Leaderboard instance.

Examples:
Since: 3.13.0
Source: src//Leaderboard.js (Line 189)
Focus
Focus
getScores([count], [offset])
Focus
Focus

Description:

Retrieves a set of leaderboard entries, ordered by score ranking in the leaderboard.

The data is requested in an async call, so the result isn't available immediately.

When the call completes this Leaderboard will emit the getscores event along with an array of LeaderboardScore entries and the name of the Leaderboard.

Parameters:

name type arguments Default description
count integer <optional> 10

The number of entries to attempt to fetch from the leaderboard. Currently, up to a maximum of 100 entries may be fetched per query.

offset integer <optional> 0

The offset from the top of the leaderboard that entries will be fetched from.

Returns:
Description:

This Leaderboard instance.

Examples:
Since: 3.13.0
Source: src//Leaderboard.js (Line 230)
Focus
Focus
listenerCount(event)
Focus
Focus

Description:

Return the number of listeners listening to a given event.

Parameters:

name type description
event string | symbol

The event name.

Returns:
Description:

The number of listeners.

Type:
  • number
Inherited from: Phaser.Events.EventEmitter#listenerCount
Examples:
Since: 3.0.0
Focus
Focus
listeners(event)
Focus
Focus

Description:

Return the listeners registered for a given event.

Parameters:

name type description
event string | symbol

The event name.

Returns:
Description:

The registered listeners.

Type:
  • Array.
Inherited from: Phaser.Events.EventEmitter#listeners
Examples:
Since: 3.0.0
Focus
Focus
off(event, [fn], [context], [once])
Focus
Focus

Description:

Remove the listeners of a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

fn function <optional>

Only remove the listeners that match this function.

context * <optional>

Only remove the listeners that have this context.

once boolean <optional>

Only remove one-time listeners.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#off
Examples:
Since: 3.0.0
Focus
Focus
on(event, fn, [context])
Focus
Focus

Description:

Add a listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#on
Examples:
Since: 3.0.0
Focus
Focus
once(event, fn, [context])
Focus
Focus

Description:

Add a one-time listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#once
Examples:
Since: 3.0.0
Focus
Focus
removeAllListeners([event])
Focus
Focus

Description:

Remove all listeners, or those of the specified event.

Parameters:

name type arguments description
event string | symbol <optional>

The event name.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#removeAllListeners
Examples:
Since: 3.0.0
Focus
Focus
removeListener(event, [fn], [context], [once])
Focus
Focus

Description:

Remove the listeners of a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

fn function <optional>

Only remove the listeners that match this function.

context * <optional>

Only remove the listeners that have this context.

once boolean <optional>

Only remove one-time listeners.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#removeListener
Examples:
Since: 3.0.0
Focus
Focus
setScore(score, [data])
Focus
Focus

Description:

Updates the player's score. If the player has an existing score, the old score will only be replaced if the new score is better than it. NOTE: If the leaderboard is associated with a specific context, the game must be in that context to set a score for the player.

The data is requested in an async call, so the result isn't available immediately.

When the call completes this Leaderboard will emit the setscore event along with the LeaderboardScore object and the name of the Leaderboard.

If the save fails the event will send null as the score value.

Parameters:

name type arguments description
score integer

The new score for the player. Must be a 64-bit integer number.

data string | any <optional>

Metadata to associate with the stored score. Must be less than 2KB in size. If an object is given it will be passed to JSON.stringify.

Returns:
Description:

This Leaderboard instance.

Examples:
Since: 3.13.0
Source: src//Leaderboard.js (Line 137)
Focus
Focus
shutdown()
Focus
Focus

Description:

Removes all listeners.

Inherited from: Phaser.Events.EventEmitter#shutdown
Examples:
Since: 3.0.0
Focus
Focus