Skip to content

Commit c7ec88f

Browse files
committed
2017-04-05 version of the xmlrpc api.
1 parent d38b73f commit c7ec88f

File tree

1 file changed

+333
-0
lines changed

1 file changed

+333
-0
lines changed

XmlRpcListing.md

Lines changed: 333 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1215,6 +1215,196 @@ Callbacks
12151215
]
12161216
```
12171217

1218+
### Maniaplanet.WarmUp.Start
1219+
1220+
* Name: Maniaplanet.WarmUp.Start
1221+
* Type: CallbackArray
1222+
* Description: Callback sent when the warmup starts.
1223+
* Data:
1224+
- Version >=2.0.0:
1225+
```
1226+
[
1227+
"{}"
1228+
]
1229+
```
1230+
1231+
### Maniaplanet.WarmUp.End
1232+
1233+
* Name: Maniaplanet.WarmUp.End
1234+
* Type: CallbackArray
1235+
* Description: Callback sent when the warmup ends.
1236+
* Data:
1237+
- Version >=2.0.0:
1238+
```
1239+
[
1240+
"{}"
1241+
]
1242+
```
1243+
1244+
### Maniaplanet.WarmUp.Status
1245+
1246+
* Name: Maniaplanet.WarmUp.Status
1247+
* Type: CallbackArray
1248+
* Description: The status of the warmup.
1249+
* Data:
1250+
- Version >=2.0.0:
1251+
```
1252+
[
1253+
"{
1254+
"responseid": "xyz", //< Facultative id passed by a script event
1255+
"active": true //< true if a warmup is ongoing, false otherwise
1256+
}"
1257+
]
1258+
```
1259+
1260+
### Shootmania.Combo.Pause
1261+
1262+
* Name: Shootmania.Combo.Pause
1263+
* Type: CallbackArray
1264+
* Description: The status of the pause.
1265+
* Data:
1266+
- Version >=2.0.0:
1267+
```
1268+
[
1269+
"{
1270+
"responseid": "xyz", //< Facultative id passed by a script event
1271+
"active": true //< true if a pause is active, false otherwise
1272+
}"
1273+
]
1274+
```
1275+
1276+
### Shootmania.Elite.StartTurn
1277+
1278+
* Name: Shootmania.Elite.StartTurn
1279+
* Type: CallbackArray
1280+
* Description: Information about the starting turn.
1281+
* Data:
1282+
- Version >=2.0.0:
1283+
```
1284+
[
1285+
"{
1286+
"attacker": "login1", //< the login of the attacker
1287+
"defenders": ["login2", "login3", "login4"] //< the logins of the defenders
1288+
}"
1289+
]
1290+
```
1291+
1292+
### Shootmania.Elite.EndTurn
1293+
1294+
* Name: Shootmania.Elite.EndTurn
1295+
* Type: CallbackArray
1296+
* Description: Information about the ending turn.
1297+
* Data:
1298+
- Version >=2.0.0:
1299+
```
1300+
[
1301+
"{
1302+
"victorytype": 1 //< Describe how the turn was won. 1 = time limit, 2 = capture, 3 = attacker eliminated, 4 = defenders eliminated
1303+
}"
1304+
]
1305+
```
1306+
1307+
### Shootmania.Joust.OnReload
1308+
1309+
* Name: Shootmania.Joust.OnReload
1310+
* Type: CallbackArray
1311+
* Description: Callback sent when a player capture a pole to reload its weapons.
1312+
* Data:
1313+
- Version >=2.0.0:
1314+
```
1315+
[
1316+
"{
1317+
"player": "PlayerLogin1" //< Login of the player who reloaded
1318+
}"
1319+
]
1320+
```
1321+
1322+
### Shootmania.Joust.SelectedPlayers
1323+
1324+
* Name: Shootmania.Joust.SelectedPlayers
1325+
* Type: CallbackArray
1326+
* Description: Callback sent at the beginning of the round with the logins of the players selected to play the round.
1327+
* Data:
1328+
- Version >=2.0.0:
1329+
```
1330+
[
1331+
"{
1332+
"players": ["PlayerLogin1", "PlayerLogin2"] //< Logins of the two players selected for the round
1333+
}"
1334+
]
1335+
```
1336+
1337+
### Shootmania.Joust.RoundResult
1338+
1339+
* Name: Shootmania.Joust.RoundResult
1340+
* Type: CallbackArray
1341+
* Description: Callback sent at the end of the round with the scores of the two players.
1342+
* Data:
1343+
- Version >=2.0.0:
1344+
```
1345+
[
1346+
"{
1347+
"players": [
1348+
{
1349+
"login": "PlayerLogin1",
1350+
"score": 5
1351+
}, {
1352+
"login": "PlayerLogin2",
1353+
"score": 7
1354+
}
1355+
]
1356+
}"
1357+
]
1358+
```
1359+
1360+
### Shootmania.Royal.Points
1361+
1362+
* Name: Shootmania.Royal.Points
1363+
* Type: CallbackArray
1364+
* Description: Callback sent when a player scores some points.
1365+
* Data:
1366+
- Version >=2.0.0:
1367+
```
1368+
[
1369+
"{
1370+
"login": "PlayerLogin", //< Login of the player who scored the points
1371+
"type": "Pole", //< The type of points. Can be: Pole, Hit or Survival
1372+
"points": 12 //< The number of points scored
1373+
}"
1374+
]
1375+
```
1376+
1377+
### Shootmania.Royal.PlayerSpawn
1378+
1379+
* Name: Shootmania.Royal.PlayerSpawn
1380+
* Type: CallbackArray
1381+
* Description: Callback sent when a player is spawned.
1382+
* Data:
1383+
- Version >=2.0.0:
1384+
```
1385+
[
1386+
"{
1387+
"login": "PlayerLogin", //< Login of the spawned player
1388+
"respawn": true //< false if it is the initial player spawn in the round. true if it is a respawn.
1389+
}"
1390+
]
1391+
```
1392+
1393+
### Shootmania.Royal.RoundWinner
1394+
1395+
* Name: Shootmania.Royal.RoundWinner
1396+
* Type: CallbackArray
1397+
* Description: Callback sent at the end of the round with the login of the winner.
1398+
* Data:
1399+
- Version >=2.0.0:
1400+
```
1401+
[
1402+
"{
1403+
"login": "PlayerLogin" //< Login of the player who won the round
1404+
}"
1405+
]
1406+
```
1407+
12181408
### Trackmania.Event.Default
12191409

12201410
* Name: Trackmania.Event.Default
@@ -1326,6 +1516,8 @@ Callbacks
13261516
"checkpointinlap": 4, //< Number of checkpoints crossed since the beginning of the lap
13271517
"isendrace": false, //< Is it the finish line checkpoint
13281518
"isendlap": false, //< Is it the multilap checkpoint
1519+
"curracecheckpoints": [1234, 5200, 7580, 9000], //< Checkpoints times since the beginning of the race
1520+
"curlapcheckpoints": [1420], //< Checkpoints time since the beginning of the lap
13291521
"blockid": "#123", //< Id of the checkpoint block
13301522
"speed": 456.45, //< Speed of the player in km/h
13311523
"distance": 398.49 //< Distance traveled by the player since the beginning of the race
@@ -1440,7 +1632,11 @@ Callbacks
14401632
"mappoints": 345,
14411633
"matchpoints": 64,
14421634
"bestracetime": 456789, //< Best race time in milliseconds
1635+
"bestracerespawns": 2, //< Number of respawn during best race
1636+
"bestracecheckpoints": [1230, 7546, 19045, 456789], //< Checkpoints times during best race
14431637
"bestlaptime": 68942, //< Best lap time in milliseconds
1638+
"bestlaprespawns": 1, //< Number of respawn during best lap
1639+
"bestlapcheckpoints": [2458, 9874], //< Checkpoints times during best lap
14441640
"stuntsscore": 492
14451641
},
14461642
{
@@ -1451,7 +1647,11 @@ Callbacks
14511647
"mappoints": 123,
14521648
"matchpoints": 32,
14531649
"bestracetime": 49854, //< Best race time in milliseconds
1650+
"bestracerespawns": 5, //< Number of respawn during best race
1651+
"bestracecheckpoints": [3215, 94562, 26845, 49854], //< Checkpoints times during best race
14541652
"bestlaptime": 23254, //< Best lap time in milliseconds
1653+
"bestlaprespawns": 2, //< Number of respawn during best lap
1654+
"bestlapcheckpoints": [4582, 15624], //< Checkpoints times during best lap
14551655
"stuntsscore": 9874
14561656
}
14571657
]
@@ -1665,6 +1865,34 @@ Methods
16651865
]
16661866
```
16671867

1868+
### XmlRpc.BlockCallbacks
1869+
1870+
* Name: XmlRpc.BlockCallbacks
1871+
* Type: TriggerModeScriptEventArray
1872+
* Description: Block a callback and prevent it from being sent by the script.
1873+
* Data:
1874+
- Version >=2.0.0:
1875+
```
1876+
[
1877+
"CallbackName", //< The name of the callback to block
1878+
"CallbackNameN" //< You can pass as many callbacks as you want
1879+
]
1880+
```
1881+
1882+
### XmlRpc.UnblockCallbacks
1883+
1884+
* Name: XmlRpc.UnblockCallbacks
1885+
* Type: TriggerModeScriptEventArray
1886+
* Description: Unblock a blocked callback.
1887+
* Data:
1888+
- Version >=2.0.0:
1889+
```
1890+
[
1891+
"CallbackName", //< The name of the callback to unblock
1892+
"CallbackNameN" //< You can pass as many callbacks as you want
1893+
]
1894+
```
1895+
16681896
### XmlRpc.GetCallbackHelp
16691897

16701898
* Name: XmlRpc.GetCallbackHelp
@@ -1828,6 +2056,100 @@ Methods
18282056
]
18292057
```
18302058

2059+
### Maniaplanet.WarmUp.Extend
2060+
2061+
* Name: Maniaplanet.WarmUp.Extend
2062+
* Type: TriggerModeScriptEventArray
2063+
* Description: Extend the duration of any ongoing warmup.
2064+
* Data:
2065+
- Version >=2.0.0:
2066+
```
2067+
[
2068+
"60000" //< the duration of the extension in milliseconds.
2069+
]
2070+
```
2071+
2072+
### Maniaplanet.WarmUp.Stop
2073+
2074+
* Name: Maniaplanet.WarmUp.Stop
2075+
* Type: TriggerModeScriptEventArray
2076+
* Description: Stop any ongoing warmup.
2077+
* Data:
2078+
- Version >=2.0.0:
2079+
```
2080+
[]
2081+
```
2082+
2083+
### Maniaplanet.WarmUp.GetStatus
2084+
2085+
* Name: Maniaplanet.WarmUp.GetStatus
2086+
* Type: TriggerModeScriptEventArray
2087+
* Description: Get the status of the warmup.
2088+
* Data:
2089+
- Version >=2.0.0:
2090+
```
2091+
[
2092+
"responseid" //< Facultative id that will be passed to the "Maniaplanet.WarmUp.Status" callback.
2093+
]
2094+
```
2095+
2096+
### Shootmania.Combo.GetPause
2097+
2098+
* Name: Shootmania.Combo.GetPause
2099+
* Type: TriggerModeScriptEventArray
2100+
* Description: Get the status of the pause.
2101+
* Data:
2102+
- Version >=2.0.0:
2103+
```
2104+
[
2105+
"responseid" //< Facultative id that will be passed to the "Shootmania.Combo.Pause" callback.
2106+
]
2107+
```
2108+
2109+
### Shootmania.Combo.SetPause
2110+
2111+
* Name: Shootmania.Combo.SetPause
2112+
* Type: TriggerModeScriptEventArray
2113+
* Description: Set the status of the pause.
2114+
* Data:
2115+
- Version >=2.0.0:
2116+
```
2117+
[
2118+
"true", //< true to enable the pause, false to disable it
2119+
"responseid" //< Facultative id that will be passed to the "Shootmania.Combo.Pause" callback.
2120+
]
2121+
```
2122+
2123+
### Shootmania.Combo.SetTimersPosition
2124+
2125+
* Name: Shootmania.Combo.SetTimersPosition
2126+
* Type: TriggerModeScriptEventArray
2127+
* Description: Move the spectators' timers UI.
2128+
* Data:
2129+
- Version >=2.0.0:
2130+
```
2131+
[
2132+
"10.", //< X position
2133+
"50.5", //< Y position
2134+
"0." //< Z position
2135+
]
2136+
```
2137+
2138+
### Shootmania.Siege.SetProgressionUIPosition
2139+
2140+
* Name: Shootmania.Siege.SetProgressionUIPosition
2141+
* Type: TriggerModeScriptEventArray
2142+
* Description: Move the progression UI.
2143+
* Data:
2144+
- Version >=2.0.0:
2145+
```
2146+
[
2147+
"10.", //< X position
2148+
"50.5", //< Y position
2149+
"0." //< Z position
2150+
]
2151+
```
2152+
18312153
### Trackmania.GetScores
18322154

18332155
* Name: Trackmania.GetScores
@@ -1960,3 +2282,14 @@ Methods
19602282
[]
19612283
```
19622284

2285+
### Trackmania.ForceEndRound
2286+
2287+
* Name: Trackmania.ForceEndRound
2288+
* Type: TriggerModeScriptEventArray
2289+
* Description: Stop the current round. Only available in Cup, Rounds and Team modes.
2290+
* Data:
2291+
- Version >=2.0.0:
2292+
```
2293+
[]
2294+
```
2295+

0 commit comments

Comments
 (0)