Constants

Bonus

Bonus

Capture

Capture

Checkpoint

Checkpoint

Combo

Combo

Custom1

Custom1

Custom2

Custom2

Custom3

Custom3

Custom4

Custom4

Default_

Default_

EndMatch

EndMatch

EndRound

EndRound

Finish

Finish

FirstHit

FirstHit

Notice

Notice

PhaseChange

PhaseChange

PlayerEliminated

PlayerEliminated

PlayerHit

PlayerHit

PlayersRemaining

PlayersRemaining

RankChange

RankChange

Record

Record

ScoreProgress

ScoreProgress

Silence

Silence

StartMatch

StartMatch

StartRound

StartRound

TieBreakPoint

TieBreakPoint

TiePoint

TiePoint

TimeOut

TimeOut

VictoryPoint

VictoryPoint

Warning

Warning

Properties

$soundName

$soundName : string

Type

string — Sound name

$variant

$variant : integer

Type

integer — Sound variant

$labelName

$labelName : string

Type

string — Script Label name

$volume

$volume : float

Type

float — Volume

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

Construct a new UISound

Parameters

string $soundName

(optional) Sound name

\FML\Controls\Control $control

(optional) Sound Control

integer $variant

(optional) Sound variant

string $labelName

(optional) Script Label name

getSoundName()

getSoundName() : string

Get the sound to play

Returns

string

setSoundName()

setSoundName(string  $soundName) : static

Set the sound to play

Parameters

string $soundName

Sound name

Returns

static

setControl()

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

Set the sound Control

Parameters

\FML\Controls\Control $control

(optional) Sound Control

Returns

static

getVariant()

getVariant() : integer

Get the sound variant

Returns

integer

setVariant()

setVariant(integer  $variant) : static

Set the sound variant

Parameters

integer $variant

Sound variant

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

getVolume()

getVolume() : float

Get the volume

Returns

float

setVolume()

setVolume(float  $volume) : static

Set the volume

Parameters

float $volume

Sound volume

Returns

static

getScriptText()

getScriptText() : string

Get the script text

Returns

string