Methods

add(text)

Game_Message.js:205

Adds the given text to the message

Name	Type	Description
text	string	The text to add

allText()string

Game_Message.js:397

Gets all of the text

Returns:

Type	Description
string	All of the text

background()number

Game_Message.js:88

Get the background type

Returns:

Type	Description
number	The background type

choiceBackground()number

Game_Message.js:124

Get the choice background type

Returns:

Type	Description
number	The choice background type

choiceCancelType()number

Game_Message.js:115

Get the choice cancel type

Returns:

Type	Description
number	The choice cancel type

choiceDefaultType()number

Game_Message.js:106

Get the default choice type

Returns:

Type	Description
number	The default choice type

choicePositionType()number

Game_Message.js:133

Get the choice position type

Returns:

Type	Description
number	The choice position type

choices()Array

Game_Message.js:52

Get the choice array

Returns:

Type	Description
Array	The choice array

clear()

Game_Message.js:25

Clear message variables

faceIndex()number

Game_Message.js:79

Get the face index (for face image file)

Returns:

Type	Description
number	The face index

faceName()string

Game_Message.js:70

Get the face name (for face image file)

Returns:

Type	Description
string	The face name

hasText()boolean

Game_Message.js:338

Check if there is text in the message

Returns:

Type	Description
boolean	True if there is text

initialize()

Game_Message.js:18

Initialize the class

isBusy()boolean

Game_Message.js:374

Check if the message is busy

Returns:

Type	Description
boolean	True if busy

isChoice()boolean

Game_Message.js:347

Check if there are choices

Returns:

Type	Description
boolean	True if there are choices

isItemChoice()boolean

Game_Message.js:365

Check if there is an item choice

Returns:

Type	Description
boolean	True if there is an item choice

isNumberInput()boolean

Game_Message.js:356

Check if there is number input

Returns:

Type	Description
boolean	True if there is number input

isRTL()boolean

Game_Message.js:406

Check if the text is right to left

Returns:

Type	Description
boolean	True if RTL

itemChoiceItypeId()number

Game_Message.js:169

Get the item choice item type id

Returns:

Type	Description
number	The item type id

itemChoiceVariableId()number

Game_Message.js:160

Get the item choice variable id

Returns:

Type	Description
number	The variable id

newPage()

Game_Message.js:386

Creates a new page

numInputMaxDigits()number

Game_Message.js:151

Get the number input maximum allowed digits

Returns:

Type	Description
number	The max allowed digits

numInputVariableId()number

Game_Message.js:142

Get the number input variable id

Returns:

Type	Description
number	The variable id

onChoice(n)

Game_Message.js:326

Handling when a choice is made

Name	Type	Description
n	number	The choice made

positionType()number

Game_Message.js:97

Get the position type

Returns:

Type	Description
number	The position type

scrollMode()boolean

Game_Message.js:178

Check if scroll mode

Returns:

Type	Description
boolean	True if scroll mode

scrollNoFast()boolean

Game_Message.js:196

Check if scroll no fast

Returns:

Type	Description
boolean	True if scroll no fast

scrollSpeed()number

Game_Message.js:187

Get the scroll speed

Returns:

Type	Description
number	The scroll speed

setBackground(background)

Game_Message.js:234

Sets the background type

Name	Type	Description
background	number	The new background type

setChoiceBackground(background)

Game_Message.js:265

Sets the choice background type

Name	Type	Description
background	number	The new choice background type

setChoiceCallback(callback)

Game_Message.js:317

Sets the choice callback function

Name	Type	Description
callback	function|null	The callback, null if none

setChoicePositionType(positionType)

Game_Message.js:274

Sets the choice position type

Name	Type	Description
positionType	number	The new choice position type

setChoices(choices, defaultType, cancelType)

Game_Message.js:254

Sets the choice settings

Name	Type	Description
choices	Array	The array of choices
defaultType	number	The choice default type
cancelType	number	The choice cancel type

setFaceImage(faceName, faceIndex)

Game_Message.js:224

Sets the face image settings

Name	Type	Description
faceName	string	The face image file name
faceIndex	number	The index of the face to use on the face sheet

setItemChoice(variableId, itemType)

Game_Message.js:295

Sets the item choice settings

Name	Type	Description
variableId	number	The item choice variable id to use
itemType	number	The item type to use

setNumberInput(variableId, maxDigits)

Game_Message.js:284

Sets the number input settings

Name	Type	Description
variableId	number	The number input variable id to use
maxDigits	number	The number input max digits to use

setPositionType(positionType)

Game_Message.js:243

Sets the position type

Name	Type	Description
positionType	number	The new position type

setScroll(speed, noFast)

Game_Message.js:306

Sets the scroll settings

Name	Type	Description
speed	number	The scroll speed
noFast	boolean	If no fast mode scrolling

setSpeakerName(speakerName)

Game_Message.js:214

Sets the speaker name

Name	Type	Description
speakerName	string	The new speaker name

speakerName()string

Game_Message.js:61

Get the speaker name

Returns:

Type	Description
string	The speaker name