\FML\Script\FeaturesKeyAction

Script Feature for triggering a manialink page action on key press

Summary

Methods
Properties
Constants
collect()
prepare()
__construct()
getActionName()
setActionName()
getKeyName()
setKeyName()
getKeyCode()
setKeyCode()
getCharPressed()
setCharPressed()
No public properties found
No constants found
getScriptText()
$actionName
$keyName
$keyCode
$charPressed
N/A
No private methods found
No private properties found
N/A

Properties

$actionName

$actionName : string

Type

string — Action name

$keyName

$keyName : string

Type

string — Key name

$keyCode

$keyCode : integer

Type

integer — Key code

$charPressed

$charPressed : string

Type

string — Pressed character

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, string  $keyName = null) 

Construct a new Key Action

Parameters

string $actionName

(optional) Triggered action

string $keyName

(optional) Key name

getActionName()

getActionName() : string

Get the action to trigger

Returns

string

setActionName()

setActionName(string  $actionName) : static

Set the action to trigger

Parameters

string $actionName

Triggered action

Returns

static

getKeyName()

getKeyName() : string

Get the key name for triggering the action

Returns

string

setKeyName()

setKeyName(string  $keyName) : static

Set the key name for triggering the action

Parameters

string $keyName

Key Name

Returns

static

getKeyCode()

getKeyCode() : integer

Get the key code for triggering the action

Returns

integer

setKeyCode()

setKeyCode(integer  $keyCode) : static

Set the key code for triggering the action

Parameters

integer $keyCode

Key Code

Returns

static

getCharPressed()

getCharPressed() : string

Get the character to press for triggering the action

Returns

string

setCharPressed()

setCharPressed(string  $charPressed) : static

Set the character to press for triggering the action

Parameters

string $charPressed

Pressed character

Returns

static

getScriptText()

getScriptText() : string

Get the script text

Returns

string