Creates an instance of Window_Help.
The closing property; determines if the window is closing.
The opening property; determines if the window is opening.
The text that is displayed within the window.
The standard face height; default is 144.
The standard face width; default is 144.
The standard icon height; default is 32.
The standard icon width; default is 32.
Activates the window, allowing it to be processed and to update.
Returns the actor name given an index; the index starts from 1.
Calculates the text height of the textState (when using drawTextEx); if all is set to true, all lines of text are calculated, otherwise only a single line is processed.
Returns the x coordinate of the mouse to a local window x coordinate.
Returns the y coordinate of the mouse to a local window y coordinate.
Changes the paintOpacity (the opacity of the text drawn to the window); if true the opacity is set to 255, otherwise the opacity is set to 160.
Changes the text color property given a css color string.
Closes the window.
Returns the inner content height of the window.
Returns the inner content width of the window.
Converts the escape characters and returns the text content after processing the characters.
Creates the contents of the window; this is the area of the window which text is drawn to.
Returns the crisis color as a css color string.
Deactives the window, preventing further processing.
Returns the death color as a css color string.
Color 1 of the dimmer sprite bitmap. for the gradient.
Color 2 of the dimmer sprite bitmap for the gradient.
Draws the actor class at the specified x and y coordinates within the given width.
Draws the actor face at the specified x and y coordinates within the given width.
Draws the actor hp at the specified x and y coordinates within the given width.
Draws the actor icons at the specified x and y coordinates within the given width.
Draws the actor level at the specified x and y coordinates.
Draws the actor mp at the specified x and y coordinates within the given width.
Draws the actor name at the specified x and y coordinates within the given width.
Draws the actor nickname at the specified x and y coordinates within the given width.
Draws a simple status for the game actor passed into the method at the specified x and y coordinates within the given width.
Draws the actor tp at the specified x and y coordinates within the given width.
Draws a character (map sprites) at the specified x and y coordinate. CharacterName refers to character spritesheet, and characterIndex refers to the characterIndex on the spritesheet.
Draws the currency value given at the specified x and y coordinates within the width given. Useful if you want to write your own custom currency value.
Draws the current and max number at the specified x and y coordinate within the given width. Color1 represents the current number and color2 represents the max number when the text is drawn.
Draws a gauge at the specified x and y coordinates within the given width. Color1 and Color2 represent the gradient as css color strings of the gauge.
Draws an icon given the specified iconIndex at the specified x and y coordinates. The Width and Height of the icon is based on the _iconWidth and _iconHeight properties.
Draws the item name at the specified x and y coordinates within the given width.
Given text or a number, draws the content to the window's contents layer at the specified x and y coordinate within the max width. The text content can also be aligned with the align property. The possible alignments are: "left", "center", "right".
Draws text with text codes included; this will draw icons, increase text height, and more.
Returns the fitting height given a number of lines based on the line height plus standard padding of the window. Default formula: numLines lineHeight + standardPadding 2
Returns the gauage back color as a css color string.
Hides the window, making it invisible; the window is not closed when hidden.
Hides the background dimmer sprite.
Returns the hp color as a css string.
Returns the hp gauge color 1 as a css color string.
Returns the hp gauge color 2 as a css color string.
Returns true if the window is currently closing.
Returns true if the window is currently opening.
Returns the standard line height of the current window; default is 36.
Loads the window skin from the img/system directory.
Makes the font bigger by a value of 12.
Makes the font smaller by a value of 12.
Returns the mp color as a css color string.
Returns the mp cost color as a css color string.
Returns the mp gauge color 1 as a css color string.
Returns the mp gauge color 2 as a css color string.
Returns the normal color as a css color string.
Obtains the escape parameters from text codes in the text state when drawTextEx is used to draw text.
Opens the window.
Changes the text color based on the powerUpColor, powerDownColor and normal color. powerUpColor is any number greater than 0, powerDownColor is any color less than 0, otherwise normal color is returned.
Returns a party member name given an index; the index starts from 1.
Returns the pending color as a css color string.
Returns the power down color as a css color string.
Returns the power up color as a css color string.
Process each character in the text when drawTextEx is used to draw text.
Processes drawing an icon when drawTextEx is used for drawing text.
Processes escape characters when drawTextEx is used for drawing text.
Processes new line when drawTextEx is used to draw text.
Processes new page when drawTexttEx is used to draw text.
Processes the normal characters in the text when drawTextEx is used to draw text. Normal characters are letters and numbers.
Refreshes the bitmap attached to the dimmer sprite based on the window dimensions.
Reverses the face images of the game party members.
Resets the font settings of the window back to the default.
Resets the text color of the window back to the default.
Sets the background type of the window. 0 is 255 window opacity (standard). 1 is the window with background dimmer. Any other number changes the opacity to 0.
Sets the current item of the help window.
Sets the _text property of the window; this text will be displayed within the window.
Shows the window, making it visible.
Shows the background dimmer sprite.
Returns the standard back opacity of the window; this is the opacity of the area behind the window's text content. Default is 192.
Returns the standard font face of the game based on what language the game is in.
Returns the standard font size of the text in window; default is 28.
Returns the standard padding of the window; default is 18.
Returns the system color as a css color string.
Returns a text color given a numbered index as a css color string; this index maps directly to the img/system/window.png colors by default.
Returns the text padding of the window; default is 6.
Calculates the width of a text string and returns a number.
Returns the tp color as a css color string.
Returns the tp cost color as a css color string.
Returns the tp gauge color 1 as a css color string.
Returns tp gauge color 2 as a css color string.
Returns the translucentOpacity for the window; The default is 160.
The update method of the window; this is run every frame to do logic processing for the window.
Updates the back opacity of the window based on the standardBackOpacity method.
Updates the background dimmer sprite opacity based on the openness of the window.
Updates the openness of the window when the _closing property is set to true. Openness is decreased.
Updates the openness of the window when the _opening property is set to true. Openness is increased.
Updates the window padding based on the standardPadding method.
Updates the tone of the window based on the game system window tone defined in the database.
Generated using TypeDoc
The window for display the description of the selected item given an item or a text string.
Window_Help
{Window_Base}