CENTER
CENTER
Frame Control (CMlFrame)
$scriptFeatures : array<mixed,\FML\Script\Features\ScriptFeature>
$children : array<mixed,\FML\Types\Renderable>
$format : \FML\Elements\Format
getScriptFeatures() : array<mixed,\FML\Script\Features\ScriptFeature>
Get the Script Features
addScriptFeature(\FML\Script\Features\ScriptFeature $scriptFeature) : static
Add a new Script Feature
| \FML\Script\Features\ScriptFeature | $scriptFeature | Script Feature |
addScriptFeatures(array<mixed,\FML\Script\Features\ScriptFeature> $scriptFeatures) : static
Add new Script Features
| array<mixed,\FML\Script\Features\ScriptFeature> | $scriptFeatures | Script Features |
addPlayerProfileFeature(string $login, string $eventLabel = \FML\Script\ScriptLabel::MOUSECLICK) : static
Add a dynamic Feature to open a specific player profile
| string | $login | Login of the player |
| string | $eventLabel | (optional) Event on which the player profile will be opened |
addUISoundFeature(string $soundName, integer $variant, string $eventLabel = \FML\Script\ScriptLabel::MOUSECLICK) : static
Add a dynamic Feature playing a UISound
| string | $soundName | UISound name |
| integer | $variant | (optional) Sound variant |
| string | $eventLabel | (optional) Event on which the sound will be played |
addToggleFeature(\FML\Controls\Control $toggledControl, string $labelName = \FML\Script\ScriptLabel::MOUSECLICK, boolean $onlyShow = false, boolean $onlyHide = false) : static
Add a dynamic Feature toggling another Control
| \FML\Controls\Control | $toggledControl | Toggled Control |
| string | $labelName | (optional) Script label name |
| boolean | $onlyShow | (optional) If it should only show the Control but not toggle |
| boolean | $onlyHide | (optional) If it should only hide the Control but not toggle |
addTooltipFeature(\FML\Controls\Control $tooltipControl, boolean $stayOnClick = false, boolean $invert = false) : static
Add a dynamic Feature showing a Tooltip on hovering
| \FML\Controls\Control | $tooltipControl | Tooltip Control |
| boolean | $stayOnClick | (optional) Whether the Tooltip should stay on click |
| boolean | $invert | (optional) Whether the visibility toggling should be inverted |
addTooltipLabelFeature(\FML\Controls\Label $tooltipLabel, string $text, boolean $stayOnClick = false, boolean $invert = false) : static
Add a dynamic Feature showing a Tooltip on hovering
| \FML\Controls\Label | $tooltipLabel | Tooltip Label |
| string | $text | Text to display on the Tooltip Label |
| boolean | $stayOnClick | (optional) Whether the Tooltip should stay on click |
| boolean | $invert | (optional) Whether the visibility toggling should be inverted |
getChildren() : array<mixed,\FML\Types\Renderable>
Get the children
add(\FML\Types\Renderable $child) : static
Add a new child
| \FML\Types\Renderable | $child | Child Control to add |
addChild(\FML\Types\Renderable $child) : static
Add a new child
| \FML\Types\Renderable | $child | Child Control to add |
getFormat(boolean $createIfEmpty = true) : \FML\Elements\Format
Get the Format
| boolean | $createIfEmpty | If the format should be created if it doesn't exist yet |
setFormat(\FML\Elements\Format $format = null) : static
Set the Format
| \FML\Elements\Format | $format | New Format |