Constants

PLUGIN_ID

PLUGIN_ID

PLUGIN_VERSION

PLUGIN_VERSION

PLUGIN_NAME

PLUGIN_NAME

PLUGIN_AUTHOR

PLUGIN_AUTHOR

MLID_MAP_WIDGET

MLID_MAP_WIDGET

SETTING_MAP_WIDGET_ACTIVATED

SETTING_MAP_WIDGET_ACTIVATED

SETTING_MAP_WIDGET_POSX

SETTING_MAP_WIDGET_POSX

SETTING_MAP_WIDGET_POSY

SETTING_MAP_WIDGET_POSY

SETTING_MAP_WIDGET_WIDTH

SETTING_MAP_WIDGET_WIDTH

SETTING_MAP_WIDGET_HEIGHT

SETTING_MAP_WIDGET_HEIGHT

MLID_CLOCK_WIDGET

MLID_CLOCK_WIDGET

SETTING_CLOCK_WIDGET_ACTIVATED

SETTING_CLOCK_WIDGET_ACTIVATED

SETTING_CLOCK_WIDGET_POSX

SETTING_CLOCK_WIDGET_POSX

SETTING_CLOCK_WIDGET_POSY

SETTING_CLOCK_WIDGET_POSY

SETTING_CLOCK_WIDGET_WIDTH

SETTING_CLOCK_WIDGET_WIDTH

SETTING_CLOCK_WIDGET_HEIGHT

SETTING_CLOCK_WIDGET_HEIGHT

MLID_NEXTMAP_WIDGET

MLID_NEXTMAP_WIDGET

SETTING_NEXTMAP_WIDGET_ACTIVATED

SETTING_NEXTMAP_WIDGET_ACTIVATED

SETTING_NEXTMAP_WIDGET_POSX

SETTING_NEXTMAP_WIDGET_POSX

SETTING_NEXTMAP_WIDGET_POSY

SETTING_NEXTMAP_WIDGET_POSY

SETTING_NEXTMAP_WIDGET_WIDTH

SETTING_NEXTMAP_WIDGET_WIDTH

SETTING_NEXTMAP_WIDGET_HEIGHT

SETTING_NEXTMAP_WIDGET_HEIGHT

MLID_SERVERINFO_WIDGET

MLID_SERVERINFO_WIDGET

SETTING_SERVERINFO_WIDGET_ACTIVATED

SETTING_SERVERINFO_WIDGET_ACTIVATED

SETTING_SERVERINFO_WIDGET_POSX

SETTING_SERVERINFO_WIDGET_POSX

SETTING_SERVERINFO_WIDGET_POSY

SETTING_SERVERINFO_WIDGET_POSY

SETTING_SERVERINFO_WIDGET_WIDTH

SETTING_SERVERINFO_WIDGET_WIDTH

SETTING_SERVERINFO_WIDGET_HEIGHT

SETTING_SERVERINFO_WIDGET_HEIGHT

Properties

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

displayMapWidget()

displayMapWidget(string  $login = null) 

Display the Map Widget

Parameters

string $login

displayClockWidget()

displayClockWidget(boolean  $login = false) 

Displays the Clock Widget

Parameters

boolean $login

displayServerInfoWidget()

displayServerInfoWidget(string  $login = null) 

Display the Server Info Widget

Parameters

string $login

unload()

unload() 

Unload the plugin and its Resources

closeWidget()

closeWidget(string  $widgetId) 

Close a Widget

Parameters

string $widgetId

handleOnBeginMap()

handleOnBeginMap() 

Handle Begin Map Callback

handleOnEndMap()

handleOnEndMap() 

Handle End Map Callback

displayNextMapWidget()

displayNextMapWidget(string  $login = null) 

Display the Next Map (Only at the end of the Map)

Parameters

string $login

handlePlayerConnect()

handlePlayerConnect(\ManiaControl\Players\Player  $player) 

Handle PlayerConnect callback

Parameters

\ManiaControl\Players\Player $player

updateSettings()

updateSettings(\ManiaControl\Settings\Setting  $setting) 

Update Widgets on Setting Changes

Parameters

\ManiaControl\Settings\Setting $setting

updateWidgets()

updateWidgets() 

Update Widget on certain callbacks

displayWidgets()

displayWidgets() 

Display the Widgets