Constants

API_VERSION

API_VERSION

Properties

Methods

getUsageInformation()

getUsageInformation() 

Gets Information about the Class, and a List of the Public Method

__construct()

__construct(\ManiaControl\ManiaControl  $maniaControl) 

Construct a new ranking manager instance

Parameters

\ManiaControl\ManiaControl $maniaControl

enableCallbacks()

enableCallbacks() 

Enables XmlRpc Callbacks

disableCallbacks()

disableCallbacks() 

Disables XmlRpc Callbacks

getCallbacksList()

getCallbacksList() : \ManiaControl\Script\InvokeScriptCallback

Request a list of all available callbacks. This method will trigger the "XmlRpc.CallbacksList" callback.

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

blockCallbacks()

blockCallbacks(array  $callbackNames) 

Provide a Array of Callbacks you want to Block

Parameters

array $callbackNames

blockCallback()

blockCallback(  $callbackName) 

Block a Single Callback

Parameters

$callbackName

unBlockCallbacks()

unBlockCallbacks(array  $callbackNames) 

Provide a Array of Callbacks you want to Block

Parameters

array $callbackNames

unBlockCallback()

unBlockCallback(  $callbackName) 

Block a Single Callback

Parameters

$callbackName

getListOfEnabledCallbacks()

getListOfEnabledCallbacks() : \ManiaControl\Script\InvokeScriptCallback

Request a list of all enabled callbacks. This method will trigger the "XmlRpc.CallbacksList_Enabled" callback.

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

getListOfDisabledCallbacks()

getListOfDisabledCallbacks() : \ManiaControl\Script\InvokeScriptCallback

Request a list of all disabled callbacks. This method will trigger the "XmlRpc.CallbacksList_Enabled" callback.

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

getCallbackHelp()

getCallbackHelp(  $callbackName) : \ManiaControl\Script\InvokeScriptCallback

Description: Request help about a callback. This method will trigger the "XmlRpc.CallbackHelp" callback.

Parameters

$callbackName

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

getMethodsList()

getMethodsList() : \ManiaControl\Script\InvokeScriptCallback

Request a list of all available methods. This method will trigger the "XmlRpc.MethodsList" callback.s

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

setApiVersion()

setApiVersion(string  $version = self::API_VERSION) 

Sets the Api Version

Parameters

string $version

getApiVersion()

getApiVersion() : \ManiaControl\Script\InvokeScriptCallback

Gets the Api Version

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

getMethodHelp()

getMethodHelp(  $methodName) : \ManiaControl\Script\InvokeScriptCallback

Request help about a method. This method will trigger the "XmlRpc.MethodHelp" callback.

Parameters

$methodName

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

getDocumentation()

getDocumentation() : \ManiaControl\Script\InvokeScriptCallback

Request the current game mode xmlrpc callbacks and methods documentation. This method will trigger the "XmlRpc.Documentation" callback.

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

getAllApiVersions()

getAllApiVersions() : \ManiaControl\Script\InvokeScriptCallback

Gets a List of All Api Version

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

extendManiaPlanetWarmup()

extendManiaPlanetWarmup(  $seconds) 

Extend the duration of any ongoing warmup.

Parameters

$seconds

< the duration of the extension in seconds.

stopManiaPlanetWarmup()

stopManiaPlanetWarmup() 

Stop any ongoing warmup.

blockEndWarmUp()

blockEndWarmUp(integer  $time = -1) 

Blocks the End of the Warmup,

Parameters

integer $time

Timer before the end of the warmup when all players are ready. Use a negative value to prevent the warmup from ending even if all players are ready.

unBlockEndWarmUp()

unBlockEndWarmUp(integer  $time = -1) 

Blocks the End of the Warmup,

Parameters

integer $time

Timer before the end of the warmup when all players are ready. Use a negative value to prevent the warmup from ending even if all players are ready.

getWarmupStatus()

getWarmupStatus() : \ManiaControl\Script\InvokeScriptCallback

Get the status of the warmup.

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

getPauseStatus()

getPauseStatus() : \ManiaControl\Script\InvokeScriptCallback

Get the status of the pause.

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

startPause()

startPause() : \ManiaControl\Script\InvokeScriptCallback

Start a Pause and triggers a Callback for the Pause Status

Returns

\ManiaControl\Script\InvokeScriptCallback

To get The Pause Status You can directly set a callable on it via setCallable()

endPause()

endPause() : \ManiaControl\Script\InvokeScriptCallback

End a Pause and triggers a Callback for the Pause Status

Returns

\ManiaControl\Script\InvokeScriptCallback

To get The Pause Status You can directly set a callable on it via setCallable()

isTeamMode()

isTeamMode() : \ManiaControl\Script\InvokeScriptCallback

Returns if the GameMode is a TeamMode or not

Returns

\ManiaControl\Script\InvokeScriptCallback

To get The TeamMode Status You can directly set a callable on it via setCallable()

comboSetTimerPosition()

comboSetTimerPosition(  $x,   $y,   $z) 

Move the spectators' timers UI.

Parameters

$x
$y
$z

suegeSetProgressionUIPosition()

suegeSetProgressionUIPosition(  $x,   $y,   $z) 

Move the progression UI.

Parameters

$x
$y
$z

getShootmaniaScores()

getShootmaniaScores() : \ManiaControl\Script\InvokeScriptCallback

Request the current scores. This method will trigger the "Shootmania.Scores" callback.

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

getShootmaniaUIProperties()

getShootmaniaUIProperties() : \ManiaControl\Script\InvokeScriptCallback

Request the current ui properties. This method will trigger the "Shootmania.UIProperties" callback.

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

setShootmaniaUIProperties()

setShootmaniaUIProperties(  $properties) 

Update the ui properties.

Parameters

$properties

getTrackmaniaScores()

getTrackmaniaScores() : \ManiaControl\Script\InvokeScriptCallback

Request the current scores. This method will trigger the "Trackmania.Scores" callback.

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

getTrackmaniaPointsRepartition()

getTrackmaniaPointsRepartition() : \ManiaControl\Script\InvokeScriptCallback

Request the current points repartition. This method will trigger the "Trackmania.PointsRepartition" callback.

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

setTrackmaniaPointsRepartition()

setTrackmaniaPointsRepartition(  $pointArray) 

Update the points repartition.

Parameters

$pointArray

getTrackmaniaUIProperties()

getTrackmaniaUIProperties() : \ManiaControl\Script\InvokeScriptCallback

Request the current ui properties. This method will trigger the "Shootmania.UIProperties" callback.

Returns

\ManiaControl\Script\InvokeScriptCallback

You can directly set a callable on it via setCallable()

setTrackmaniaUIProperties()

setTrackmaniaUIProperties(  $properties) 

Update the ui properties.

Parameters

$properties

stopTrackmaniaWarmup()

stopTrackmaniaWarmup() 

Stop the whole warm up sequence.

stopTrackmaniaRound()

stopTrackmaniaRound() 

Stop the current warm up round.

forceTrackmaniaRoundEnd()

forceTrackmaniaRoundEnd() 

Stop the current round. Only available in Cup, Rounds and Team modes.

generateResponseId()

generateResponseId() : string

Generates the needed Unique ResponseId

Returns

string