| Method (arguments) | Return Type | Help |
|---|---|---|
| system.listMethods () | array | Return an array of all available XML-RPC methods on this server. |
| system.methodSignature (string) | array | 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. |
| system.methodHelp (string) | string | Given the name of a method, return a help string. |
| system.multicall (array) | 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. |
| Authenticate (string,string) | boolean | Allow user authentication by specifying a login and a password, to gain access to the set of functionalities corresponding to this authorization level. |
| ChangeAuthPassword (string,string) | boolean | Change the password for the specified login/user. Only available to SuperAdmin. |
| EnableCallbacks (boolean) | boolean | Allow the GameServer to call you back. |
| SetApiVersion (string) | boolean | Define the wanted api. |
| GetVersion () | struct | Returns a struct with the Name, TitleId, Version, Build and ApiVersion of the application remotely controlled. |
| GetStatus () | struct | Returns the current status of the server. |
| QuitGame () | boolean | Quit the application. Only available to SuperAdmin. |
| CallVote (string) | boolean | Call a vote for a cmd. The command is a XML string corresponding to an XmlRpc request. Only available to Admin. |
| CallVoteEx (string,double,int,int) | boolean | 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. |
| InternalCallVote () | boolean | Used internally by game. |
| CancelVote () | boolean | Cancel the current vote. Only available to Admin. |
| GetCurrentCallVote () | struct | Returns the vote currently in progress. The returned structure is { CallerLogin, CmdName, CmdParam }. |
| SetCallVoteTimeOut (int) | boolean | 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. |
| GetCallVoteTimeOut () | struct | Get the current and next timeout for waiting for votes. The struct returned contains two fields 'CurrentValue' and 'NextValue'. |
| SetCallVoteRatio (double) | boolean | Set a new default ratio for passing a vote. Must lie between 0 and 1. Only available to Admin. |
| GetCallVoteRatio () | double | Get the current default ratio for passing a vote. This value lies between 0 and 1. |
| SetCallVoteRatios (array) | boolean | 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. |
| GetCallVoteRatios () | array | Get the current ratios for passing votes. |
| SetCallVoteRatiosEx (boolean,array) | boolean | 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. |
| GetCallVoteRatiosEx () | array | Get the current ratios for passing votes, extended version with parameters matching. |
| ChatSendServerMessage (string) | boolean | Send a text message to all clients without the server login. Only available to Admin. |
| ChatSendServerMessageToLanguage (array,string) | boolean | 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. |
| ChatSendServerMessageToId (string,int) | boolean | Send a text message without the server login to the client with the specified PlayerId. Only available to Admin. |
| ChatSendServerMessageToLogin (string,string) | boolean | 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. |
| ChatSend (string) | boolean | Send a text message to all clients. Only available to Admin. |
| ChatSendToLanguage (array,string) | boolean | 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. |
| ChatSendToLogin (string,string) | boolean | 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. |
| ChatSendToId (string,int) | boolean | Send a text message to the client with the specified PlayerId. Only available to Admin. |
| GetChatLines () | array | Returns the last chat lines. Maximum of 40 lines. Only available to Admin. |
| ChatEnableManualRouting (boolean,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. |
| ChatForwardToLogin (string,string,string) | boolean | (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. |
| SendNotice (string,string,int) | boolean | 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. |
| SendNoticeToId (int,string,int,int) | boolean | 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. |
| SendNoticeToLogin (string,string,string,int) | boolean | 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. |
| SendDisplayManialinkPage (string,int,boolean) | 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. |
| SendDisplayManialinkPageToId (int,string,int,boolean) | 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. |
| SendDisplayManialinkPageToLogin (string,string,int,boolean) | 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. |
| SendHideManialinkPage () | boolean | Hide the displayed manialink page on all clients. Only available to Admin. |
| SendHideManialinkPageToId (int) | boolean | Hide the displayed manialink page on the client with the specified UId. Only available to Admin. |
| SendHideManialinkPageToLogin (string) | boolean | 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. |
| GetManialinkPageAnswers () | array | 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. |
| SendOpenLinkToId (int,string,int) | boolean | 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. |
| SendOpenLinkToLogin (string,string,int) | boolean | 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. |
| Kick (string,string) | boolean | Kick the player with the specified login, with an optional message. Only available to Admin. |
| KickId (int,string) | boolean | Kick the player with the specified PlayerId, with an optional message. Only available to Admin. |
| Ban (string,string) | boolean | Ban the player with the specified login, with an optional message. Only available to Admin. |
| BanAndBlackList (string,string,boolean) | 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. |
| BanId (int,string) | boolean | Ban the player with the specified PlayerId, with an optional message. Only available to Admin. |
| UnBan (string) | boolean | Unban the player with the specified login. Only available to Admin. |
| CleanBanList () | boolean | Clean the ban list of the server. Only available to Admin. |
| GetBanList (int,int) | array | 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. |
| BlackList (string) | boolean | Blacklist the player with the specified login. Only available to SuperAdmin. |
| BlackListId (int) | boolean | Blacklist the player with the specified PlayerId. Only available to SuperAdmin. |
| UnBlackList (string) | boolean | UnBlackList the player with the specified login. Only available to SuperAdmin. |
| CleanBlackList () | boolean | Clean the blacklist of the server. Only available to SuperAdmin. |
| GetBlackList (int,int) | array | 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. |
| LoadBlackList (string) | boolean | Load the black list file with the specified file name. Only available to Admin. |
| SaveBlackList (string) | boolean | Save the black list in the file with specified file name. Only available to Admin. |
| AddGuest (string) | boolean | Add the player with the specified login on the guest list. Only available to Admin. |
| AddGuestId (int) | boolean | Add the player with the specified PlayerId on the guest list. Only available to Admin. |
| RemoveGuest (string) | boolean | Remove the player with the specified login from the guest list. Only available to Admin. |
| RemoveGuestId (int) | boolean | Remove the player with the specified PlayerId from the guest list. Only available to Admin. |
| CleanGuestList () | boolean | Clean the guest list of the server. Only available to Admin. |
| GetGuestList (int,int) | array | 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. |
| LoadGuestList (string) | boolean | Load the guest list file with the specified file name. Only available to Admin. |
| SaveGuestList (string) | boolean | Save the guest list in the file with specified file name. Only available to Admin. |
| SetBuddyNotification (string,boolean) | 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. |
| GetBuddyNotification (string) | boolean | Gets whether buddy notifications are enabled for login, or '' to get the global setting. |
| WriteFile (string,base64) | boolean | Write the data to the specified file. The filename is relative to the Maps path. Only available to Admin. |
| TunnelSendDataToId (int,base64) | boolean | Send the data to the specified player. Only available to Admin. |
| TunnelSendDataToLogin (string,base64) | boolean | Send the data to the specified player. Login can be a single login or a list of comma-separated logins. Only available to Admin. |
| Echo (string,string) | boolean | 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. |
| Ignore (string) | boolean | Ignore the player with the specified login. Only available to Admin. |
| IgnoreId (int) | boolean | Ignore the player with the specified PlayerId. Only available to Admin. |
| UnIgnore (string) | boolean | Unignore the player with the specified login. Only available to Admin. |
| UnIgnoreId (int) | boolean | Unignore the player with the specified PlayerId. Only available to Admin. |
| CleanIgnoreList () | boolean | Clean the ignore list of the server. Only available to Admin. |
| GetIgnoreList (int,int) | array | 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. |
| Pay (string,int,string) | int | 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. |
| SendBill (string,int,string,string) | int | 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. |
| GetBillState (int) | struct | 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. |
| GetServerPlanets () | int | Returns the current number of planets on the server account. |
| GetSystemInfo () | struct | Get some system infos, including connection rates (in kbps). |
| SetConnectionRates (int,int) | boolean | Set the download and upload rates (in kbps). |
| GetServerTags () | array | Returns the list of tags and associated values set on this server. Only available to Admin. |
| SetServerTag (string,string) | boolean | 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. |
| UnsetServerTag (string) | boolean | Unset the tag with the specified name on the server. Only available to Admin. |
| ResetServerTags () | boolean | Reset all tags on the server. Only available to Admin. |
| SetServerName (string) | boolean | Set a new server name in utf8 format. Only available to Admin. |
| GetServerName () | string | Get the server name in utf8 format. |
| SetServerComment (string) | boolean | Set a new server comment in utf8 format. Only available to Admin. |
| GetServerComment () | string | Get the server comment in utf8 format. |
| SetHideServer (int) | boolean | 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. |
| GetHideServer () | int | Get whether the server wants to be hidden from the public server list. |
| IsRelayServer () | boolean | Returns true if this is a relay server. |
| SetServerPassword (string) | boolean | Set a new password for the server. Only available to Admin. |
| GetServerPassword () | string | Get the server password if called as Admin or Super Admin, else returns if a password is needed or not. |
| SetServerPasswordForSpectator (string) | boolean | Set a new password for the spectator mode. Only available to Admin. |
| GetServerPasswordForSpectator () | string | Get the password for spectator mode if called as Admin or Super Admin, else returns if a password is needed or not. |
| SetMaxPlayers (int) | boolean | Set a new maximum number of players. Only available to Admin. Requires a map restart to be taken into account. |
| GetMaxPlayers () | struct | Get the current and next maximum number of players allowed on server. The struct returned contains two fields CurrentValue and NextValue. |
| SetMaxSpectators (int) | boolean | Set a new maximum number of Spectators. Only available to Admin. Requires a map restart to be taken into account. |
| GetMaxSpectators () | struct | Get the current and next maximum number of Spectators allowed on server. The struct returned contains two fields CurrentValue and NextValue. |
| SetLobbyInfo (boolean,int,int,double) | boolean | 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. |
| GetLobbyInfo () | struct | 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. |
| CustomizeQuitDialog (string,string,boolean,int) | boolean | Customize the clients 'leave server' dialog box. Parameters are: ManialinkPage, SendToServer url '#qjoin=login@title', ProposeAddToFavorites and DelayQuitButton (in milliseconds). Only available to Admin. |
| SendToServerAfterMatchEnd (string) | boolean | Prior to loading next map, execute SendToServer url '#qjoin=login@title'. Only available to Admin. |
| KeepPlayerSlots (boolean) | 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. |
| IsKeepingPlayerSlots () | boolean | Get whether the server keeps player slots when switching to spectator. |
| EnableP2PUpload (boolean) | boolean | Enable or disable peer-to-peer upload from server. Only available to Admin. |
| IsP2PUpload () | boolean | Returns if the peer-to-peer upload from server is enabled. |
| EnableP2PDownload (boolean) | boolean | Enable or disable peer-to-peer download for server. Only available to Admin. |
| IsP2PDownload () | boolean | Returns if the peer-to-peer download for server is enabled. |
| AllowMapDownload (boolean) | boolean | Allow clients to download maps from the server. Only available to Admin. |
| IsMapDownloadAllowed () | boolean | Returns if clients can download maps from the server. |
| GameDataDirectory () | string | Returns the path of the game datas directory. Only available to Admin. |
| GetMapsDirectory () | string | Returns the path of the maps directory. Only available to Admin. |
| GetSkinsDirectory () | string | Returns the path of the skins directory. Only available to Admin. |
| SetTeamInfo (string,double,string,string,double,string,string,double,string) | boolean | Set Team names and colors (deprecated). Only available to Admin. |
| GetTeamInfo (int) | struct | 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. |
| SetForcedClubLinks (string,string) | boolean | Set the clublinks to use for the two clans. Only available to Admin. |
| GetForcedClubLinks () | struct | Get the forced clublinks. |
| ConnectFakePlayer () | string | (debug tool) Connect a fake player to the server and returns the login. Only available to Admin. |
| DisconnectFakePlayer (string) | boolean | (debug tool) Disconnect a fake player, or all the fake players if login is '*'. Only available to Admin. |
| GetDemoTokenInfosForPlayer (string) | struct | Returns the token infos for a player. The returned structure is { TokenCost, CanPayToken }. |
| DisableHorns (boolean) | boolean | Disable player horns. Only available to Admin. |
| AreHornsDisabled () | boolean | Returns whether the horns are disabled. |
| DisableServiceAnnounces (boolean) | boolean | Disable the automatic mesages when a player connects/disconnects from the server. Only available to Admin. |
| AreServiceAnnouncesDisabled () | boolean | Returns whether the automatic mesages are disabled. |
| AutoSaveReplays (boolean) | boolean | Enable the autosaving of all replays (vizualisable replays with all players, but not validable) on the server. Only available to SuperAdmin. |
| AutoSaveValidationReplays (boolean) | boolean | Enable the autosaving on the server of validation replays, every time a player makes a new time. Only available to SuperAdmin. |
| IsAutoSaveReplaysEnabled () | boolean | Returns if autosaving of all replays is enabled on the server. |
| IsAutoSaveValidationReplaysEnabled () | boolean | Returns if autosaving of validation replays is enabled on the server. |
| SaveCurrentReplay (string) | boolean | Saves the current replay (vizualisable replays with all players, but not validable). Pass a filename, or '' for an automatic filename. Only available to Admin. |
| SaveBestGhostsReplay (string,string) | boolean | 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. |
| GetValidationReplay (string) | base64 | Returns a replay containing the data needed to validate the current best time of the player. The parameter is the login of the player. |
| SetLadderMode (int) | boolean | 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. |
| GetLadderMode () | struct | Get the current and next ladder mode on server. The struct returned contains two fields CurrentValue and NextValue. |
| GetLadderServerLimits () | struct | Get the ladder points limit for the players allowed on this server. The struct returned contains two fields LadderServerLimitMin and LadderServerLimitMax. |
| SetVehicleNetQuality (int) | boolean | Set the network vehicle quality to Fast (0) or High (1). Only available to Admin. Requires a map restart to be taken into account. |
| GetVehicleNetQuality () | struct | Get the current and next network vehicle quality on server. The struct returned contains two fields CurrentValue and NextValue. |
| SetServerOptions (struct) | boolean | Set new server options using the struct passed as parameters. This struct must contain the following fields : Name, Comment, Password, PasswordForSpectator, NextMaxPlayers, NextMaxSpectators, IsP2PUpload, IsP2PDownload, NextLadderMode, NextVehicleNetQuality, NextCallVoteTimeOut, CallVoteRatio, AllowMapDownload, AutoSaveReplays, and optionally for forever: RefereePassword, RefereeMode, AutoSaveValidationReplays, HideServer, UseChangingValidationSeed, ClientInputsMaxLatency, DisableHorns, DisableServiceAnnounces, KeepPlayerSlots, ServerPlugin. Only available to Admin. A change of NextMaxPlayers, NextMaxSpectators, NextLadderMode, NextVehicleNetQuality, NextCallVoteTimeOut or UseChangingValidationSeed requires a map restart to be taken into account. |
| GetServerOptions () | struct | Returns a struct containing the server options: Name, Comment, Password, PasswordForSpectator, CurrentMaxPlayers, NextMaxPlayers, CurrentMaxSpectators, NextMaxSpectators, KeepPlayerSlots, IsP2PUpload, IsP2PDownload, CurrentLadderMode, NextLadderMode, CurrentVehicleNetQuality, NextVehicleNetQuality, CurrentCallVoteTimeOut, NextCallVoteTimeOut, CallVoteRatio, AllowMapDownload, AutoSaveReplays, RefereePassword, RefereeMode, AutoSaveValidationReplays, HideServer, CurrentUseChangingValidationSeed, NextUseChangingValidationSeed, ClientInputsMaxLatency, DisableHorns, DisableServiceAnnounces. |
| SetForcedTeams (boolean) | boolean | Set whether the players can choose their side or if the teams are forced by the server (using ForcePlayerTeam()). Only available to Admin. |
| GetForcedTeams () | boolean | Returns whether the players can choose their side or if the teams are forced by the server. |
| SetForcedMods (boolean,array) | boolean | 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. |
| GetForcedMods () | struct | Get the mods settings. |
| SetForcedMusic (boolean,string) | boolean | 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. |
| GetForcedMusic () | struct | Get the music setting. |
| SetForcedSkins (array) | boolean | 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. |
| GetForcedSkins () | array | Get the current forced skins. |
| GetLastConnectionErrorMessage () | string | Returns the last error message for an internet connection. Only available to Admin. |
| SetRefereePassword (string) | boolean | Set a new password for the referee mode. Only available to Admin. |
| GetRefereePassword () | string | Get the password for referee mode if called as Admin or Super Admin, else returns if a password is needed or not. |
| SetRefereeMode (int) | boolean | Set the referee validation mode. 0 = validate the top3 players, 1 = validate all players. Only available to Admin. |
| GetRefereeMode () | int | Get the referee validation mode. |
| SetUseChangingValidationSeed (boolean) | 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. |
| GetUseChangingValidationSeed () | struct | Get the current and next value of UseChangingValidationSeed. The struct returned contains two fields CurrentValue and NextValue. |
| SetClientInputsMaxLatency (int) | boolean | 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. |
| GetClientInputsMaxLatency () | int | Get the current ClientInputsMaxLatency. Only used by ShootMania. |
| SetWarmUp (boolean) | boolean | Sets whether the server is in warm-up phase or not. Only available to Admin. |
| GetWarmUp () | boolean | Returns whether the server is in warm-up phase. |
| GetModeScriptText () | string | Get the current mode script. |
| SetModeScriptText (string) | boolean | Set the mode script and restart. Only available to Admin. |
| GetModeScriptInfo () | struct | Returns the description of the current mode script, as a structure containing: Name, CompatibleTypes, Description, Version and the settings available. |
| GetModeScriptSettings () | struct | Returns the current settings of the mode script. |
| SetModeScriptSettings (struct) | boolean | Change the settings of the mode script. Only available to Admin. |
| SendModeScriptCommands (struct) | boolean | Send commands to the mode script. Only available to Admin. |
| SetModeScriptSettingsAndCommands (struct,struct) | boolean | Change the settings and send commands to the mode script. Only available to Admin. |
| GetModeScriptVariables () | struct | Returns the current xml-rpc variables of the mode script. |
| SetModeScriptVariables (struct) | boolean | Set the xml-rpc variables of the mode script. Only available to Admin. |
| TriggerModeScriptEvent (string,string) | boolean | Send an event to the mode script. Only available to Admin. |
| TriggerModeScriptEventArray (string,array) | boolean | Send an event to the mode script. Only available to Admin. |
| SetServerPlugin (boolean,string,struct) | boolean | 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. |
| GetServerPlugin () | struct | Get the ServerPlugin current settings. |
| GetServerPluginVariables () | struct | Returns the current xml-rpc variables of the server script. |
| SetServerPluginVariables (struct) | boolean | Set the xml-rpc variables of the server script. Only available to Admin. |
| TriggerServerPluginEvent (string,string) | boolean | Send an event to the server script. Only available to Admin. |
| TriggerServerPluginEventArray (string,array) | boolean | Send an event to the server script. Only available to Admin. |
| GetScriptCloudVariables (string,string) | struct | Get the script cloud variables of given object. Only available to Admin. |
| SetScriptCloudVariables (string,string,struct) | boolean | Set the script cloud variables of given object. Only available to Admin. |
| RestartMap () | boolean | Restarts the map, with an optional boolean parameter DontClearCupScores (only available in cup mode). Only available to Admin. |
| NextMap () | boolean | Switch to next map, with an optional boolean parameter DontClearCupScores (only available in cup mode). Only available to Admin. |
| AutoTeamBalance () | boolean | Attempt to balance teams. Only available to Admin. |
| StopServer () | boolean | Stop the server. Only available to SuperAdmin. |
| ForceEndRound () | boolean | In Rounds or Laps mode, force the end of round without waiting for all players to giveup/finish. Only available to Admin. |
| SetGameInfos (struct) | boolean | 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. |
| GetCurrentGameInfo () | struct | Returns a struct containing the current game settings, ie: GameMode, ChatTime, NbMaps, RoundsPointsLimit, RoundsUseNewRules, RoundsForcedLaps, TimeAttackLimit, TimeAttackSynchStartPeriod, TeamPointsLimit, TeamMaxPoints, TeamUseNewRules, LapsNbLaps, LapsTimeLimit, FinishTimeout, and additionally for version 1: AllWarmUpDuration, DisableRespawn, ForceShowAllOpponents, RoundsPointsLimitNewRules, TeamPointsLimitNewRules, CupPointsLimit, CupRoundsPerMap, CupNbWinners, CupWarmUpDuration. |
| GetNextGameInfo () | struct | Returns a struct containing the game settings for the next map, ie: GameMode, ChatTime, NbMaps, RoundsPointsLimit, RoundsUseNewRules, RoundsForcedLaps, TimeAttackLimit, TimeAttackSynchStartPeriod, TeamPointsLimit, TeamMaxPoints, TeamUseNewRules, LapsNbLaps, LapsTimeLimit, FinishTimeout, and additionally for version 1: AllWarmUpDuration, DisableRespawn, ForceShowAllOpponents, RoundsPointsLimitNewRules, TeamPointsLimitNewRules, CupPointsLimit, CupRoundsPerMap, CupNbWinners, CupWarmUpDuration. |
| GetGameInfos () | struct | Returns a struct containing two other structures, the first containing the current game settings and the second the game settings for next map. The first structure is named CurrentGameInfos and the second NextGameInfos. |
| SetGameMode (int) | boolean | 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. |
| GetGameMode () | int | Get the current game mode. |
| SetChatTime (int) | boolean | 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. |
| GetChatTime () | struct | Get the current and next chat time. The struct returned contains two fields CurrentValue and NextValue. |
| SetFinishTimeout (int) | boolean | 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. |
| GetFinishTimeout () | struct | Get the current and next FinishTimeout. The struct returned contains two fields CurrentValue and NextValue. |
| SetAllWarmUpDuration (int) | boolean | 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. |
| GetAllWarmUpDuration () | struct | Get whether the automatic warm-up phase is enabled in all modes. The struct returned contains two fields CurrentValue and NextValue. |
| SetDisableRespawn (boolean) | boolean | Set whether to disallow players to respawn. Only available to Admin. Requires a map restart to be taken into account. |
| GetDisableRespawn () | struct | Get whether players are disallowed to respawn. The struct returned contains two fields CurrentValue and NextValue. |
| SetForceShowAllOpponents (int) | boolean | 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. |
| GetForceShowAllOpponents () | struct | Get whether players are forced to show all opponents. The struct returned contains two fields CurrentValue and NextValue. |
| SetScriptName (string) | boolean | Set a new mode script name for script mode. Only available to Admin. Requires a map restart to be taken into account. |
| GetScriptName () | struct | Get the current and next mode script name for script mode. The struct returned contains two fields CurrentValue and NextValue. |
| SetTimeAttackLimit (int) | boolean | Set a new time limit for time attack mode. Only available to Admin. Requires a map restart to be taken into account. |
| GetTimeAttackLimit () | struct | Get the current and next time limit for time attack mode. The struct returned contains two fields CurrentValue and NextValue. |
| SetTimeAttackSynchStartPeriod (int) | boolean | Set a new synchronized start period for time attack mode. Only available to Admin. Requires a map restart to be taken into account. |
| GetTimeAttackSynchStartPeriod () | struct | Get the current and synchronized start period for time attack mode. The struct returned contains two fields CurrentValue and NextValue. |
| SetLapsTimeLimit (int) | boolean | Set a new time limit for laps mode. Only available to Admin. Requires a map restart to be taken into account. |
| GetLapsTimeLimit () | struct | Get the current and next time limit for laps mode. The struct returned contains two fields CurrentValue and NextValue. |
| SetNbLaps (int) | boolean | Set a new number of laps for laps mode. Only available to Admin. Requires a map restart to be taken into account. |
| GetNbLaps () | struct | Get the current and next number of laps for laps mode. The struct returned contains two fields CurrentValue and NextValue. |
| SetRoundForcedLaps (int) | boolean | 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. |
| GetRoundForcedLaps () | struct | Get the current and next number of laps for rounds mode. The struct returned contains two fields CurrentValue and NextValue. |
| SetRoundPointsLimit (int) | boolean | 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. |
| GetRoundPointsLimit () | struct | Get the current and next points limit for rounds mode (values returned depend on UseNewRulesRound). The struct returned contains two fields CurrentValue and NextValue. |
| SetRoundCustomPoints (array,boolean) | 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. |
| GetRoundCustomPoints () | array | Gets the points used for the scores in rounds mode. |
| SetUseNewRulesRound (boolean) | boolean | Set if new rules are used for rounds mode. Only available to Admin. Requires a map restart to be taken into account. |
| GetUseNewRulesRound () | struct | Get if the new rules are used for rounds mode (Current and next values). The struct returned contains two fields CurrentValue and NextValue. |
| SetTeamPointsLimit (int) | boolean | 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. |
| GetTeamPointsLimit () | struct | Get the current and next points limit for team mode (values returned depend on UseNewRulesTeam). The struct returned contains two fields CurrentValue and NextValue. |
| SetMaxPointsTeam (int) | boolean | 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. |
| GetMaxPointsTeam () | struct | Get the current and next number of maximum points per round for team mode. The struct returned contains two fields CurrentValue and NextValue. |
| SetUseNewRulesTeam (boolean) | boolean | Set if new rules are used for team mode. Only available to Admin. Requires a map restart to be taken into account. |
| GetUseNewRulesTeam () | struct | Get if the new rules are used for team mode (Current and next values). The struct returned contains two fields CurrentValue and NextValue. |
| SetCupPointsLimit (int) | boolean | Set the points needed for victory in Cup mode. Only available to Admin. Requires a map restart to be taken into account. |
| GetCupPointsLimit () | struct | Get the points needed for victory in Cup mode. The struct returned contains two fields CurrentValue and NextValue. |
| SetCupRoundsPerMap (int) | boolean | 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. |
| GetCupRoundsPerMap () | struct | Get the number of rounds before going to next map in Cup mode. The struct returned contains two fields CurrentValue and NextValue. |
| SetCupWarmUpDuration (int) | boolean | 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. |
| GetCupWarmUpDuration () | struct | Get whether the automatic warm-up phase is enabled in Cup mode. The struct returned contains two fields CurrentValue and NextValue. |
| SetCupNbWinners (int) | boolean | 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. |
| GetCupNbWinners () | struct | Get the number of winners to determine before the match is considered over. The struct returned contains two fields CurrentValue and NextValue. |
| GetCurrentMapIndex () | int | Returns the current map index in the selection, or -1 if the map is no longer in the selection. |
| GetNextMapIndex () | int | Returns the map index in the selection that will be played next (unless the current one is restarted...) |
| SetNextMapIndex (int) | boolean | Sets the map index in the selection that will be played next (unless the current one is restarted...) |
| SetNextMapIdent (string) | boolean | Sets the map in the selection that will be played next (unless the current one is restarted...) |
| JumpToMapIndex (int) | boolean | Immediately jumps to the map designated by the index in the selection. |
| JumpToMapIdent (string) | boolean | Immediately jumps to the map designated by its identifier (it must be in the selection). |
| GetCurrentMapInfo () | struct | Returns a struct containing the infos for the current map. The struct contains the following fields : Name, UId, FileName, Author, Environnement, Mood, BronzeTime, SilverTime, GoldTime, AuthorTime, CopperPrice, LapRace, NbLaps, NbCheckpoints, MapType, MapStyle. |
| GetNextMapInfo () | struct | Returns a struct containing the infos for the next map. The struct contains the following fields : Name, UId, FileName, Author, Environnement, Mood, BronzeTime, SilverTime, GoldTime, AuthorTime, CopperPrice, LapRace, MapType, MapStyle. (NbLaps and NbCheckpoints are also present but always set to -1) |
| GetMapInfo (string) | struct | Returns a struct containing the infos for the map with the specified filename. The struct contains the following fields : Name, UId, FileName, Author, Environnement, Mood, BronzeTime, SilverTime, GoldTime, AuthorTime, CopperPrice, LapRace, MapType, MapStyle. (NbLaps and NbCheckpoints are also present but always set to -1) |
| CheckMapForCurrentServerParams (string) | boolean | Returns a boolean if the map with the specified filename matches the current server settings. |
| GetMapList (int,int) | array | 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, GoldTime, CopperPrice, MapType, MapStyle. |
| AddMap (string) | boolean | Add the map with the specified filename at the end of the current selection. Only available to Admin. |
| AddMapList (array) | int | 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. |
| RemoveMap (string) | boolean | Remove the map with the specified filename from the current selection. Only available to Admin. |
| RemoveMapList (array) | int | 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. |
| InsertMap (string) | boolean | Insert the map with the specified filename after the current map. Only available to Admin. |
| InsertMapList (array) | int | 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. |
| ChooseNextMap (string) | boolean | Set as next map the one with the specified filename, if it is present in the selection. Only available to Admin. |
| ChooseNextMapList (array) | int | 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. |
| LoadMatchSettings (string) | int | 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. |
| AppendPlaylistFromMatchSettings (string) | int | Add a list of maps defined in the playlist with the specified filename at the end of the current selection. Only available to Admin. |
| SaveMatchSettings (string) | int | Save the current selection of map in the playlist with the specified filename, as well as the current gameinfos. Only available to Admin. |
| InsertPlaylistFromMatchSettings (string) | int | Insert a list of maps defined in the playlist with the specified filename after the current map. Only available to Admin. |
| GetPlayerList (int,int,int) | array | 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) + IsReferee * 10 + IsPodiumReady * 100 + StereoDisplayMode * 1000 + IsManagedByAnOtherServer * 10000 + IsServer * 100000 + HasPlayerSlot * 1000000 + IsBroadcasting * 10000000 + HasJoinedGame * 100000000 SpectatorStatus = Spectator + TemporarySpectator * 10 + PureSpectator * 100 + AutoTarget * 1000 + CurrentTargetId * 10000 |
| GetPlayerInfo (string,int) | struct | 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) + IsReferee * 10 + IsPodiumReady * 100 + StereoDisplayMode * 1000 + IsManagedByAnOtherServer * 10000 + IsServer * 100000 + HasPlayerSlot * 1000000 + IsBroadcasting * 10000000 + HasJoinedGame * 100000000 SpectatorStatus = Spectator + TemporarySpectator * 10 + PureSpectator * 100 + AutoTarget * 1000 + CurrentTargetId * 10000 |
| GetDetailedPlayerInfo (string) | struct | 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. |
| GetMainServerPlayerInfo (int) | struct | 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) + IsReferee * 10 + IsPodiumReady * 100 + StereoDisplayMode * 1000 + IsManagedByAnOtherServer * 10000 + IsServer * 100000 + HasPlayerSlot * 1000000 + IsBroadcasting * 10000000 + HasJoinedGame * 100000000 SpectatorStatus = Spectator + TemporarySpectator * 10 + PureSpectator * 100 + AutoTarget * 1000 + CurrentTargetId * 10000 |
| GetCurrentRanking (int,int) | array | 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. |
| GetCurrentRankingForLogin (string) | array | 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. |
| GetCurrentWinnerTeam () | int | Returns the current winning team for the race in progress. (-1: if not in team mode, or draw match) |
| ForceScores (array,boolean) | 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. |
| ForcePlayerTeam (string,int) | boolean | 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. |
| ForcePlayerTeamId (int,int) | boolean | 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. |
| ForceSpectator (string,int) | boolean | 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. |
| ForceSpectatorId (int,int) | boolean | 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. |
| ForceSpectatorTarget (string,string,int) | boolean | 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. |
| ForceSpectatorTargetId (int,int,int) | boolean | 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. |
| SpectatorReleasePlayerSlot (string) | boolean | 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. |
| SpectatorReleasePlayerSlotId (int) | boolean | 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. |
| ManualFlowControlEnable (boolean) | boolean | Enable control of the game flow: the game will wait for the caller to validate state transitions. Only available to Admin. |
| ManualFlowControlProceed () | boolean | Allows the game to proceed. Only available to Admin. |
| ManualFlowControlIsEnabled () | int | 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. |
| ManualFlowControlGetCurTransition () | string | Returns the transition that is currently blocked, or '' if none. (That's exactly the value last received by the callback.) Only available to Admin. |
| CheckEndMatchCondition () | string | Returns the current match ending condition. Return values are: 'Playing', 'ChangeMap' or 'Finished'. |
| GetNetworkStats () | struct | 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. |
| StartServerLan () | boolean | Start a server on lan, using the current configuration. Only available to SuperAdmin. |
| StartServerInternet () | boolean | Start a server on internet, using the current configuration. Only available to SuperAdmin. |