\FML\Script\FeaturesMapInfo

Script Feature for opening the map info

Summary

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

Properties

$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(\FML\Controls\Control  $control = null, string  $labelName = \FML\Script\ScriptLabel::MOUSECLICK) 

Construct a new Map Info

Parameters

\FML\Controls\Control $control

(optional) Map Info Control

string $labelName

(optional) Script Label name

setControl()

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

Set the Control

Parameters

\FML\Controls\Control $control

Map Info 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