\FML\ScriptScriptLabel

Class representing a part of the ManiaLink Script

Summary

Methods
Properties
Constants
__construct()
getName()
setName()
getText()
setText()
getIsolated()
setIsolated()
__toString()
getEventLabels()
isEventLabel()
No public properties found
ONINIT
LOOP
TICK
ENTRYSUBMIT
KEYPRESS
MOUSECLICK
MOUSEOUT
MOUSEOVER
No protected methods found
$name
$text
$isolated
N/A
No private methods found
No private properties found
N/A

Constants

ONINIT

ONINIT

LOOP

LOOP

TICK

TICK

ENTRYSUBMIT

ENTRYSUBMIT

KEYPRESS

KEYPRESS

MOUSECLICK

MOUSECLICK

MOUSEOUT

MOUSEOUT

MOUSEOVER

MOUSEOVER

Properties

$name

$name : string

Type

string — Label name

$text

$text : string

Type

string — Script text

$isolated

$isolated : boolean

Type

boolean — Isolate the script

Methods

__construct()

__construct(string  $name = self::LOOP, string  $text = null, boolean  $isolated = null) 

Construct a new ScriptLabel

Parameters

string $name

(optional) Label name

string $text

(optional) Script text

boolean $isolated

(optional) Isolate the script

getName()

getName() : string

Get the name

Returns

string

setName()

setName(string  $name) : static

Set the name

Parameters

string $name

Label name

Returns

static

getText()

getText() : string

Get the text

Returns

string

setText()

setText(string  $text) : static

Set the text

Parameters

string $text

Script text

Returns

static

getIsolated()

getIsolated() : boolean

Get isolation

Returns

boolean

setIsolated()

setIsolated(boolean  $isolated) : static

Set isolation

Parameters

boolean $isolated

If the code should be isolated in an own block

Returns

static

__toString()

__toString() : string

Build the full Script Label text

Returns

string

getEventLabels()

getEventLabels() : array<mixed,string>

Get the possible event label names

Returns

array<mixed,string>

isEventLabel()

isEventLabel(string  $label) : boolean

Check if the given label name describes an event label

Parameters

string $label

Label name

Returns

boolean