\MCTeam\DedimaniaDedimaniaPlugin

ManiaControl Dedimania Plugin

Summary

Methods
Properties
Constants
prepare()
getId()
getName()
getVersion()
getAuthor()
getDescription()
load()
updateEverySecond()
handleEveryMinute()
handlePlayerConnect()
handlePlayerDisconnect()
handleBeginMap()
handleMapEnd()
updatePlayerList()
handleCheckpointCallback()
handleLapFinishCallback()
handleFinishCallback()
handleManialinkPageAnswer()
showDediRecordsList()
getDedimaniaRecords()
unload()
No public properties found
ID
VERSION
AUTHOR
NAME
MLID_DEDIMANIA
XMLRPC_MULTICALL
DEDIMANIA_URL
DEDIMANIA_OPEN_SESSION
DEDIMANIA_CHECK_SESSION
DEDIMANIA_GET_RECORDS
DEDIMANIA_PLAYERCONNECT
DEDIMANIA_PLAYERDISCONNECT
DEDIMANIA_UPDATE_SERVER_PLAYERS
DEDIMANIA_SET_CHALLENGE_TIMES
DEDIMANIA_WARNINGSANDTTR2
SETTING_WIDGET_ENABLE
SETTING_WIDGET_TITLE
SETTING_WIDGET_POSX
SETTING_WIDGET_POSY
SETTING_WIDGET_WIDTH
SETTING_WIDGET_LINE_COUNT
SETTING_WIDGET_LINE_HEIGHT
SETTING_DEDIMANIA_CODE
CB_DEDIMANIA_CHANGED
CB_DEDIMANIA_UPDATED
ACTION_SHOW_DEDIRECORDSLIST
DEDIMANIA_DEBUG
No protected methods found
No protected properties found
N/A
openDedimaniaSession()
encode_request()
decode()
handleXmlRpcFault()
fetchDedimaniaRecords()
getServerInfo()
getPlayerList()
getMapInfo()
getGameModeString()
buildManialink()
checkDedimaniaSession()
getVotesInfo()
getDedimaniaRecord()
getCheckpoints()
insertDedimaniaRecord()
updateDedimaniaRecordRanks()
setRecordReplays()
$maniaControl
$dedimaniaData
$updateManialink
$checkpoints
$init
$request
N/A

Constants

ID

ID

VERSION

VERSION

AUTHOR

AUTHOR

NAME

NAME

MLID_DEDIMANIA

MLID_DEDIMANIA

XMLRPC_MULTICALL

XMLRPC_MULTICALL

DEDIMANIA_URL

DEDIMANIA_URL

DEDIMANIA_OPEN_SESSION

DEDIMANIA_OPEN_SESSION

DEDIMANIA_CHECK_SESSION

DEDIMANIA_CHECK_SESSION

DEDIMANIA_GET_RECORDS

DEDIMANIA_GET_RECORDS

DEDIMANIA_PLAYERCONNECT

DEDIMANIA_PLAYERCONNECT

DEDIMANIA_PLAYERDISCONNECT

DEDIMANIA_PLAYERDISCONNECT

DEDIMANIA_UPDATE_SERVER_PLAYERS

DEDIMANIA_UPDATE_SERVER_PLAYERS

DEDIMANIA_SET_CHALLENGE_TIMES

DEDIMANIA_SET_CHALLENGE_TIMES

DEDIMANIA_WARNINGSANDTTR2

DEDIMANIA_WARNINGSANDTTR2

SETTING_WIDGET_ENABLE

SETTING_WIDGET_ENABLE

SETTING_WIDGET_TITLE

SETTING_WIDGET_TITLE

SETTING_WIDGET_POSX

SETTING_WIDGET_POSX

SETTING_WIDGET_POSY

SETTING_WIDGET_POSY

SETTING_WIDGET_WIDTH

SETTING_WIDGET_WIDTH

SETTING_WIDGET_LINE_COUNT

SETTING_WIDGET_LINE_COUNT

SETTING_WIDGET_LINE_HEIGHT

SETTING_WIDGET_LINE_HEIGHT

SETTING_DEDIMANIA_CODE

SETTING_DEDIMANIA_CODE

CB_DEDIMANIA_CHANGED

CB_DEDIMANIA_CHANGED

CB_DEDIMANIA_UPDATED

CB_DEDIMANIA_UPDATED

ACTION_SHOW_DEDIRECORDSLIST

ACTION_SHOW_DEDIRECORDSLIST

DEDIMANIA_DEBUG

DEDIMANIA_DEBUG

Properties

$updateManialink

$updateManialink : 

Type

$checkpoints

$checkpoints : 

Type

$init

$init : 

Type

$request

$request : 

Type

Methods

prepare()

prepare(\ManiaControl\ManiaControl  $maniaControl) 

Prepare the Plugin

Parameters

\ManiaControl\ManiaControl $maniaControl

getId()

getId() : integer

Get plugin id

Returns

integer

getName()

getName() : string

Get Plugin Name

Returns

string

getVersion()

getVersion() : string

Get Plugin Version

Returns

string

getAuthor()

getAuthor() : string

Get Plugin Author

Returns

string

getDescription()

getDescription() : string

Get Plugin Description

Returns

string

load()

load(\ManiaControl\ManiaControl  $maniaControl) : boolean

Load the plugin

Parameters

\ManiaControl\ManiaControl $maniaControl

Returns

boolean

updateEverySecond()

updateEverySecond() 

Handle 1 Second Callback

handleEveryMinute()

handleEveryMinute() 

Handle 1 Minute Callback

handlePlayerConnect()

handlePlayerConnect(\ManiaControl\Players\Player  $player) 

Handle PlayerConnect callback

Parameters

\ManiaControl\Players\Player $player

handlePlayerDisconnect()

handlePlayerDisconnect(\ManiaControl\Players\Player  $player) 

Handle Player Disconnect Callback

Parameters

\ManiaControl\Players\Player $player

handleBeginMap()

handleBeginMap() 

Handle Begin Map Callback

handleMapEnd()

handleMapEnd() 

Handle EndMap Callback

updatePlayerList()

updatePlayerList() 

Update the PlayerList every 3 Minutes

handleManialinkPageAnswer()

handleManialinkPageAnswer(array  $callback) 

Handle PlayerManialinkPageAnswer callback

Parameters

array $callback

showDediRecordsList()

showDediRecordsList(array  $chat, \ManiaControl\Players\Player  $player) 

Shows a ManiaLink list with the local records.

Parameters

array $chat
\ManiaControl\Players\Player $player

getDedimaniaRecords()

getDedimaniaRecords() : array<mixed,\MCTeam\Dedimania\RecordData>

Function to retrieve the dedimania records on the current map

Returns

array<mixed,\MCTeam\Dedimania\RecordData>

unload()

unload() 

Unload the plugin and its Resources

openDedimaniaSession()

openDedimaniaSession() 

Opens the Dedimania Session

encode_request()

encode_request(string  $method, array  $params) : string

Encode the given xml rpc method and params

Parameters

string $method
array $params

Returns

string

decode()

decode(string  $response) : mixed

Decodes xml rpc response

Parameters

string $response

Returns

mixed

handleXmlRpcFault()

handleXmlRpcFault(array  $fault, string  $method) 

Handle xml rpc fault

Parameters

array $fault
string $method

fetchDedimaniaRecords()

fetchDedimaniaRecords(boolean  $reset = true) : boolean

Fetch Dedimania Records

Parameters

boolean $reset

Returns

boolean

getServerInfo()

getServerInfo() 

Build server info Structure for callbacks

getPlayerList()

getPlayerList() 

Build simple player list for callbacks

getMapInfo()

getMapInfo() : array

Build Map Info Array for Dedimania Requests

Returns

array

getGameModeString()

getGameModeString() : String

Get Dedimania String Representation of the current Game Mode

Returns

String

buildManialink()

buildManialink() : \FML\ManiaLink

Build Manialink

Returns

\FML\ManiaLink

checkDedimaniaSession()

checkDedimaniaSession() 

Checks If a Dedimania Session exists, if not create a new oen

getVotesInfo()

getVotesInfo() 

Build Votes Info Array for Callbacks

getDedimaniaRecord()

getDedimaniaRecord(string  $login) : \MCTeam\Dedimania\RecordData

Get the dedimania record of the given login

Parameters

string $login

Returns

\MCTeam\Dedimania\RecordData

$record

getCheckpoints()

getCheckpoints(string  $login) : string

Get current checkpoint string for dedimania record

Parameters

string $login

Returns

string

insertDedimaniaRecord()

insertDedimaniaRecord(\MCTeam\Dedimania\RecordData  $newRecord, \MCTeam\Dedimania\RecordData  $oldRecord) : boolean

Inserts the given new Dedimania record at the proper position

Parameters

\MCTeam\Dedimania\RecordData $newRecord
\MCTeam\Dedimania\RecordData $oldRecord

Returns

boolean

updateDedimaniaRecordRanks()

updateDedimaniaRecordRanks() 

Update the sorting and the ranks of all dedimania records

setRecordReplays()

setRecordReplays(\MCTeam\Dedimania\RecordData  $record) 

Update the replay values for the given record

Parameters

\MCTeam\Dedimania\RecordData $record