Properties

$globalVisible

$globalVisible : boolean

Type

boolean — If the UI should be shown at all

$challengeInfoVisible

$challengeInfoVisible : boolean

Type

boolean — If the challenge info should be shown

$chatVisible

$chatVisible : boolean

Type

boolean — If the chat should be shown

$checkpointListVisible

$checkpointListVisible : boolean

Type

boolean — If the checkpoint list should be shown

$netInfosVisible

$netInfosVisible : boolean

Type

boolean — If the net infos should be shown

$noticeVisible

$noticeVisible : boolean

Type

boolean — If notices should be shown

$roundScoresVisible

$roundScoresVisible : boolean

Type

boolean — If round scores should be shown

$scoretableVisible

$scoretableVisible : boolean

Type

boolean — If the score table should be shown

Methods

create()

create() : static

Create a new CustomUI

Returns

static

getGlobalVisible()

getGlobalVisible() : boolean

Get global visibility

Returns

boolean

setGlobalVisible()

setGlobalVisible(boolean  $visible) : static

Set global visibility

Parameters

boolean $visible

If the UI should be shown at all

Returns

static

getChallengeInfoVisible()

getChallengeInfoVisible() : boolean

Get showing of the challenge info

Returns

boolean

setChallengeInfoVisible()

setChallengeInfoVisible(boolean  $visible) : static

Set showing of the challenge info

Parameters

boolean $visible

If the challenge info should be shown

Returns

static

getChatVisible()

getChatVisible() : boolean

Get showing of the chat

Returns

boolean

setChatVisible()

setChatVisible(boolean  $visible) : static

Set showing of the chat

Parameters

boolean $visible

If the chat should be shown

Returns

static

getCheckpointListVisible()

getCheckpointListVisible() : boolean

Get showing of the checkpoint list

Returns

boolean

setCheckpointListVisible()

setCheckpointListVisible(boolean  $visible) : static

Set showing of the checkpoint list

Parameters

boolean $visible

If the checkpoint list should be shown

Returns

static

getNetInfosVisible()

getNetInfosVisible() : boolean

Get showing of the net infos

Returns

boolean

setNetInfosVisible()

setNetInfosVisible(boolean  $visible) : static

Set showing of the net infos

Parameters

boolean $visible

If the net infos should be shown

Returns

static

getNoticeVisible()

getNoticeVisible() : boolean

Get showing of notices

Returns

boolean

setNoticeVisible()

setNoticeVisible(boolean  $visible) : static

Set showing of notices

Parameters

boolean $visible

If notices should be shown

Returns

static

getRoundScoresVisible()

getRoundScoresVisible() : boolean

Get showing of round scores

Returns

boolean

setRoundScoresVisible()

setRoundScoresVisible(boolean  $visible) : static

Set showing of round scores

Parameters

boolean $visible

If round scores should be shown

Returns

static

getScoretableVisible()

getScoretableVisible() : boolean

Get showing of the score table

Returns

boolean

setScoretableVisible()

setScoretableVisible(boolean  $visible) : static

Set showing of the score table

Parameters

boolean $visible

If the score table should be shown

Returns

static

renderStandalone()

renderStandalone() : \DOMDocument

Render the CustomUI standalone

Returns

\DOMDocument

render()

render(\DOMDocument  $domDocument) : \DOMElement

Render the CustomUI

Parameters

\DOMDocument $domDocument

DOMDocument for which the CustomUI should be rendered

Returns

\DOMElement

__toString()

__toString() : string

Get string representation

Returns

string

getSettings()

getSettings() : array

Get associative array of all CustomUI settings

Returns

array