\FML\Script\FeaturesActionTrigger

Script Feature for triggering a ManiaLink page action

Summary

Methods
Properties
Constants
collect()
prepare()
__construct()
getActionName()
setActionName()
getControl()
setControl()
getLabelName()
setLabelName()
No public properties found
No constants found
getScriptText()
$actionName
$control
$labelName
N/A
No private methods found
No private properties found
N/A

Properties

$actionName

$actionName : string

Type

string — Triggered action

$labelName

$labelName : string

Type

string — Script label name

Methods

collect()

collect() : array<mixed,\FML\Script\Features\ScriptFeature>

Collect the Script Features of the given objects

Returns

array<mixed,\FML\Script\Features\ScriptFeature>

prepare()

prepare(\FML\Script\Script  $script) : static

Prepare the given Script for rendering by adding the needed Labels, etc.

Parameters

\FML\Script\Script $script

Script to prepare

Returns

static

__construct()

__construct(string  $actionName = null, \FML\Controls\Control  $control = null, string  $labelName = \FML\Script\ScriptLabel::MOUSECLICK) 

Construct a new Action Trigger

Parameters

string $actionName

(optional) Triggered action

\FML\Controls\Control $control

(optional) Action Control

string $labelName

(optional) Script label name

getActionName()

getActionName() : string

Get the action to trigger

Returns

string

setActionName()

setActionName(string  $actionName) : static

Set the action to trigger

Parameters

string $actionName

Action name

Returns

static

getControl()

getControl() : \FML\Controls\Control

Get the Control that should trigger the action

Returns

\FML\Controls\Control

setControl()

setControl(\FML\Controls\Control  $control = null) : static

Set the Control that should trigger the action

Parameters

\FML\Controls\Control $control

Action Control

Returns

static

getLabelName()

getLabelName() : string

Get the script label name

Returns

string

setLabelName()

setLabelName(string  $labelName) : static

Set the script label name

Parameters

string $labelName

Script Label name

Returns

static

getScriptText()

getScriptText() : string

Get the script text

Returns

string