Global

Members

labelMultiLineAlign

The following Attributes are taken from the TextStyle class of PIXI. All can be overwritten in the overlay's JSON file.

Type Definitions

actionActiveCallback (event, switch)

switch.js:14

Callback for the switch action.

Name	Type	Description
event	object	The event object.
switch	Switch	A reference to the switch (also this refers to the switch).

actionCallback (event, button)

button.js:10

Callback for the button action.

Name	Type	Description
event	object	The event object.
button	Button	A reference to the button (also this refers to the button).

actionCallback (event, switch)

switch.js:6

Callback for the switch action.

Name	Type	Description
event	object	The event object.
switch	Switch	A reference to the switch (also this refers to the switch).

afterActionCallback (event, switch)

switch.js:30

Callback for the switch afterAction.

Name	Type	Description
event	object	The event object.
switch	Switch	A reference to the switch (also this refers to the switch).

afterActionCallback (event, button)

button.js:26

Callback for the button afterAction.

Name	Type	Description
event	object	The event object.
button	Button	A reference to the button (also this refers to the button).

beforeActionCallback (event, button)

button.js:18

Callback for the button beforeAction.

Name	Type	Description
event	object	The event object.
button	Button	A reference to the button (also this refers to the button).

beforeActionCallback (event, switch)

switch.js:22

Callback for the switch beforeAction.

Name	Type	Description
event	object	The event object.
switch	Switch	A reference to the switch (also this refers to the switch).

CoordinatePoint Object

A coordinate point is a PIXI.Point or object in form {x,y} that contains map coordinates instead of pixel values, where x represents the latitude and y the longitude.

Properties:

Name	Type	Description
x	number	Indicates whether the Courage component is present.
y	number	Indicates whether the Power component is present.

Frame Object

The complete Triforce, or one or more components of the Triforce.

Properties:

Name	Type	Description
x	number	X position of the frame.
y	number	Y position of the frame.
width	number	Width of the frame.
height	number	Height od the frame.
localCenter	Point	Local center of the map.
center	Point	Global center of the map.

KeyCode object

Properties:

Name	Type	Description
key	string	an ID.
altKey	boolean	Defines if KeyCode requires the alt key to be pressed.
shiftKey	boolean	Defines if KeyCode requires the shift key to be pressed.
ctrlKey	boolean	Defines if KeyCode requires the ctrl key to be pressed.

KeyCodePairs object

Properties:

Name	Type	Description
name	string	Name of the KeyCode.
keyCode	KeyCode	KeyCode

onCompleteCallback (flippable)

flippable.js:20

Callback for the flippable onComplete function.

Name	Type	Description
flippable	Flippable	A reference to the flippable (also this refers to the flippable).

onCompleteCallback (event, slider)

slider.js:22

Callback for the slider action onComplete.

Name	Type	Description
event	object	The event object.
slider	Slider	A reference to the slider (also this refers to the slider).

onStartCallback (flippable)

flippable.js:6

Callback for the flippable onStart function.

Name	Type	Description
flippable	Flippable	A reference to the flippable (also this refers to the flippable).

onStartCallback (event, slider)

slider.js:6

Callback for the slider action onStart.

Name	Type	Description
event	object	The event object.
slider	Slider	A reference to the slider (also this refers to the slider).

onUpdateCallback (flippable)

flippable.js:13

Callback for the flippable onUpdate function.

Name	Type	Description
flippable	Flippable	A reference to the flippable (also this refers to the flippable).

onUpdateCallback (event, slider)

slider.js:14

Callback for the slider action onUpdate.

Name	Type	Description
event	object	The event object.
slider	Slider	A reference to the slider (also this refers to the slider).

Point Object

A PIXI.Point or object in form {x,y}.

Properties:

Name	Type	Description
x	number	Indicates whether the Courage component is present.
y	number	Indicates whether the Power component is present.