Compare TMF<>TMN

Methods (TMF<>TMN)

created by www.SpeeedAddicts.com
updated by Xymph
Latest Server:Changed/New Since:
Game: TmForeverTmNationsESWC
Version: 2.11.260.1.7.4
Build: 2011-02-212006-05-30
Methods: 232140
 Method:Arguments:Return:Description:
1 system.listMethods() array Return an array of all available XML-RPC methods on this server.
2 system.methodSignature(string) 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.
3 system.methodHelp(string) string string Given the name of a method, return a help string.
4 system.multicall(array) 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.
5 Authenticate(string, string) 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.
6 ChangeAuthPassword(string, string) string, string boolean Change the password for the specified login/user. Only available to SuperAdmin.
7 EnableCallbacks(boolean) boolean boolean Allow the GameServer to call you back.
8 GetVersion() array Returns a struct with the Name, Version and Build of the application remotely controled.
9 CallVote(string) string boolean Call a vote for a cmd. The command is a XML string corresponding to an XmlRpc request. Only available to Admin.
10 CallVoteEx(string, double, int, int) 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 timeout of '0' means default, '1' means indefinite; a ratio of '-1' means default; Voters values: '0' means only active players, '1' means any player, '2' is for everybody, pure spectators included. Only available to Admin.
11 InternalCallVote() boolean Used internally by game.
12 CancelVote() boolean Cancel the current vote. Only available to Admin.
13 GetCurrentCallVote() array Returns the vote currently in progress. The returned structure is { CallerLogin, CmdName, CmdParam }.
14 SetCallVoteTimeOut(int) int boolean Set a new timeout for waiting for votes. A zero value disables callvote. Only available to Admin. Requires a challenge restart to be taken into account.
15 GetCallVoteTimeOut() array Get the current and next timeout for waiting for votes. The struct returned contains two fields 'CurrentValue' and 'NextValue'.
16 SetCallVoteRatio(double) double boolean Set a new default ratio for passing a vote. Must lie between 0 and 1. Only available to Admin.
17 GetCallVoteRatio() double Get the current default ratio for passing a vote. This value lies between 0 and 1.
18 SetCallVoteRatios(array) array boolean Set new ratios 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.
19 GetCallVoteRatios() array Get the current ratios for passing votes.
20 ChatSendServerMessage(string) string boolean Send a text message to all clients without the server login. Only available to Admin.
21 ChatSendServerMessageToLanguage(array, string) 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='??', Text='...'}. If no matching language is found, the last text in the array is used. Only available to Admin.
22 ChatSendServerMessageToId(string, int) string, int boolean Send a text message without the server login to the client with the specified PlayerId. Only available to Admin.
23 ChatSendServerMessageToLogin(string, string) 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.
24 ChatSend(string) string boolean Send a text message to all clients. Only available to Admin.
25 ChatSendToLanguage(array, string) 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='??', Text='...'}. If no matching language is found, the last text in the array is used. Only available to Admin.
26 ChatSendToLogin(string, string) 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.
27 ChatSendToId(string, int) string, int boolean Send a text message to the client with the specified PlayerId. Only available to Admin.
28 GetChatLines() array Returns the last chat lines. Maximum of 40 lines. Only available to Admin.
29 ChatEnableManualRouting(boolean, boolean) 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.
30 ChatForwardToLogin(string, string, string) 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.
31 SendNotice(string, string, int) 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 'max duration' in seconds (default: 3). Only available to Admin.
32 SendNoticeToId(int, string, int, int) 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 'max duration' in seconds (default: 3). Only available to Admin.
33 SendNoticeToLogin(string, string, string, int) 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 'max duration' in seconds (default: 3). Login can be a single login or a list of comma-separated logins. Only available to Admin.
34 SendDisplayManialinkPage(string, int, boolean) 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.
35 SendDisplayManialinkPageToId(int, string, int, boolean) 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.
36 SendDisplayManialinkPageToLogin(string, string, int, boolean) 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.
37 SendHideManialinkPage() boolean Hide the displayed manialink page on all clients. Only available to Admin.
38 SendHideManialinkPageToId(int) int boolean Hide the displayed manialink page on the client with the specified UId. Only available to Admin.
39 SendHideManialinkPageToLogin(string) 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.
40 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.
41 Kick(string, string) string, string boolean Kick the player with the specified login, with an optional message. Only available to Admin.
42 KickId(int, string) int, string boolean Kick the player with the specified PlayerId, with an optional message. Only available to Admin.
43 Ban(string, string) string, string boolean Ban the player with the specified login, with an optional message. Only available to Admin.
44 BanAndBlackList(string, string, boolean) 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.
45 BanId(int, string) int, string boolean Ban the player with the specified PlayerId, with an optional message. Only available to Admin.
46 UnBan(string) string boolean Unban the player with the specified client name. Only available to Admin.
47 CleanBanList() boolean Clean the ban list of the server. Only available to Admin.
48 GetBanList(int, int) 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.
49 BlackList(string) string boolean Blacklist the player with the specified login. Only available to SuperAdmin.
50 BlackListId(int) int boolean Blacklist the player with the specified PlayerId. Only available to SuperAdmin.
51 UnBlackList(string) string boolean UnBlackList the player with the specified login. Only available to SuperAdmin.
52 CleanBlackList() boolean Clean the blacklist of the server. Only available to SuperAdmin.
53 GetBlackList(int, int) 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.
54 LoadBlackList(string) string boolean Load the black list file with the specified file name. Only available to Admin.
55 SaveBlackList(string) string boolean Save the black list in the file with specified file name. Only available to Admin.
56 AddGuest(string) string boolean Add the player with the specified login on the guest list. Only available to Admin.
57 AddGuestId(int) int boolean Add the player with the specified PlayerId on the guest list. Only available to Admin.
58 RemoveGuest(string) string boolean Remove the player with the specified login from the guest list. Only available to Admin.
59 RemoveGuestId(int) int boolean Remove the player with the specified PlayerId from the guest list. Only available to Admin.
60 CleanGuestList() boolean Clean the guest list of the server. Only available to Admin.
61 GetGuestList(int, int) 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.
62 LoadGuestList(string) string boolean Load the guest list file with the specified file name. Only available to Admin.
63 SaveGuestList(string) string boolean Save the guest list in the file with specified file name. Only available to Admin.
64 SetBuddyNotification(string, boolean) 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.
65 GetBuddyNotification(string) string boolean Gets whether buddy notifications are enabled for login, or '' to get the global setting.
66 WriteFile(string, base64) string, base64 boolean Write the data to the specified file. The filename is relative to the Tracks path. Only available to Admin.
67 TunnelSendDataToId(int, base64) int, base64 boolean Send the data to the specified player. Only available to Admin.
68 TunnelSendDataToLogin(string, base64) 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.
69 Echo(string, string) 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.
70 Ignore(string) string boolean Ignore the player with the specified login. Only available to Admin.
71 IgnoreId(int) int boolean Ignore the player with the specified PlayerId. Only available to Admin.
72 UnIgnore(string) string boolean Unignore the player with the specified login. Only available to Admin.
73 UnIgnoreId(int) int boolean Unignore the player with the specified PlayerId. Only available to Admin.
74 CleanIgnoreList() boolean Clean the ignore list of the server. Only available to Admin.
75 GetIgnoreList(int, int) 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.
76 Pay(string, int, string) string, int, string int Pay coppers from the server account to a player, returns the BillId. This method takes three parameters: Login of the payee, Coppers to pay and a Label to send with the payment. The creation of the transaction itself may cost coppers, so you need to have coppers on the server account. Only available to Admin.
77 SendBill(string, int, string, string) 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, Coppers 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 coppers, so you need to have coppers on the server account. Only available to Admin.
78 GetBillState(int) int array 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.
79 GetServerCoppers() int Returns the current number of coppers on the server account.
80 GetSystemInfo() array Get some system infos, including connection rates (in kbps).
81 SetConnectionRates(int, int) int, int boolean Set the download and upload rates (in kbps).
82 SetServerName(string) string boolean Set a new server name in utf8 format. Only available to Admin.
83 GetServerName() string Get the server name in utf8 format.
84 SetServerComment(string) string boolean Set a new server comment in utf8 format. Only available to Admin.
85 GetServerComment() string Get the server comment in utf8 format.
86 SetHideServer(int) 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.
87 GetHideServer() int Get whether the server wants to be hidden from the public server list.
88 IsRelayServer() boolean Returns true if this is a relay server.
89 SetServerPassword(string) string boolean Set a new password for the server. Only available to Admin.
90 GetServerPassword() string Get the server password if called as Admin or Super Admin, else returns if a password is needed or not.
91 SetServerPasswordForSpectator(string) string boolean Set a new password for the spectator mode. Only available to Admin.
92 GetServerPasswordForSpectator() string Get the password for spectator mode if called as Admin or Super Admin, else returns if a password is needed or not.
93 SetMaxPlayers(int) int boolean Set a new maximum number of players. Only available to Admin. Requires a challenge restart to be taken into account.
94 GetMaxPlayers() array Get the current and next maximum number of players allowed on server. The struct returned contains two fields CurrentValue and NextValue.
95 SetMaxSpectators(int) int boolean Set a new maximum number of Spectators. Only available to Admin. Requires a challenge restart to be taken into account.
96 GetMaxSpectators() array Get the current and next maximum number of Spectators allowed on server. The struct returned contains two fields CurrentValue and NextValue.
97 EnableP2PUpload(boolean) boolean boolean Enable or disable peer-to-peer upload from server. Only available to Admin.
98 IsP2PUpload() boolean Returns if the peer-to-peer upload from server is enabled.
99 EnableP2PDownload(boolean) boolean boolean Enable or disable peer-to-peer download for server. Only available to Admin.
100 IsP2PDownload() boolean Returns if the peer-to-peer download for server is enabled.
101 AllowChallengeDownload(boolean) boolean boolean Allow clients to download challenges from the server. Only available to Admin.
102 IsChallengeDownloadAllowed() boolean Returns if clients can download challenges from the server.
103 AutoSaveReplays(boolean) boolean boolean Enable the autosaving of all replays (vizualisable replays with all players, but not validable) on the server. Only available to SuperAdmin.
104 AutoSaveValidationReplays(boolean) boolean boolean Enable the autosaving on the server of validation replays, every time a player makes a new time. Only available to SuperAdmin.
105 IsAutoSaveReplaysEnabled() boolean Returns if autosaving of all replays is enabled on the server.
106 IsAutoSaveValidationReplaysEnabled() boolean Returns if autosaving of validation replays is enabled on the server.
107 SaveCurrentReplay(string) 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.
108 SaveBestGhostsReplay(string, string) 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.
109 GetValidationReplay(string) 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.
110 SetLadderMode(int) int boolean Set a new ladder mode between ladder disabled (0) and forced (1). Only available to Admin. Requires a challenge restart to be taken into account.
111 GetLadderMode() array Get the current and next ladder mode on server. The struct returned contains two fields CurrentValue and NextValue.
112 GetLadderServerLimits() array Get the ladder points limit for the players allowed on this server. The struct returned contains two fields LadderServerLimitMin and LadderServerLimitMax.
113 SetVehicleNetQuality(int) int boolean Set the network vehicle quality to Fast (0) or High (1). Only available to Admin. Requires a challenge restart to be taken into account.
114 GetVehicleNetQuality() array Get the current and next network vehicle quality on server. The struct returned contains two fields CurrentValue and NextValue.
115 SetServerOptions(array) array 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, AllowChallengeDownload, AutoSaveReplays, and optionally for forever: RefereePassword, RefereeMode, AutoSaveValidationReplays, HideServer, UseChangingValidationSeed. Only available to Admin. A change of NextMaxPlayers, NextMaxSpectators, NextLadderMode, NextVehicleNetQuality, NextCallVoteTimeOut or UseChangingValidationSeed requires a challenge restart to be taken into account.
116 GetServerOptions(int) int array Optional parameter for compatibility: struct version (0 = united, 1 = forever). Returns a struct containing the server options: Name, Comment, Password, PasswordForSpectator, CurrentMaxPlayers, NextMaxPlayers, CurrentMaxSpectators, NextMaxSpectators, IsP2PUpload, IsP2PDownload, CurrentLadderMode, NextLadderMode, CurrentVehicleNetQuality, NextVehicleNetQuality, CurrentCallVoteTimeOut, NextCallVoteTimeOut, CallVoteRatio, AllowChallengeDownload and AutoSaveReplays, and additionally for forever: RefereePassword, RefereeMode, AutoSaveValidationReplays, HideServer, CurrentUseChangingValidationSeed, NextUseChangingValidationSeed.
117 SetServerPackMask(string) string boolean Defines the packmask of the server. Can be 'United', 'Nations', 'Sunrise', 'Original', or any of the environment names. (Only challenges matching the packmask will be allowed on the server, so that player connecting to it know what to expect.) Only available when the server is stopped. Only available to Admin.
118 GetServerPackMask() string Get the packmask of the server.
119 SetForcedMods(boolean, array) boolean, array boolean Set the mods to apply on the clients. Parameters: Override, if true even the challenges with a mod will be overridden by the server setting; and Mods, an array of structures [{EnvName, Url}, ...]. Requires a challenge restart to be taken into account. Only available to Admin.
120 GetForcedMods() array Get the mods settings.
121 SetForcedMusic(boolean, string) boolean, string boolean Set the music to play on the clients. Parameters: Override, if true even the challenges with a custom music will be overridden by the server setting, and a UrlOrFileName for the music. Requires a challenge restart to be taken into account. Only available to Admin.
122 GetForcedMusic() array Get the music setting.
123 SetForcedSkins(array) 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.
124 GetForcedSkins() array Get the current forced skins.
125 GetLastConnectionErrorMessage() string Returns the last error message for an internet connection. Only available to Admin.
126 SetRefereePassword(string) string boolean Set a new password for the referee mode. Only available to Admin.
127 GetRefereePassword() string Get the password for referee mode if called as Admin or Super Admin, else returns if a password is needed or not.
128 SetRefereeMode(int) int boolean Set the referee validation mode. 0 = validate the top3 players, 1 = validate all players. Only available to Admin.
129 GetRefereeMode() int Get the referee validation mode.
130 SetUseChangingValidationSeed(boolean) boolean boolean Set whether the game should use a variable validation seed or not. Only available to Admin. Requires a challenge restart to be taken into account.
131 GetUseChangingValidationSeed() array Get the current and next value of UseChangingValidationSeed. The struct returned contains two fields CurrentValue and NextValue.
132 SetWarmUp(boolean) boolean boolean Sets whether the server is in warm-up phase or not. Only available to Admin.
133 GetWarmUp() boolean Returns whether the server is in warm-up phase.
134 ChallengeRestart() boolean Restarts the challenge, with an optional boolean parameter DontClearCupScores (only available in cup mode). Only available to Admin.
135 RestartChallenge() boolean Restarts the challenge, with an optional boolean parameter DontClearCupScores (only available in cup mode). Only available to Admin.
136 NextChallenge() boolean Switch to next challenge, with an optional boolean parameter DontClearCupScores (only available in cup mode). Only available to Admin.
137 StopServer() boolean Stop the server. Only available to SuperAdmin.
138 ForceEndRound() boolean In Rounds or Laps mode, force the end of round without waiting for all players to giveup/finish. Only available to Admin.
139 SetGameInfos(array) array 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, CupRoundsPerChallenge, CupNbWinners, CupWarmUpDuration. Only available to Admin. Requires a challenge restart to be taken into account.
140 GetCurrentGameInfo(int) int array Optional parameter for compatibility: struct version (0 = united, 1 = forever). Returns a struct containing the current game settings, ie: GameMode, ChatTime, NbChallenge, RoundsPointsLimit, RoundsUseNewRules, RoundsForcedLaps, TimeAttackLimit, TimeAttackSynchStartPeriod, TeamPointsLimit, TeamMaxPoints, TeamUseNewRules, LapsNbLaps, LapsTimeLimit, FinishTimeout, and additionally for version 1: AllWarmUpDuration, DisableRespawn, ForceShowAllOpponents, RoundsPointsLimitNewRules, TeamPointsLimitNewRules, CupPointsLimit, CupRoundsPerChallenge, CupNbWinners, CupWarmUpDuration.
141 GetNextGameInfo(int) int array Optional parameter for compatibility: struct version (0 = united, 1 = forever). Returns a struct containing the game settings for the next challenge, ie: GameMode, ChatTime, NbChallenge, RoundsPointsLimit, RoundsUseNewRules, RoundsForcedLaps, TimeAttackLimit, TimeAttackSynchStartPeriod, TeamPointsLimit, TeamMaxPoints, TeamUseNewRules, LapsNbLaps, LapsTimeLimit, FinishTimeout, and additionally for version 1: AllWarmUpDuration, DisableRespawn, ForceShowAllOpponents, RoundsPointsLimitNewRules, TeamPointsLimitNewRules, CupPointsLimit, CupRoundsPerChallenge, CupNbWinners, CupWarmUpDuration.
142 GetGameInfos(int) int array Optional parameter for compatibility: struct version (0 = united, 1 = forever). Returns a struct containing two other structures, the first containing the current game settings and the second the game settings for next challenge. The first structure is named CurrentGameInfos and the second NextGameInfos.
143 SetGameMode(int) int boolean Set a new game mode between Rounds (0), TimeAttack (1), Team (2), Laps (3), Stunts (4) and Cup (5). Only available to Admin. Requires a challenge restart to be taken into account.
144 GetGameMode() int Get the current game mode.
145 SetChatTime(int) 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.
146 GetChatTime() array Get the current and next chat time. The struct returned contains two fields CurrentValue and NextValue.
147 SetFinishTimeout(int) 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 challenge. Only available to Admin. Requires a challenge restart to be taken into account.
148 GetFinishTimeout() array Get the current and next FinishTimeout. The struct returned contains two fields CurrentValue and NextValue.
149 SetAllWarmUpDuration(int) 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 challenge restart to be taken into account.
150 GetAllWarmUpDuration() array Get whether the automatic warm-up phase is enabled in all modes. The struct returned contains two fields CurrentValue and NextValue.
151 SetDisableRespawn(boolean) boolean boolean Set whether to disallow players to respawn. Only available to Admin. Requires a challenge restart to be taken into account.
152 GetDisableRespawn() array Get whether players are disallowed to respawn. The struct returned contains two fields CurrentValue and NextValue.
153 SetForceShowAllOpponents(int) 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 challenge restart to be taken into account.
154 GetForceShowAllOpponents() array Get whether players are forced to show all opponents. The struct returned contains two fields CurrentValue and NextValue.
155 SetTimeAttackLimit(int) int boolean Set a new time limit for time attack mode. Only available to Admin. Requires a challenge restart to be taken into account.
156 GetTimeAttackLimit() array Get the current and next time limit for time attack mode. The struct returned contains two fields CurrentValue and NextValue.
157 SetTimeAttackSynchStartPeriod(int) int boolean Set a new synchronized start period for time attack mode. Only available to Admin. Requires a challenge restart to be taken into account.
158 GetTimeAttackSynchStartPeriod() array Get the current and synchronized start period for time attack mode. The struct returned contains two fields CurrentValue and NextValue.
159 SetLapsTimeLimit(int) int boolean Set a new time limit for laps mode. Only available to Admin. Requires a challenge restart to be taken into account.
160 GetLapsTimeLimit() array Get the current and next time limit for laps mode. The struct returned contains two fields CurrentValue and NextValue.
161 SetNbLaps(int) int boolean Set a new number of laps for laps mode. Only available to Admin. Requires a challenge restart to be taken into account.
162 GetNbLaps() array Get the current and next number of laps for laps mode. The struct returned contains two fields CurrentValue and NextValue.
163 SetRoundForcedLaps(int) int boolean Set a new number of laps for rounds mode (0 = default, use the number of laps from the challenges, otherwise forces the number of rounds for multilaps challenges). Only available to Admin. Requires a challenge restart to be taken into account.
164 GetRoundForcedLaps() array Get the current and next number of laps for rounds mode. The struct returned contains two fields CurrentValue and NextValue.
165 SetRoundPointsLimit(int) int boolean Set a new points limit for rounds mode (value set depends on UseNewRulesRound). Only available to Admin. Requires a challenge restart to be taken into account.
166 GetRoundPointsLimit() array Get the current and next points limit for rounds mode (values returned depend on UseNewRulesRound). The struct returned contains two fields CurrentValue and NextValue.
167 SetRoundCustomPoints(array, boolean) 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.
168 GetRoundCustomPoints() array Gets the points used for the scores in rounds mode.
169 SetUseNewRulesRound(boolean) boolean boolean Set if new rules are used for rounds mode. Only available to Admin. Requires a challenge restart to be taken into account.
170 GetUseNewRulesRound() array Get if the new rules are used for rounds mode (Current and next values). The struct returned contains two fields CurrentValue and NextValue.
171 SetTeamPointsLimit(int) int boolean Set a new points limit for team mode (value set depends on UseNewRulesTeam). Only available to Admin. Requires a challenge restart to be taken into account.
172 GetTeamPointsLimit() array Get the current and next points limit for team mode (values returned depend on UseNewRulesTeam). The struct returned contains two fields CurrentValue and NextValue.
173 SetMaxPointsTeam(int) int boolean Set a new number of maximum points per round for team mode. Only available to Admin. Requires a challenge restart to be taken into account.
174 GetMaxPointsTeam() array Get the current and next number of maximum points per round for team mode. The struct returned contains two fields CurrentValue and NextValue.
175 SetUseNewRulesTeam(boolean) boolean boolean Set if new rules are used for team mode. Only available to Admin. Requires a challenge restart to be taken into account.
176 GetUseNewRulesTeam() array Get if the new rules are used for team mode (Current and next values). The struct returned contains two fields CurrentValue and NextValue.
177 SetCupPointsLimit(int) int boolean Set the points needed for victory in Cup mode. Only available to Admin. Requires a challenge restart to be taken into account.
178 GetCupPointsLimit() array Get the points needed for victory in Cup mode. The struct returned contains two fields CurrentValue and NextValue.
179 SetCupRoundsPerChallenge(int) int boolean Sets the number of rounds before going to next challenge in Cup mode. Only available to Admin. Requires a challenge restart to be taken into account.
180 GetCupRoundsPerChallenge() array Get the number of rounds before going to next challenge in Cup mode. The struct returned contains two fields CurrentValue and NextValue.
181 SetCupWarmUpDuration(int) 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 challenge restart to be taken into account.
182 GetCupWarmUpDuration() array Get whether the automatic warm-up phase is enabled in Cup mode. The struct returned contains two fields CurrentValue and NextValue.
183 SetCupNbWinners(int) int boolean Set the number of winners to determine before the match is considered over. Only available to Admin. Requires a challenge restart to be taken into account.
184 GetCupNbWinners() array Get the number of winners to determine before the match is considered over. The struct returned contains two fields CurrentValue and NextValue.
185 GetCurrentChallengeIndex() int Returns the current challenge index in the selection, or -1 if the challenge is no longer in the selection.
186 GetNextChallengeIndex() int Returns the challenge index in the selection that will be played next (unless the current one is restarted...)
187 SetNextChallengeIndex(int) int boolean Sets the challenge index in the selection that will be played next (unless the current one is restarted...)
188 GetCurrentChallengeInfo() array Returns a struct containing the infos for the current challenge. The struct contains the following fields : Name, UId, FileName, Author, Environnement, Mood, BronzeTime, SilverTime, GoldTime, AuthorTime, CopperPrice, LapRace, NbLaps and NbCheckpoints.
189 GetNextChallengeInfo() array Returns a struct containing the infos for the next challenge. The struct contains the following fields : Name, UId, FileName, Author, Environnement, Mood, BronzeTime, SilverTime, GoldTime, AuthorTime, CopperPrice and LapRace. (NbLaps and NbCheckpoints are also present but always set to -1)
190 GetChallengeInfo(string) string array Returns a struct containing the infos for the challenge with the specified filename. The struct contains the following fields : Name, UId, FileName, Author, Environnement, Mood, BronzeTime, SilverTime, GoldTime, AuthorTime, CopperPrice and LapRace. (NbLaps and NbCheckpoints are also present but always set to -1)
191 CheckChallengeForCurrentServerParams(string) string boolean Returns a boolean if the challenge with the specified filename matches the current server settings.
192 GetChallengeList(int, int) int, int array Returns a list of challenges 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 and CopperPrice.
193 AddChallenge(string) string boolean Add the challenge with the specified filename at the end of the current selection. Only available to Admin.
194 AddChallengeList(array) array int Add the list of challenges with the specified filenames at the end of the current selection. The list of challenges to add is an array of strings. Only available to Admin.
195 RemoveChallenge(string) string boolean Remove the challenge with the specified filename from the current selection. Only available to Admin.
196 RemoveChallengeList(array) array int Remove the list of challenges with the specified filenames from the current selection. The list of challenges to remove is an array of strings. Only available to Admin.
197 InsertChallenge(string) string boolean Insert the challenge with the specified filename after the current challenge. Only available to Admin.
198 InsertChallengeList(array) array int Insert the list of challenges with the specified filenames after the current challenge. The list of challenges to insert is an array of strings. Only available to Admin.
199 ChooseNextChallenge(string) string boolean Set as next challenge the one with the specified filename, if it is present in the selection. Only available to Admin.
200 ChooseNextChallengeList(array) array int Set as next challenges the list of challenges with the specified filenames, if they are present in the selection. The list of challenges to choose is an array of strings. Only available to Admin.
201 LoadMatchSettings(string) string int Set a list of challenges 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.
202 AppendPlaylistFromMatchSettings(string) string int Add a list of challenges defined in the playlist with the specified filename at the end of the current selection. Only available to Admin.
203 SaveMatchSettings(string) string int Save the current selection of challenge in the playlist with the specified filename, as well as the current gameinfos. Only available to Admin.
204 InsertPlaylistFromMatchSettings(string) string int Insert a list of challenges defined in the playlist with the specified filename after the current challenge. Only available to Admin.
205 GetPlayerList(int, int, int) 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 + IsUsingStereoscopy * 1000 + IsManagedByAnOtherServer * 10000 + IsServer * 100000 + HasPlayerSlot * 1000000
SpectatorStatus = Spectator + TemporarySpectator * 10 + PureSpectator * 100 + AutoTarget * 1000 + CurrentTargetId * 10000
206 GetPlayerInfo(string, int) string, int array 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 + IsUsingStereoscopy * 1000 + IsManagedByAnOtherServer * 10000 + IsServer * 100000 + HasPlayerSlot * 1000000
SpectatorStatus = Spectator + TemporarySpectator * 10 + PureSpectator * 100 + AutoTarget * 1000 + CurrentTargetId * 10000
207 GetDetailedPlayerInfo(string) string array 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.
208 GetMainServerPlayerInfo(int) int array 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 + IsUsingStereoscopy * 1000 + IsManagedByAnOtherServer * 10000 + IsServer * 100000 + HasPlayerSlot * 1000000
SpectatorStatus = Spectator + TemporarySpectator * 10 + PureSpectator * 100 + AutoTarget * 1000 + CurrentTargetId * 10000
209 GetCurrentRanking(int, int) int, int array Returns the current rankings for the race in progress. (in team mode, 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, Rank, BestTime, Score, NbrLapsFinished and LadderScore. It also contains an array BestCheckpoints that contains the checkpoint times for the best race.
210 GetCurrentRankingForLogin(string) 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, that contains the following fields : Login, NickName, PlayerId, Rank, BestTime, Score, NbrLapsFinished and LadderScore. It also contains an array BestCheckpoints that contains the checkpoint times for the best race.
211 ForceScores(array, boolean) 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.
212 ForcePlayerTeam(string, int) 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.
213 ForcePlayerTeamId(int, int) 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.
214 ForceSpectator(string, int) 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). Only available to Admin.
215 ForceSpectatorId(int, int) 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). Only available to Admin.
216 ForceSpectatorTarget(string, string, int) 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.
217 ForceSpectatorTargetId(int, int, int) 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.
218 SpectatorReleasePlayerSlot(string) 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.
219 SpectatorReleasePlayerSlotId(int) 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.
220 ManualFlowControlEnable(boolean) boolean boolean Enable control of the game flow: the game will wait for the caller to validate state transitions. Only available to Admin.
221 ManualFlowControlProceed() boolean Allows the game to proceed. Only available to Admin.
222 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.
223 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.
224 CheckEndMatchCondition() string Returns the current match ending condition. Return values are: 'Playing', 'ChangeMap' or 'Finished'.
225 GetNetworkStats() array 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.
226 StartServerLan() boolean Start a server on lan, using the current configuration. Only available to SuperAdmin.
227 StartServerInternet(array) array boolean Start a server on internet using the 'Login' and 'Password' specified in the struct passed as parameters. Only available to SuperAdmin.
228 GetStatus() array Returns the current status of the server.
229 QuitGame() boolean Quit the application. Only available to SuperAdmin.
230 GameDataDirectory() string Returns the path of the game datas directory. Only available to Admin.
231 GetTracksDirectory() string Returns the path of the tracks directory. Only available to Admin.
232 GetSkinsDirectory() string Returns the path of the skins directory. Only available to Admin.