Constants

MAIN_MLID

MAIN_MLID

ACTION_CLOSEWIDGET

ACTION_CLOSEWIDGET

CB_MAIN_WINDOW_CLOSED

CB_MAIN_WINDOW_CLOSED

CB_MAIN_WINDOW_OPENED

CB_MAIN_WINDOW_OPENED

Properties

$pageAnswerListeners

$pageAnswerListeners : 

Type

$pageAnswerRegexListener

$pageAnswerRegexListener : 

Type

Methods

getUsageInformation()

getUsageInformation() 

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

__construct()

__construct(\ManiaControl\ManiaControl  $maniaControl) 

Construct a new manialink manager instance

Parameters

\ManiaControl\ManiaControl $maniaControl

registerManialinkPageAnswerListener()

registerManialinkPageAnswerListener(string  $actionId, \ManiaControl\Manialinks\ManialinkPageAnswerListener  $listener, string  $method) : boolean

Register a new manialink page answer listener

Parameters

string $actionId
\ManiaControl\Manialinks\ManialinkPageAnswerListener $listener
string $method

Returns

boolean

registerManialinkPageAnswerRegexListener()

registerManialinkPageAnswerRegexListener(string  $actionIdRegex, \ManiaControl\Manialinks\ManialinkPageAnswerListener  $listener, string  $method) : boolean

Register a new manialink page answer reg ex listener

Parameters

string $actionIdRegex
\ManiaControl\Manialinks\ManialinkPageAnswerListener $listener
string $method

Returns

boolean

unregisterManialinkPageAnswerListener()

unregisterManialinkPageAnswerListener(\ManiaControl\Manialinks\ManialinkPageAnswerListener  $listener) : boolean

Remove a Manialink Page Answer Listener

Parameters

\ManiaControl\Manialinks\ManialinkPageAnswerListener $listener

Returns

boolean

handleManialinkPageAnswer()

handleManialinkPageAnswer(array  $callback) 

Handle ManialinkPageAnswer callback

Parameters

array $callback

displayWidget()

displayWidget(mixed  $maniaLink, mixed  $player, string  $widgetName = null) 

Displays a ManiaLink Widget to a certain Player (Should only be used on Main Widgets)

Parameters

mixed $maniaLink
mixed $player
string $widgetName

sendManialink()

sendManialink(string  $manialinkText, mixed  $logins = null, integer  $timeout, boolean  $hideOnClick = false) : boolean

Send the given manialink to players

Parameters

string $manialinkText
mixed $logins
integer $timeout
boolean $hideOnClick

Returns

boolean

disableAltMenu()

disableAltMenu(mixed  $player) : boolean

Disable the alt menu for the player

Parameters

mixed $player

Returns

boolean

closeWidgetCallback()

closeWidgetCallback(array  $callback, \ManiaControl\Players\Player  $player) 

Closes a widget via the callback

Parameters

array $callback
\ManiaControl\Players\Player $player

closeWidget()

closeWidget(mixed  $player, boolean  $widgetId = false) 

Closes a Manialink Widget

Parameters

mixed $player
boolean $widgetId

hideManialink()

hideManialink(mixed  $manialinkId, mixed  $logins = null) 

Hide the Manialink with the given Id

Parameters

mixed $manialinkId
mixed $logins

enableAltMenu()

enableAltMenu(mixed  $player) : boolean

Enable the alt menu for the player

Parameters

mixed $player

Returns

boolean

labelLine()

labelLine(\FML\Controls\Frame  $frame, array  $labelStrings, array  $properties = array()) : array<mixed,\FML\Controls\Labels\Label_Text>

Adds a line of labels LabelLine should be an array with the following structure: array(array(positions), array(texts)) or array($text1 => $pos1, $text2 => $pos2 .

..)

Parameters

\FML\Controls\Frame $frame
array $labelStrings
array $properties

Returns

array<mixed,\FML\Controls\Labels\Label_Text>