The active state for the window
The opacity of the window background (0 to 255)
The bitmap used for the window contents
The bitmap used for the window contents background
The opacity of the window contents (0 to 255)
The visibility of the cursor
The visibility of the down scroll arrow
The visibility of the frame
The height of the window in pixels
The height of the content area in pixels
The rectangle of the content area
The width of the content area in pixels
The size of the margin for the window background
The opacity of the window without contents (0 to 255)
The openness of the window (0 to 255)
The origin point of the window for scrolling
The size of the padding between the frame and contents
The visibility of the pause sign
The visibility of the up scroll arrow
The width of the window in pixels
The image used as a window skin
Activates the window
Gets an actor name from their id
| Name | Type | Description |
|---|
n | number | Actor id |
Returns:
| Type | Description |
|---|
| string | The actor's name |
Adds a child between the background and contents
| Name | Type | Description |
|---|
child | object | The child to add |
Returns:
| Type | Description |
|---|
| object | The child that was added |
Adds a child to the client area
| Name | Type | Description |
|---|
child | object | The child to add |
Returns:
| Type | Description |
|---|
| object | The child that was added |
Creates a rectangle for an item of text
Returns:
| Type | Description |
|---|
| Rectangle | Rectangle that encompasses the text item |
Calculates the height of the text in a text state
| Name | Type | Description |
|---|
textState | Object | The text state object |
Returns:
| Type | Description |
|---|
| string | The height of the text |
Changes the text outline color of text drawn to the window
| Name | Type | Description |
|---|
color | string | The new outline color to use |
Changes the opacity of what is painted to the contents of the window
| Name | Type | Description |
|---|
enabled | boolean | True = use full opacity | False = use translucent opacity |
Changes the text color of text drawn to the window
| Name | Type | Description |
|---|
color | string | The new color to draw text in |
Checks if the given rect parameter is a valid
Rectangle| Name | Type | Description |
|---|
rect | * | The object to check for validity |
Throws:
Error if the object is not a valid rectangle
Returns:
| Type | Description |
|---|
| boolean | True if the object is a valid rectangle |
Clears the window's text
Start closing the window
Gets the height needed for the window contents
Returns:
| Type | Description |
|---|
| number | Height needed for the window contents |
Gets the width needed for the window contents
Returns:
| Type | Description |
|---|
| number | Width needed for the window contents |
Converts escape code characters in text, for example \v[x]
| Name | Type | Description |
|---|
text | string | The text to convert |
Returns:
| Type | Description |
|---|
| string | Text with escape characters converted |
Creates the contents of the window
Creates the background dimmer sprite
Creates a text buffer
| Name | Type | Description |
|---|
rtl | boolean | If the text is right to left (such as arabic text) |
Returns:
| Type | Description |
|---|
| string | The buffer for text embedding either right to left or left to right |
createTextState(text, x, y, width)Objectinherited
Creates a text state object for drawing text with text codes
| Name | Type | Description |
|---|
text | string | The text to draw |
x | number | The x coordinate to draw the text |
y | number | The y coordinate to draw the text |
width | number | The width of the text |
Returns:
| Type | Description |
|---|
| Object | The text state object |
Deactivates the window
Destroys the window
Destroys the contents of the window
drawCharacter(characterName, characterIndex, x, y)inherited
Draws a character at x/y coordinates
| Name | Type | Description |
|---|
characterName | string | The name of the character sheet bitmap |
characterIndex | number | The index of the character on the sheet |
x | number | The x coordinate |
y | number | The y coordinate |
drawCurrencyValue(value, unit, x, y, width)inherited
Draws a currency value
| Name | Type | Description |
|---|
value | number | The amount of currency |
unit | string | The currency unit |
x | number | The x coordinate |
y | number | The y coordinate |
width | number | The width available to draw the item name |
drawFace(faceName, faceIndex, x, y, width, height)inherited
Draws a face at x/y coordinates with width/height
| Name | Type | Description |
|---|
faceName | string | The name of the face sheet bitmap |
faceIndex | number | The index of the face on the sheet |
x | number | The x coordinate |
y | number | The y coordinate |
width | number | The width of the face |
height | number | The height of the face |
Draws an icon at x/y coordinates
| Name | Type | Description |
|---|
iconIndex | number | The index of the icon to draw |
x | number | The x coordinate |
y | number | The y coordinate |
Draws an item's name with its icon
| Name | Type | Description |
|---|
item | Object | The item object to draw, must at least have iconIndex and name properties |
x | number | The x coordinate |
y | number | The y coordinate |
width | number | The width available to draw the item name |
Draws a rectangle of given width/height at given x/y coordinates
| Name | Type | Description |
|---|
x | number | The X coordinate of the upper left corner of the rectangle |
y | number | The Y coordinate of the upper left corner of the rectangle |
width | number | The width in pixels of the rectangle |
height | number | The height in pixels of the rectangle |
Draws the window shape into PIXI.Graphics object. Used by WindowLayer
drawText(text, x, y, maxWidth, align)inherited
Draws text to the window's contents. Does not support text codes in the text, but will fit the text within the maximum width without overflowing.
| Name | Type | Description |
|---|
text | string | The text to draw |
x | number | The x coordinate to begin drawing the text |
y | number | The y coordinate to begin drawing the text |
maxWidth | number | The maximum width in pixels of the text |
align | string | The alignment of the text |
Draws text to the window's contents. Does support text codes.
| Name | Type | Description |
|---|
text | string | The text to draw |
x | number | The x coordinate to draw the text |
y | number | The y coordinate to draw the text |
width | number | The width of the text |
Returns:
| Type | Description |
|---|
| number | The width of the drawn text |
Calculates the height needed for a given number of lines
| Name | Type | Description |
|---|
numLines | number | The number of lines to calculate the height of |
Returns:
| Type | Description |
|---|
| number | The height needed to fit the amount of lines |
Flushes the text state
| Name | Type | Description |
|---|
textState | Object | The text state to flush |
Stops displaying the window
Hides the background dimmer sprite
Initializes the window
Checks whether the window is completely closed (openness == 0)
Returns:
| Type | Description |
|---|
| boolean | True if the window is closed |
Check if the window is closing
Returns:
| Type | Description |
|---|
| boolean | True if window is currently closing |
Checks whether the window is completely open (openness == 255)
Returns:
| Type | Description |
|---|
| boolean | True if the window is open |
Check if the window is opening
Returns:
| Type | Description |
|---|
| boolean | True if window is currently opening |
Gets the height in pixels of an item
Returns:
| Type | Description |
|---|
| number | Height of an item |
Gets the padding for an item
Returns:
| Type | Description |
|---|
| number | Amount of item padding |
Gets the width in pixels of an item
Returns:
| Type | Description |
|---|
| number | Width of an item |
Gets the height in pixels of one line
Returns:
| Type | Description |
|---|
| number | Height of a line |
Loads the windowskin for the window
Makes the font size bigger by 12
Makes the font size smaller by 12
Gets the max font size in a line of text
| Name | Type | Description |
|---|
line | string | The line of text |
Returns:
| Type | Description |
|---|
| number | The largest font size seen in the line of text |
Sets the x, y, width, and height of the window
| Name | Type | Description |
|---|
x | number | The new x coordinate of the window |
y | number | The new y coordinate of the window |
width | number | The new width of the window |
height | number | The new height of the window |
Moves the cursor position by the given amount
| Name | Type | Description |
|---|
x | number | The amount of horizontal movement |
y | number | The amount of vertical movement |
Moves the inner children by the given amount
| Name | Type | Description |
|---|
x | number | The amount of horizontal movement |
y | number | The amount of vertical movement |
Gets an escape code
| Name | Type | Description |
|---|
textState | Object | The text state object |
Returns:
| Type | Description |
|---|
| string | The escape code, will be empty string if none |
obtainEscapeParam(textState)int | stringinherited
Gets an escape param
| Name | Type | Description |
|---|
textState | Object | The text state object |
Returns:
| Type | Description |
|---|
| int|string | The escape param, will be empty string if none |
Start opening the window
Gets an actor name from their position in the party
| Name | Type | Description |
|---|
n | number | Position in the party |
Returns:
| Type | Description |
|---|
| string | The actor's name |
Plays the buzzer sound effect
Plays the cursor sound effect
Plays the ok sound effect
Processes all text within a text state object
| Name | Type | Description |
|---|
textState | Object | The text state to process |
Processes a character in a text state at the current index of the text state
| Name | Type | Description |
|---|
textState | Object | The text state object for processing a character |
Processes a color change
| Name | Type | Description |
|---|
colorIndex | number | The index of the color to change to |
processControlCharacter(textState, c)inherited
Processes a control character within a text state
| Name | Type | Description |
|---|
textState | Object | The text state object with the character |
c | string | The character to process |
processDrawIcon(iconIndex, textState)inherited
Processes drawing an icon
| Name | Type | Description |
|---|
iconIndex | number | The index of the icon to draw |
textState | Object | The text state object |
processEscapeCharacter(code, textState)inherited
Processes an escape character in a text state
| Name | Type | Description |
|---|
code | string | The escape character's code |
textState | Object | The text state object |
Processing for a new line
| Name | Type | Description |
|---|
textState | Object | The text state object |
Refreshes the window
Refreshes the background dimmer sprite
Resets font settings to defaults
Resets text and outline color to defaults
Sets the background type of the window
| Name | Type | Description |
|---|
type | number | The type of background (0 = normal, 1 = dim, 2 = transparent) |
Sets the position of the command cursor
| Name | Type | Description |
|---|
x | number | The x coordinate of the cursor |
y | number | The y coordinate of the cursor |
width | number | The width of the cursor |
height | number | The height of the cursor |
Sets the item to display in the window
| Name | Type | Description |
|---|
item | Object | The item with description property |
Sets the text to show in the window
| Name | Type | Description |
|---|
text | string | The text to display in the window |
Changes the color of the background
| Name | Type | Description |
|---|
r | number | The red value in the range (-255, 255) |
g | number | The green value in the range (-255, 255) |
b | number | The blue value in the range (-255, 255) |
Displays the window
Shows the background dimmer sprite
Gets the system text color
Returns:
| Type | Description |
|---|
| string | The system text color |
Calculates the width needed for a given string of text. Does support text codes.
| Name | Type | Description |
|---|
text | string | The text to calculate the width for |
Returns:
| Type | Description |
|---|
| Object | The width and height of the text |
Calculates the width needed for a given string of text. Does not support text codes.
| Name | Type | Description |
|---|
text | string | The text to calculate the width for |
Returns:
| Type | Description |
|---|
| number | The width of the text |
Gets the opacity to use for a translucent effect
Returns:
| Type | Description |
|---|
| number | The opacity to use for a translucent effect |
Updates the window for each frame
Updates the window's background opacity
Updates the background dimmer sprite
Updates the closing effect
Updates the opening effect
Updates the window's padding
Updates the window's tone
Updates the transform on all children of this container for rendering