added types to doc

This commit is contained in:
kremsy 2015-07-11 14:10:28 +02:00
parent 908e310fce
commit cd5a9bf9ac

View File

@ -29,22 +29,22 @@ interface CommunicationMethods {
/** Skips to a Specific Map by MxId or MapUid /** Skips to a Specific Map by MxId or MapUid
* Required Parameters * Required Parameters
* - mxId * - mxId (integer)
* OR * OR
* - mapUid * - mapUid (string)
*/ */
const SKIP_TO_MAP = "MapActions.SkipToMap"; const SKIP_TO_MAP = "MapActions.SkipToMap";
/** Adds a Map from Mania Exchange to the Server /** Adds a Map from Mania Exchange to the Server
* Required Parameters * Required Parameters
* - mxId * - mxId (integer)
* (no success returning yet because of asynchronously of adding) * (no success returning yet because of asynchronously of adding)
*/ */
const ADD_MAP = "MapManager.AddMap"; const ADD_MAP = "MapManager.AddMap";
/** Removes a Map from the Server /** Removes a Map from the Server
* Required Parameters * Required Parameters
* - mapUid * - mapUid (string)
* Optional Parameters * Optional Parameters
* - displayMessage (default true) * - displayMessage (default true)
* - eraseMapFile (default false) * - eraseMapFile (default false)
@ -60,9 +60,9 @@ interface CommunicationMethods {
/** Gets the current Map /** Gets the current Map
* Required Parameters * Required Parameters
* - mxId * - mxId (integer)
* OR * OR
* - mapUid * - mapUid (string)
*/ */
const GET_CURRENT_MAP = "MapManager.GetCurrentMap"; const GET_CURRENT_MAP = "MapManager.GetCurrentMap";
@ -117,7 +117,7 @@ interface CommunicationMethods {
* Required Params * Required Params
* - login * - login
* Optional Params * Optional Params
* - teamId (id of the team the player shoudl get forced into it) * - teamId (integer, id of the team the player should get forced into it)
*/ */
const FORCE_PLAYER_TO_PLAY = "PlayerActions.ForcePlayerToPlay"; const FORCE_PLAYER_TO_PLAY = "PlayerActions.ForcePlayerToPlay";