| Signature returnType methodName(arg1, arg2, ...) | Description |
|---|---|
| array system.listMethods() | Return an array of all available XML-RPC methods on this server. |
| array system.methodSignature(string) | Given the name of a method, return an array of legal signatures. Each signature is an array of strings. The first item of each signature is the return type, and any others items are parameter types. |
| string system.methodHelp(string) | Given the name of a method, return a help string. |
| array system.multicall(array) | Process an array of calls, and return an array of results. Calls should be structs of the form {'methodName': string, 'params': array}. Each result will either be a single-item array containing the result value, or a struct of the form {'faultCode': int, 'faultString': string}. This is useful when you need to make lots of small calls without lots of round trips. |
| boolean Authenticate(string, string) | Allow user authentication by specifying a login and a password, to gain access to the set of functionalities corresponding to this authorization level. |
| boolean ChangeAuthPassword(string, string) | Change the password for the specified login/user. Only available to SuperAdmin. |
| boolean EnableCallbacks(boolean) | Allow the GameServer to call you back. |
| boolean SetApiVersion(string) | Define the wanted api. |
| struct GetVersion() | Returns a struct with the Name, TitleId, Version, Build and ApiVersion of the application remotely controlled. |
| struct GetStatus() | Returns the current status of the server. |
| boolean QuitGame() | Quit the application. Only available to SuperAdmin. |
| boolean CallVote(string) | Call a vote for a cmd. The command is a XML string corresponding to an XmlRpc request. Only available to Admin. |
| boolean CallVoteEx(string, double, int, int) | Extended call vote. Same as CallVote, but you can additionally supply specific parameters for this vote: a ratio, a time out and who is voting. Special timeout values: a ratio of '-1' means default; a timeout of '0' means default, '1' means indefinite; Voters values: '0' means only active players, '1' means any player, '2' is for everybody, pure spectators included. Only available to Admin. |
| boolean InternalCallVote() | Used internally by game. |
| boolean CancelVote() | Cancel the current vote. Only available to Admin. |
| struct GetCurrentCallVote() | Returns the vote currently in progress. The returned structure is { CallerLogin, CmdName, CmdParam }. |
| boolean SetCallVoteTimeOut(int) | Set a new timeout for waiting for votes. A zero value disables callvote. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetCallVoteTimeOut() | Get the current and next timeout for waiting for votes. The struct returned contains two fields 'CurrentValue' and 'NextValue'. |
| boolean SetCallVoteRatio(double) | Set a new default ratio for passing a vote. Must lie between 0 and 1. Only available to Admin. |
| double GetCallVoteRatio() | Get the current default ratio for passing a vote. This value lies between 0 and 1. |
| boolean SetCallVoteRatios(array) | Set the ratios list for passing specific votes. The parameter is an array of structs {string Command, double Ratio}, ratio is in [0,1] or -1 for vote disabled. Only available to Admin. |
| array GetCallVoteRatios() | Get the current ratios for passing votes. |
| boolean SetCallVoteRatiosEx(boolean, array) | Set the ratios list for passing specific votes, extended version with parameters matching. The parameters, a boolean ReplaceAll (or else, only modify specified ratios, leaving the previous ones unmodified) and an array of structs {string Command, string Param, double Ratio}, ratio is in [0,1] or -1 for vote disabled. Param is matched against the vote parameters to make more specific ratios, leave empty to match all votes for the command. Only available to Admin. |
| array GetCallVoteRatiosEx() | Get the current ratios for passing votes, extended version with parameters matching. |
| boolean ChatSendServerMessage(string) | Send a text message to all clients without the server login. Only available to Admin. |
| boolean ChatSendServerMessageToLanguage(array, string) | Send a localised text message to all clients without the server login, or optionally to a Login (which can be a single login or a list of comma-separated logins). The parameter is an array of structures {Lang='xx', Text='...'}. If no matching language is found, the last text in the array is used. Only available to Admin. |
| boolean ChatSendServerMessageToId(string, int) | Send a text message without the server login to the client with the specified PlayerId. Only available to Admin. |
| boolean ChatSendServerMessageToLogin(string, string) | Send a text message without the server login to the client with the specified login. Login can be a single login or a list of comma-separated logins. Only available to Admin. |
| boolean ChatSend(string) | Send a text message to all clients. Only available to Admin. |
| boolean ChatSendToLanguage(array, string) | Send a localised text message to all clients, or optionally to a Login (which can be a single login or a list of comma-separated logins). The parameter is an array of structures {Lang='xx', Text='...'}. If no matching language is found, the last text in the array is used. Only available to Admin. |
| boolean ChatSendToLogin(string, string) | Send a text message to the client with the specified login. Login can be a single login or a list of comma-separated logins. Only available to Admin. |
| boolean ChatSendToId(string, int) | Send a text message to the client with the specified PlayerId. Only available to Admin. |
| array GetChatLines() | Returns the last chat lines. Maximum of 40 lines. Only available to Admin. |
| boolean ChatEnableManualRouting(boolean, boolean) | The chat messages are no longer dispatched to the players, they only go to the rpc callback and the controller has to manually forward them. The second (optional) parameter allows all messages from the server to be automatically forwarded. Only available to Admin. |
| boolean ChatForwardToLogin(string, string, string) | (Text, SenderLogin, DestLogin) Send a text message to the specified DestLogin (or everybody if empty) on behalf of SenderLogin. DestLogin can be a single login or a list of comma-separated logins. Only available if manual routing is enabled. Only available to Admin. |
| boolean SendNotice(string, string, int) | Display a notice on all clients. The parameters are the text message to display, and the login of the avatar to display next to it (or '' for no avatar), and an optional 'variant' in [0 = normal, 1 = Sad, 2 = Happy]. Only available to Admin. |
| boolean SendNoticeToId(int, string, int, int) | Display a notice on the client with the specified UId. The parameters are the Uid of the client to whom the notice is sent, the text message to display, and the UId of the avatar to display next to it (or '255' for no avatar), and an optional 'variant' in [0 = normal, 1 = Sad, 2 = Happy]. Only available to Admin. |
| boolean SendNoticeToLogin(string, string, string, int) | Display a notice on the client with the specified login. The parameters are the login of the client to whom the notice is sent, the text message to display, and the login of the avatar to display next to it (or '' for no avatar), and an optional 'variant' in [0 = normal, 1 = Sad, 2 = Happy]. Login can be a single login or a list of comma-separated logins. Only available to Admin. |
| boolean SendDisplayManialinkPage(string, int, boolean) | Display a manialink page on all clients. The parameters are the xml description of the page to display, a timeout to autohide it (0 = permanent), and a boolean to indicate whether the page must be hidden as soon as the user clicks on a page option. Only available to Admin. |
| boolean SendDisplayManialinkPageToId(int, string, int, boolean) | Display a manialink page on the client with the specified UId. The first parameter is the UId of the player, the other are identical to 'SendDisplayManialinkPage'. Only available to Admin. |
| boolean SendDisplayManialinkPageToLogin(string, string, int, boolean) | Display a manialink page on the client with the specified login. The first parameter is the login of the player, the other are identical to 'SendDisplayManialinkPage'. Login can be a single login or a list of comma-separated logins. Only available to Admin. |
| boolean SendHideManialinkPage() | Hide the displayed manialink page on all clients. Only available to Admin. |
| boolean SendHideManialinkPageToId(int) | Hide the displayed manialink page on the client with the specified UId. Only available to Admin. |
| boolean SendHideManialinkPageToLogin(string) | Hide the displayed manialink page on the client with the specified login. Login can be a single login or a list of comma-separated logins. Only available to Admin. |
| array GetManialinkPageAnswers() | Returns the latest results from the current manialink page, as an array of structs {string Login, int PlayerId, int Result} Result==0 -> no answer, Result>0.... -> answer from the player. |
| boolean SendOpenLinkToId(int, string, int) | Opens a link in the client with the specified UId. The parameters are the Uid of the client to whom the link to open is sent, the link url, and the 'LinkType' (0 in the external browser, 1 in the internal manialink browser). Only available to Admin. |
| boolean SendOpenLinkToLogin(string, string, int) | Opens a link in the client with the specified login. The parameters are the login of the client to whom the link to open is sent, the link url, and the 'LinkType' (0 in the external browser, 1 in the internal manialink browser). Login can be a single login or a list of comma-separated logins. Only available to Admin. |
| boolean Kick(string, string) | Kick the player with the specified login, with an optional message. Only available to Admin. |
| boolean KickId(int, string) | Kick the player with the specified PlayerId, with an optional message. Only available to Admin. |
| boolean Ban(string, string) | Ban the player with the specified login, with an optional message. Only available to Admin. |
| boolean BanAndBlackList(string, string, boolean) | Ban the player with the specified login, with a message. Add it to the black list, and optionally save the new list. Only available to Admin. |
| boolean BanId(int, string) | Ban the player with the specified PlayerId, with an optional message. Only available to Admin. |
| boolean UnBan(string) | Unban the player with the specified login. Only available to Admin. |
| boolean CleanBanList() | Clean the ban list of the server. Only available to Admin. |
| array GetBanList(int, int) | Returns the list of banned players. This method takes two parameters. The first parameter specifies the maximum number of infos to be returned, and the second one the starting index in the list. The list is an array of structures. Each structure contains the following fields : Login, ClientName and IPAddress. |
| boolean BlackList(string) | Blacklist the player with the specified login. Only available to SuperAdmin. |
| boolean BlackListId(int) | Blacklist the player with the specified PlayerId. Only available to SuperAdmin. |
| boolean UnBlackList(string) | UnBlackList the player with the specified login. Only available to SuperAdmin. |
| boolean CleanBlackList() | Clean the blacklist of the server. Only available to SuperAdmin. |
| array GetBlackList(int, int) | Returns the list of blacklisted players. This method takes two parameters. The first parameter specifies the maximum number of infos to be returned, and the second one the starting index in the list. The list is an array of structures. Each structure contains the following fields : Login. |
| boolean LoadBlackList(string) | Load the black list file with the specified file name. Only available to Admin. |
| boolean SaveBlackList(string) | Save the black list in the file with specified file name. Only available to Admin. |
| boolean AddGuest(string) | Add the player with the specified login on the guest list. Only available to Admin. |
| boolean AddGuestId(int) | Add the player with the specified PlayerId on the guest list. Only available to Admin. |
| boolean RemoveGuest(string) | Remove the player with the specified login from the guest list. Only available to Admin. |
| boolean RemoveGuestId(int) | Remove the player with the specified PlayerId from the guest list. Only available to Admin. |
| boolean CleanGuestList() | Clean the guest list of the server. Only available to Admin. |
| array GetGuestList(int, int) | Returns the list of players on the guest list. This method takes two parameters. The first parameter specifies the maximum number of infos to be returned, and the second one the starting index in the list. The list is an array of structures. Each structure contains the following fields : Login. |
| boolean LoadGuestList(string) | Load the guest list file with the specified file name. Only available to Admin. |
| boolean SaveGuestList(string) | Save the guest list in the file with specified file name. Only available to Admin. |
| boolean SetBuddyNotification(string, boolean) | Sets whether buddy notifications should be sent in the chat. login is the login of the player, or '' for global setting, and enabled is the value. Only available to Admin. |
| boolean GetBuddyNotification(string) | Gets whether buddy notifications are enabled for login, or '' to get the global setting. |
| boolean WriteFile(string, base64) | Write the data to the specified file. The filename is relative to the Maps path. Only available to Admin. |
| boolean TunnelSendDataToId(int, base64) | Send the data to the specified player. Only available to Admin. |
| boolean TunnelSendDataToLogin(string, base64) | Send the data to the specified player. Login can be a single login or a list of comma-separated logins. Only available to Admin. |
| boolean Echo(string, string) | Just log the parameters and invoke a callback. Can be used to talk to other xmlrpc clients connected, or to make custom votes. If used in a callvote, the first parameter will be used as the vote message on the clients. Only available to Admin. |
| boolean Ignore(string) | Ignore the player with the specified login. Only available to Admin. |
| boolean IgnoreId(int) | Ignore the player with the specified PlayerId. Only available to Admin. |
| boolean UnIgnore(string) | Unignore the player with the specified login. Only available to Admin. |
| boolean UnIgnoreId(int) | Unignore the player with the specified PlayerId. Only available to Admin. |
| boolean CleanIgnoreList() | Clean the ignore list of the server. Only available to Admin. |
| array GetIgnoreList(int, int) | Returns the list of ignored players. This method takes two parameters. The first parameter specifies the maximum number of infos to be returned, and the second one the starting index in the list. The list is an array of structures. Each structure contains the following fields : Login. |
| int Pay(string, int, string) | Pay planets from the server account to a player, returns the BillId. This method takes three parameters: Login of the payee, Cost in planets to pay and a Label to send with the payment. The creation of the transaction itself may cost planets, so you need to have planets on the server account. Only available to Admin. |
| int SendBill(string, int, string, string) | Create a bill, send it to a player, and return the BillId. This method takes four parameters: LoginFrom of the payer, Cost in planets the player has to pay, Label of the transaction and an optional LoginTo of the payee (if empty string, then the server account is used). The creation of the transaction itself may cost planets, so you need to have planets on the server account. Only available to Admin. |
| struct GetBillState(int) | Returns the current state of a bill. This method takes one parameter, the BillId. Returns a struct containing State, StateName and TransactionId. Possible enum values are: CreatingTransaction, Issued, ValidatingPayement, Payed, Refused, Error. |
| int GetServerPlanets() | Returns the current number of planets on the server account. |
| struct GetSystemInfo() | Get some system infos, including connection rates (in kbps). |
| boolean SetConnectionRates(int, int) | Set the download and upload rates (in kbps). |
| array GetServerTags() | Returns the list of tags and associated values set on this server. Only available to Admin. |
| boolean SetServerTag(string, string) | Set a tag and its value on the server. This method takes two parameters. The first parameter specifies the name of the tag, and the second one its value. The list is an array of structures {string Name, string Value}. Only available to Admin. |
| boolean UnsetServerTag(string) | Unset the tag with the specified name on the server. Only available to Admin. |
| boolean ResetServerTags() | Reset all tags on the server. Only available to Admin. |
| boolean SetServerName(string) | Set a new server name in utf8 format. Only available to Admin. |
| string GetServerName() | Get the server name in utf8 format. |
| boolean SetServerComment(string) | Set a new server comment in utf8 format. Only available to Admin. |
| string GetServerComment() | Get the server comment in utf8 format. |
| boolean SetHideServer(int) | Set whether the server should be hidden from the public server list (0 = visible, 1 = always hidden, 2 = hidden from nations). Only available to Admin. |
| int GetHideServer() | Get whether the server wants to be hidden from the public server list. |
| boolean SetServerPassword(string) | Set a new password for the server. Only available to Admin. |
| string GetServerPassword() | Get the server password if called as Admin or Super Admin, else returns if a password is needed or not. |
| boolean SetServerPasswordForSpectator(string) | Set a new password for the spectator mode. Only available to Admin. |
| string GetServerPasswordForSpectator() | Get the password for spectator mode if called as Admin or Super Admin, else returns if a password is needed or not. |
| boolean SetMaxPlayers(int) | Set a new maximum number of players. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetMaxPlayers() | Get the current and next maximum number of players allowed on server. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetMaxSpectators(int) | Set a new maximum number of Spectators. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetMaxSpectators() | Get the current and next maximum number of Spectators allowed on server. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetLobbyInfo(boolean, int, int, double) | Declare if the server is a lobby, the number and maximum number of players currently managed by it, and the average level of the players. Only available to Admin. |
| struct GetLobbyInfo() | Get whether the server if a lobby, the number and maximum number of players currently managed by it. The struct returned contains 4 fields IsLobby, LobbyPlayers, LobbyMaxPlayers, and LobbyPlayersLevel. |
| boolean CustomizeQuitDialog(string, string, boolean, int) | Customize the clients 'leave server' dialog box. Parameters are: ManialinkPage, SendToServer url '#qjoin=login@title', ProposeAddToFavorites and DelayQuitButton (in milliseconds). Only available to Admin. |
| boolean SendToServerAfterMatchEnd(string) | Prior to loading next map, execute SendToServer url '#qjoin=login@title'. Only available to Admin. |
| boolean KeepPlayerSlots(boolean) | Set whether, when a player is switching to spectator, the server should still consider him a player and keep his player slot, or not. Only available to Admin. |
| boolean IsKeepingPlayerSlots() | Get whether the server keeps player slots when switching to spectator. |
| boolean AllowMapDownload(boolean) | Allow clients to download maps from the server. Only available to Admin. |
| boolean IsMapDownloadAllowed() | Returns if clients can download maps from the server. |
| string GameDataDirectory() | Returns the path of the game datas directory. Only available to Admin. |
| string GetMapsDirectory() | Returns the path of the maps directory. Only available to Admin. |
| string GetSkinsDirectory() | Returns the path of the skins directory. Only available to Admin. |
| boolean SetTeamInfo(string, double, string, string, double, string, string, double, string) | Set Team names and colors (deprecated). Only available to Admin. |
| struct GetTeamInfo(int) | Return Team info for a given clan (0 = no clan, 1, 2). The structure contains: Name, ZonePath, City, EmblemUrl, HuePrimary, HueSecondary, RGB, ClubLinkUrl. Only available to Admin. |
| boolean SetForcedClubLinks(string, string) | Set the clublinks to use for the two clans. Only available to Admin. |
| struct GetForcedClubLinks() | Get the forced clublinks. |
| string ConnectFakePlayer() | (debug tool) Connect a fake player to the server and returns the login. Only available to Admin. |
| boolean DisconnectFakePlayer(string) | (debug tool) Disconnect a fake player, or all the fake players if login is '*'. Only available to Admin. |
| struct GetDemoTokenInfosForPlayer(string) | Returns the token infos for a player. The returned structure is { TokenCost, CanPayToken }. |
| boolean DisableHorns(boolean) | Disable player horns. Only available to Admin. |
| boolean AreHornsDisabled() | Returns whether the horns are disabled. |
| boolean DisableServiceAnnounces(boolean) | Disable the automatic mesages when a player connects/disconnects from the server. Only available to Admin. |
| boolean AreServiceAnnouncesDisabled() | Returns whether the automatic mesages are disabled. |
| boolean DisableProfileSkins(boolean) | Ignore players profile skin customisation. Only available to Admin. |
| boolean AreProfileSkinsDisabled() | Returns whether the custom skins are disabled. |
| boolean AutoSaveReplays(boolean) | Enable the autosaving of all replays (vizualisable replays with all players, but not validable) on the server. Only available to SuperAdmin. |
| boolean IsAutoSaveReplaysEnabled() | Returns if autosaving of all replays is enabled on the server. |
| boolean SaveCurrentReplay(string) | Saves the current replay (vizualisable replays with all players, but not validable). Pass a filename, or '' for an automatic filename. Only available to Admin. |
| boolean SaveBestGhostsReplay(string, string) | Saves a replay with the ghost of all the players' best race. First parameter is the login of the player (or '' for all players), Second parameter is the filename, or '' for an automatic filename. Only available to Admin. |
| base64 GetValidationReplay(string) | Returns a replay containing the data needed to validate the current best time of the player. The parameter is the login of the player. |
| boolean SetServerOptions(struct) | Set new server options using the struct passed as parameters. This struct must contain the following fields : Name, Comment, Password, PasswordForSpectator, NextCallVoteTimeOut, CallVoteRatio. May additionally include any of the other members listed in RpcGetServerOptions. Only available to Admin. A change of NextMaxPlayers, NextMaxSpectators, NextCallVoteTimeOut requires a map restart to be taken into account. |
| struct GetServerOptions() | Returns a struct containing the server options: Name, Comment, Password, PasswordForSpectator, HideServer, CurrentMaxPlayers, NextMaxPlayers, CurrentMaxSpectators, NextMaxSpectators, KeepPlayerSlots, CurrentCallVoteTimeOut, NextCallVoteTimeOut, CallVoteRatio, AllowMapDownload, AutoSaveReplays, ClientInputsMaxLatency, DisableHorns, DisableServiceAnnounces,PacketAssembly_PacketsPerFrame, PacketAssembly_FullPacketsPerFrame, TrustClientSimu_ClientToServer_SendingRate, DelayedVisuals_ServerToClient_SendingRate. |
| boolean SetForcedTeams(boolean) | Set whether the players can choose their side or if the teams are forced by the server (using ForcePlayerTeam()). Only available to Admin. |
| boolean GetForcedTeams() | Returns whether the players can choose their side or if the teams are forced by the server. |
| boolean SetForcedMods(boolean, array) | Set the mods to apply on the clients. Parameters: Override, if true even the maps with a mod will be overridden by the server setting; and Mods, an array of structures [{EnvName, Url}, ...]. Requires a map restart to be taken into account. Only available to Admin. |
| struct GetForcedMods() | Get the mods settings. |
| boolean SetForcedMusic(boolean, string) | Set the music to play on the clients. Parameters: Override, if true even the maps with a custom music will be overridden by the server setting, and a UrlOrFileName for the music. Requires a map restart to be taken into account. Only available to Admin. |
| struct GetForcedMusic() | Get the music setting. |
| boolean SetForcedSkins(array) | Defines a list of remappings for player skins. It expects a list of structs Orig, Name, Checksum, Url. Orig is the name of the skin to remap, or '*' for any other. Name, Checksum, Url define the skin to use. (They are optional, you may set value '' for any of those. All 3 null means same as Orig). Will only affect players connecting after the value is set. Only available to Admin. |
| array GetForcedSkins() | Get the current forced skins. |
| string GetLastConnectionErrorMessage() | Returns the last error message for an internet connection. Only available to Admin. |
| boolean SetClientInputsMaxLatency(int) | Set the maximum time the server must wait for inputs from the clients before dropping data, or '0' for auto-adaptation. Only used by ShootMania. Only available to Admin. |
| int GetClientInputsMaxLatency() | Get the current ClientInputsMaxLatency. Only used by ShootMania. |
| string GetModeScriptText() | Get the current mode script. |
| boolean SetModeScriptText(string) | Set the mode script and restart. Only available to Admin. |
| struct GetModeScriptInfo() | Returns the description of the current mode script, as a structure containing: Name, CompatibleTypes, Description, Version and the settings available. |
| struct GetModeScriptSettings() | Returns the current settings of the mode script. |
| boolean SetModeScriptSettings(struct) | Change the settings of the mode script. Only available to Admin. |
| boolean SendModeScriptCommands(struct) | Send commands to the mode script. Only available to Admin. |
| boolean SetModeScriptSettingsAndCommands(struct, struct) | Change the settings and send commands to the mode script. Only available to Admin. |
| struct GetModeScriptVariables() | Returns the current xml-rpc variables of the mode script. |
| boolean SetModeScriptVariables(struct) | Set the xml-rpc variables of the mode script. Only available to Admin. |
| boolean TriggerModeScriptEvent(string, string) | Send an event to the mode script. Only available to Admin. |
| boolean TriggerModeScriptEventArray(string, array) | Send an event to the mode script. Only available to Admin. |
| boolean SetServerPlugin(boolean, string, struct) | Set the ServerPlugin settings. Parameters: ForceReload to reload from disk, optionally: Name the filename relative to Scripts/ directory, Settings the script #Settings to apply. Only available to Admin. |
| struct GetServerPlugin() | Get the ServerPlugin current settings. |
| struct GetServerPluginVariables() | Returns the current xml-rpc variables of the server script. |
| boolean SetServerPluginVariables(struct) | Set the xml-rpc variables of the server script. Only available to Admin. |
| boolean TriggerServerPluginEvent(string, string) | Send an event to the server script. Only available to Admin. |
| boolean TriggerServerPluginEventArray(string, array) | Send an event to the server script. Only available to Admin. |
| struct GetScriptCloudVariables(string, string) | Get the script cloud variables of given object. Only available to Admin. |
| boolean SetScriptCloudVariables(string, string, struct) | Set the script cloud variables of given object. Only available to Admin. |
| boolean RestartMap() | Restarts the map, with an optional boolean parameter DontClearCupScores (only available in cup mode). Only available to Admin. |
| boolean NextMap() | Switch to next map, with an optional boolean parameter DontClearCupScores (only available in cup mode). Only available to Admin. |
| boolean AutoTeamBalance() | Attempt to balance teams. Only available to Admin. |
| boolean StopServer() | Stop the server. Only available to SuperAdmin. |
| struct GetCurrentGameInfo() | (deprecated) |
| struct GetNextGameInfo() | (deprecated) |
| struct GetGameInfos() | (deprecated) |
| boolean SetForceShowAllOpponents(int) | Set whether to override the players preferences and always display all opponents (0=no override, 1=show all, other value=minimum number of opponents). Only available to Admin. Requires a map restart to be taken into account. |
| struct GetForceShowAllOpponents() | Get whether players are forced to show all opponents. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetScriptName(string) | Set a new mode script name for script mode. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetScriptName() | Get the current and next mode script name for script mode. The struct returned contains two fields CurrentValue and NextValue. |
| int GetCurrentMapIndex() | Returns the current map index in the selection, or -1 if the map is no longer in the selection. |
| int GetNextMapIndex() | Returns the map index in the selection that will be played next (unless the current one is restarted...) |
| boolean SetNextMapIndex(int) | Sets the map index in the selection that will be played next (unless the current one is restarted...) |
| boolean SetNextMapIdent(string) | Sets the map in the selection that will be played next (unless the current one is restarted...) |
| boolean JumpToMapIndex(int) | Immediately jumps to the map designated by the index in the selection. |
| boolean JumpToMapIdent(string) | Immediately jumps to the map designated by its identifier (it must be in the selection). |
| struct GetCurrentMapInfo() | Returns a struct containing the infos for the current map. The struct contains the following fields : Name, UId, FileName, Author, AuthorNickname, Environnement, Mood, BronzeTime, SilverTime, GoldTime, AuthorTime, CopperPrice, LapRace, NbLaps, NbCheckpoints, MapType, MapStyle. |
| struct GetNextMapInfo() | Returns a struct containing the infos for the next map. The struct contains the following fields : Name, UId, FileName, Author, AuthorNickname, Environnement, Mood, BronzeTime, SilverTime, GoldTime, AuthorTime, CopperPrice, LapRace, MapType, MapStyle. (NbLaps and NbCheckpoints are also present but always set to -1) |
| struct GetMapInfo(string) | Returns a struct containing the infos for the map with the specified filename. The struct contains the following fields : Name, UId, FileName, Author, AuthorNickname, Environnement, Mood, BronzeTime, SilverTime, GoldTime, AuthorTime, CopperPrice, LapRace, MapType, MapStyle. (NbLaps and NbCheckpoints are also present but always set to -1) |
| boolean CheckMapForCurrentServerParams(string) | Returns a boolean if the map with the specified filename matches the current server settings. |
| array GetMapList(int, int) | Returns a list of maps among the current selection of the server. This method take two parameters. The first parameter specifies the maximum number of infos to be returned, and the second one the starting index in the selection. The list is an array of structures. Each structure contains the following fields : Name, UId, FileName, Environnement, Author, AuthorNickname, GoldTime, CopperPrice, MapType, MapStyle. |
| boolean AddMap(string) | Add the map with the specified filename at the end of the current selection. Only available to Admin. |
| int AddMapList(array) | Add the list of maps with the specified filenames at the end of the current selection. The list of maps to add is an array of strings. Only available to Admin. |
| boolean RemoveMap(string) | Remove the map with the specified filename from the current selection. Only available to Admin. |
| int RemoveMapList(array) | Remove the list of maps with the specified filenames from the current selection. The list of maps to remove is an array of strings. Only available to Admin. |
| boolean InsertMap(string) | Insert the map with the specified filename after the current map. Only available to Admin. |
| int InsertMapList(array) | Insert the list of maps with the specified filenames after the current map. The list of maps to insert is an array of strings. Only available to Admin. |
| boolean ChooseNextMap(string) | Set as next map the one with the specified filename, if it is present in the selection. Only available to Admin. |
| int ChooseNextMapList(array) | Set as next maps the list of maps with the specified filenames, if they are present in the selection. The list of maps to choose is an array of strings. Only available to Admin. |
| int LoadMatchSettings(string) | Set a list of maps defined in the playlist with the specified filename as the current selection of the server, and load the gameinfos from the same file. Only available to Admin. |
| int AppendPlaylistFromMatchSettings(string) | Add a list of maps defined in the playlist with the specified filename at the end of the current selection. Only available to Admin. |
| int SaveMatchSettings(string) | Save the current selection of map in the playlist with the specified filename, as well as the current gameinfos. Only available to Admin. |
| int InsertPlaylistFromMatchSettings(string) | Insert a list of maps defined in the playlist with the specified filename after the current map. Only available to Admin. |
| array GetPlayerList(int, int, int) | Returns the list of players on the server. This method take two parameters. The first parameter specifies the maximum number of infos to be returned, and the second one the starting index in the list, an optional 3rd parameter is used for compatibility: struct version (0 = united, 1 = forever, 2 = forever, including the servers). The list is an array of PlayerInfo structures. Forever PlayerInfo struct is: Login, NickName, PlayerId, TeamId, SpectatorStatus, LadderRanking, and Flags. LadderRanking is 0 when not in official mode, Flags = ForceSpectator(0,1,2) + StereoDisplayMode * 1000 + IsManagedByAnOtherServer * 10000 + IsServer * 100000 + HasPlayerSlot * 1000000 + IsBroadcasting * 10000000 + HasJoinedGame * 100000000 SpectatorStatus = Spectator + TemporarySpectator * 10 + PureSpectator * 100 + AutoTarget * 1000 + CurrentTargetId * 10000 |
| struct GetPlayerInfo(string, int) | Returns a struct containing the infos on the player with the specified login, with an optional parameter for compatibility: struct version (0 = united, 1 = forever). The structure is identical to the ones from GetPlayerList. Forever PlayerInfo struct is: Login, NickName, PlayerId, TeamId, SpectatorStatus, LadderRanking, and Flags. LadderRanking is 0 when not in official mode, Flags = ForceSpectator(0,1,2) + StereoDisplayMode * 1000 + IsManagedByAnOtherServer * 10000 + IsServer * 100000 + HasPlayerSlot * 1000000 + IsBroadcasting * 10000000 + HasJoinedGame * 100000000 SpectatorStatus = Spectator + TemporarySpectator * 10 + PureSpectator * 100 + AutoTarget * 1000 + CurrentTargetId * 10000 |
| struct GetDetailedPlayerInfo(string) | Returns a struct containing the infos on the player with the specified login. The structure contains the following fields : Login, NickName, PlayerId, TeamId, IPAddress, DownloadRate, UploadRate, Language, IsSpectator, IsInOfficialMode, a structure named Avatar, an array of structures named Skins, a structure named LadderStats, HoursSinceZoneInscription and OnlineRights (0: nations account, 3: united account). Each structure of the array Skins contains two fields Environnement and a struct PackDesc. Each structure PackDesc, as well as the struct Avatar, contains two fields FileName and Checksum. |
| struct GetMainServerPlayerInfo(int) | Returns a struct containing the player infos of the game server (ie: in case of a basic server, itself; in case of a relay server, the main server), with an optional parameter for compatibility: struct version (0 = united, 1 = forever). The structure is identical to the ones from GetPlayerList. Forever PlayerInfo struct is: Login, NickName, PlayerId, TeamId, SpectatorStatus, LadderRanking, and Flags. LadderRanking is 0 when not in official mode, Flags = ForceSpectator(0,1,2) + StereoDisplayMode * 1000 + IsManagedByAnOtherServer * 10000 + IsServer * 100000 + HasPlayerSlot * 1000000 + IsBroadcasting * 10000000 + HasJoinedGame * 100000000 SpectatorStatus = Spectator + TemporarySpectator * 10 + PureSpectator * 100 + AutoTarget * 1000 + CurrentTargetId * 10000 |
| array GetCurrentRanking(int, int) | Returns the current rankings for the race in progress. (In trackmania legacy team modes, the scores for the two teams are returned. In other modes, it's the individual players' scores) This method take two parameters. The first parameter specifies the maximum number of infos to be returned, and the second one the starting index in the ranking. The ranking returned is a list of structures. Each structure contains the following fields : Login, NickName, PlayerId and Rank. In addition, for legacy trackmania modes it also contains BestTime, Score, NbrLapsFinished, LadderScore, and an array BestCheckpoints that contains the checkpoint times for the best race. |
| array GetCurrentRankingForLogin(string) | Returns the current ranking for the race in progressof the player with the specified login (or list of comma-separated logins). The ranking returned is a list of structures. Each structure contains the following fields : Login, NickName, PlayerId and Rank. In addition, for legacy trackmania modes it also contains BestTime, Score, NbrLapsFinished, LadderScore, and an array BestCheckpoints that contains the checkpoint times for the best race. |
| int GetCurrentWinnerTeam() | Returns the current winning team for the race in progress. (-1: if not in team mode, or draw match) |
| boolean ForceScores(array, boolean) | Force the scores of the current game. Only available in rounds and team mode. You have to pass an array of structs {int PlayerId, int Score}. And a boolean SilentMode - if true, the scores are silently updated (only available for SuperAdmin), allowing an external controller to do its custom counting... Only available to Admin/SuperAdmin. |
| boolean ForcePlayerTeam(string, int) | Force the team of the player. Only available in team mode. You have to pass the login and the team number (0 or 1). Only available to Admin. |
| boolean ForcePlayerTeamId(int, int) | Force the team of the player. Only available in team mode. You have to pass the playerid and the team number (0 or 1). Only available to Admin. |
| boolean ForceSpectator(string, int) | Force the spectating status of the player. You have to pass the login and the spectator mode (0: user selectable, 1: spectator, 2: player, 3: spectator but keep selectable). Only available to Admin. |
| boolean ForceSpectatorId(int, int) | Force the spectating status of the player. You have to pass the playerid and the spectator mode (0: user selectable, 1: spectator, 2: player, 3: spectator but keep selectable). Only available to Admin. |
| boolean ForceSpectatorTarget(string, string, int) | Force spectators to look at a specific player. You have to pass the login of the spectator (or '' for all) and the login of the target (or '' for automatic), and an integer for the camera type to use (-1 = leave unchanged, 0 = replay, 1 = follow, 2 = free). Only available to Admin. |
| boolean ForceSpectatorTargetId(int, int, int) | Force spectators to look at a specific player. You have to pass the id of the spectator (or -1 for all) and the id of the target (or -1 for automatic), and an integer for the camera type to use (-1 = leave unchanged, 0 = replay, 1 = follow, 2 = free). Only available to Admin. |
| boolean SpectatorReleasePlayerSlot(string) | Pass the login of the spectator. A spectator that once was a player keeps his player slot, so that he can go back to race mode. Calling this function frees this slot for another player to connect. Only available to Admin. |
| boolean SpectatorReleasePlayerSlotId(int) | Pass the playerid of the spectator. A spectator that once was a player keeps his player slot, so that he can go back to race mode. Calling this function frees this slot for another player to connect. Only available to Admin. |
| struct GetNetworkStats() | Returns a struct containing the networks stats of the server. The structure contains the following fields : Uptime, NbrConnection, MeanConnectionTime, MeanNbrPlayer, RecvNetRate, SendNetRate, TotalReceivingSize, TotalSendingSize and an array of structures named PlayerNetInfos. Each structure of the array PlayerNetInfos contains the following fields : Login, IPAddress, LastTransferTime, DeltaBetweenTwoLastNetState, PacketLossRate. Only available to SuperAdmin. |
| boolean StartServerLan() | Start a server on lan, using the current configuration. Only available to SuperAdmin. |
| boolean StartServerInternet() | Start a server on internet, using the current configuration. Only available to SuperAdmin. |
| Signature returnType methodName(arg1, arg2, ...) |
Description |
|---|---|
| boolean DisableProfileSkins(boolean) | Ignore players profile skin customisation. Only available to Admin. |
| boolean AreProfileSkinsDisabled() | Returns whether the custom skins are disabled. |
| Signature | Changes |
|---|---|
| boolean SetServerOptions(struct) | A bunch of legacy struct fields were removed, description was updated. |
| struct GetServerOptions() |
|
| struct GetCurrentGameInfo() | Deprecated |
| struct GetNextGameInfo() | Deprecated |
| struct GetGameInfos() | Deprecated |
| struct GetCurrentMapInfo() |
|
| struct GetNextMapInfo() |
|
| struct GetMapInfo(string) |
|
| array GetMapList(int, int) |
|
| Signature returnType methodName(arg1, arg2, ...) |
Description |
|---|---|
| boolean IsRelayServer() | Returns true if this is a relay server. |
| boolean EnableP2PUpload(boolean) | Enable or disable peer-to-peer upload from server. Only available to Admin. |
| boolean IsP2PUpload() | Returns if the peer-to-peer upload from server is enabled. |
| boolean EnableP2PDownload(boolean) | Enable or disable peer-to-peer download for server. Only available to Admin. |
| boolean IsP2PDownload() | Returns if the peer-to-peer download for server is enabled. |
| boolean AutoSaveValidationReplays(boolean) | Enable the autosaving on the server of validation replays, every time a player makes a new time. Only available to SuperAdmin. |
| boolean IsAutoSaveValidationReplaysEnabled() | Returns if autosaving of validation replays is enabled on the server. |
| boolean SetLadderMode(int) | Set a new ladder mode between ladder disabled (0) and forced (1). Only available to Admin. Requires a map restart to be taken into account. |
| struct GetLadderMode() | Get the current and next ladder mode on server. The struct returned contains two fields CurrentValue and NextValue. |
| struct GetLadderServerLimits() | Get the ladder points limit for the players allowed on this server. The struct returned contains two fields LadderServerLimitMin and LadderServerLimitMax. |
| boolean SetVehicleNetQuality(int) | Set the network vehicle quality to Fast (0) or High (1). Only available to Admin. Requires a map restart to be taken into account. |
| struct GetVehicleNetQuality() | Get the current and next network vehicle quality on server. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetRefereePassword(string) | Set a new password for the referee mode. Only available to Admin. |
| string GetRefereePassword() | Get the password for referee mode if called as Admin or Super Admin, else returns if a password is needed or not. |
| boolean SetRefereeMode(int) | Set the referee validation mode. 0 = validate the top3 players, 1 = validate all players. Only available to Admin. |
| int GetRefereeMode() | Get the referee validation mode. |
| boolean SetUseChangingValidationSeed(boolean) | Set whether the game should use a variable validation seed or not. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetUseChangingValidationSeed() | Get the current and next value of UseChangingValidationSeed. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetWarmUp(boolean) | Sets whether the server is in warm-up phase or not. Only available to Admin. |
| boolean GetWarmUp() | Returns whether the server is in warm-up phase. |
| boolean ForceEndRound() | In Rounds or Laps mode, force the end of round without waiting for all players to giveup/finish. Only available to Admin. |
| boolean SetGameInfos(struct) | Set new game settings using the struct passed as parameters. This struct must contain the following fields : GameMode, ChatTime, RoundsPointsLimit, RoundsUseNewRules, RoundsForcedLaps, TimeAttackLimit, TimeAttackSynchStartPeriod, TeamPointsLimit, TeamMaxPoints, TeamUseNewRules, LapsNbLaps, LapsTimeLimit, FinishTimeout, and optionally: AllWarmUpDuration, DisableRespawn, ForceShowAllOpponents, RoundsPointsLimitNewRules, TeamPointsLimitNewRules, CupPointsLimit, CupRoundsPerMap, CupNbWinners, CupWarmUpDuration. Only available to Admin. Requires a map restart to be taken into account. |
| boolean SetGameMode(int) | Set a new game mode between Script (0), Rounds (1), TimeAttack (2), Team (3), Laps (4), Cup (5) and Stunts (6). Only available to Admin. Requires a map restart to be taken into account. |
| int GetGameMode() | Get the current game mode. |
| boolean SetChatTime(int) | Set a new chat time value in milliseconds (actually 'chat time' is the duration of the end race podium, 0 means no podium displayed.). Only available to Admin. |
| struct GetChatTime() | Get the current and next chat time. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetFinishTimeout(int) | Set a new finish timeout (for rounds/laps mode) value in milliseconds. 0 means default. 1 means adaptative to the duration of the map. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetFinishTimeout() | Get the current and next FinishTimeout. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetAllWarmUpDuration(int) | Set whether to enable the automatic warm-up phase in all modes. 0 = no, otherwise it's the duration of the phase, expressed in number of rounds (in rounds/team mode), or in number of times the gold medal time (other modes). Only available to Admin. Requires a map restart to be taken into account. |
| struct GetAllWarmUpDuration() | Get whether the automatic warm-up phase is enabled in all modes. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetDisableRespawn(boolean) | Set whether to disallow players to respawn. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetDisableRespawn() | Get whether players are disallowed to respawn. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetTimeAttackLimit(int) | Set a new time limit for time attack mode. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetTimeAttackLimit() | Get the current and next time limit for time attack mode. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetTimeAttackSynchStartPeriod(int) | Set a new synchronized start period for time attack mode. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetTimeAttackSynchStartPeriod() | Get the current and synchronized start period for time attack mode. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetLapsTimeLimit(int) | Set a new time limit for laps mode. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetLapsTimeLimit() | Get the current and next time limit for laps mode. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetNbLaps(int) | Set a new number of laps for laps mode. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetNbLaps() | Get the current and next number of laps for laps mode. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetRoundForcedLaps(int) | Set a new number of laps for rounds mode (0 = default, use the number of laps from the maps, otherwise forces the number of rounds for multilaps maps). Only available to Admin. Requires a map restart to be taken into account. |
| struct GetRoundForcedLaps() | Get the current and next number of laps for rounds mode. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetRoundPointsLimit(int) | Set a new points limit for rounds mode (value set depends on UseNewRulesRound). Only available to Admin. Requires a map restart to be taken into account. |
| struct GetRoundPointsLimit() | Get the current and next points limit for rounds mode (values returned depend on UseNewRulesRound). The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetRoundCustomPoints(array, boolean) | Set the points used for the scores in rounds mode. Points is an array of decreasing integers for the players from the first to last. And you can add an optional boolean to relax the constraint checking on the scores. Only available to Admin. |
| array GetRoundCustomPoints() | Gets the points used for the scores in rounds mode. |
| boolean SetUseNewRulesRound(boolean) | Set if new rules are used for rounds mode. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetUseNewRulesRound() | Get if the new rules are used for rounds mode (Current and next values). The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetTeamPointsLimit(int) | Set a new points limit for team mode (value set depends on UseNewRulesTeam). Only available to Admin. Requires a map restart to be taken into account. |
| struct GetTeamPointsLimit() | Get the current and next points limit for team mode (values returned depend on UseNewRulesTeam). The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetMaxPointsTeam(int) | Set a new number of maximum points per round for team mode. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetMaxPointsTeam() | Get the current and next number of maximum points per round for team mode. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetUseNewRulesTeam(boolean) | Set if new rules are used for team mode. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetUseNewRulesTeam() | Get if the new rules are used for team mode (Current and next values). The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetCupPointsLimit(int) | Set the points needed for victory in Cup mode. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetCupPointsLimit() | Get the points needed for victory in Cup mode. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetCupRoundsPerMap(int) | Sets the number of rounds before going to next map in Cup mode. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetCupRoundsPerMap() | Get the number of rounds before going to next map in Cup mode. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetCupWarmUpDuration(int) | Set whether to enable the automatic warm-up phase in Cup mode. 0 = no, otherwise it's the duration of the phase, expressed in number of rounds. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetCupWarmUpDuration() | Get whether the automatic warm-up phase is enabled in Cup mode. The struct returned contains two fields CurrentValue and NextValue. |
| boolean SetCupNbWinners(int) | Set the number of winners to determine before the match is considered over. Only available to Admin. Requires a map restart to be taken into account. |
| struct GetCupNbWinners() | Get the number of winners to determine before the match is considered over. The struct returned contains two fields CurrentValue and NextValue. |
| boolean ManualFlowControlEnable(boolean) | Enable control of the game flow: the game will wait for the caller to validate state transitions. Only available to Admin. |
| boolean ManualFlowControlProceed() | Allows the game to proceed. Only available to Admin. |
| int ManualFlowControlIsEnabled() | Returns whether the manual control of the game flow is enabled. 0 = no, 1 = yes by the xml-rpc client making the call, 2 = yes, by some other xml-rpc client. Only available to Admin. |
| string ManualFlowControlGetCurTransition() | Returns the transition that is currently blocked, or '' if none. (That's exactly the value last received by the callback.) Only available to Admin. |
| string CheckEndMatchCondition() | Returns the current match ending condition. Return values are: 'Playing', 'ChangeMap' or 'Finished'. |
You can find the python script that generates the output for this reference at: https://github.com/EvoTM/Trackmania-Wiki-Scripts/tree/master/dedicated-server/xml-rpc/methods