Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-22 04:33:31 +00:00
Code Issues Projects Releases Packages Wiki Activity

JSDocs fix

Browse source
This commit is contained in:
Richard Davey 2019-10-11 18:32:05 +01:00
parent 91c0b1c8a4
commit 02975813c7
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
plugins/fbinstant/src/FacebookInstantGamesPlugin.js
View file

@ -1339,18 +1339,24 @@ var FacebookInstantGamesPlugin = new Class({
* @typedef {string} ContextFilter * @typedef {string} ContextFilter
*/ */
/**
* A configuration object that may be applied to a Context Choose operation.
*
* @typedef {object} ChooseContextConfig
* @property {ContextFilter[]} [filters] - The set of filters to apply to the context suggestions: 'NEW_CONTEXT_ONLY', 'INCLUDE_EXISTING_CHALLENGES' or 'NEW_PLAYERS_ONLY'.
* @property {number} [maxSize] - The maximum number of participants that a suggested context should ideally have.
* @property {number} [minSize] - The minimum number of participants that a suggested context should ideally have.
*/
/** /**
* Opens a context selection dialog for the player. If the player selects an available context, * Opens a context selection dialog for the player. If the player selects an available context,
* the client will attempt to switch into that context, and emit the `choose` event if successful. * the client will attempt to switch into that context, and emit the `choose` event if successful.
* Otherwise, if the player exits the menu or the client fails to switch into the new context, the `choosefail` event will be emitted. * Otherwise, if the player exits the menu or the client fails to switch into the new context, the `choosefail` event will be emitted.
* *
* @method Phaser.FacebookInstantGamesPlugin#chooseContext * @method Phaser.FacebookInstantGamesPlugin#chooseContext
* @since 3.13.0 * @since 3.13.0
* *
* @param {*} [options] - An object specifying conditions on the contexts that should be offered. * @param {ChooseContextConfig} [options] - An object specifying conditions on the contexts that should be offered.
* @param {ContextFilter[]} [options.filters] - The set of filters to apply to the context suggestions: 'NEW_CONTEXT_ONLY', 'INCLUDE_EXISTING_CHALLENGES' or 'NEW_PLAYERS_ONLY'.
* @param {number} [options.maxSize] - The maximum number of participants that a suggested context should ideally have.
* @param {number} [options.minSize] - The minimum number of participants that a suggested context should ideally have.
* *
* @return {this} This Facebook Instant Games Plugin instance. * @return {this} This Facebook Instant Games Plugin instance.
*/ */