Module TextAndRenderFuncs

Text printing and drawing functions

Renderer functions

Renderer.printText (text, x, y) Draw a text with default capabilities
Renderer.printText (text, x, y, fontType) Draw a text with default capabilities by specified font
Renderer.printText (text, x, y, fontType, size) Draw a text by specified font and custom pixel size
Renderer.printText (text, x, y, fontType, size, rgba) Draw a text with by specified font, pixel size, and RGBA-color
Renderer.printTextWP (text, x, y, zValue) Draw a text with default capabilities with render prioritizing
Renderer.printTextWP (text, x, y, fontType, zValue) Draw a text with default capabilities by specified font with render prioritizing
Renderer.printTextWP (text, x, y, fontType, size, zValue) Draw a text by specified font, custom pixel size, and render prioritizing
Renderer.printTextWP (text, x, y, fontType, size, rgba, zValue) Draw a text with by specified font, pixel size, RGBA-color, and render prioritizing

LunaLua text functions

Text.windowDebug (debugText) Writes debugText in an external message box and shows it to the user.
Text.print (text, x, y) Draw a text with default capabilities.
Text.print (text, fontType, x, y) Draw a text with default capabilities and specified font
Text.printWP (text, x, y, zValue) Draw a text with default capabilities and render prioritizing.
Text.printWP (text, fontType, x, y, zValue) Draw a text with default capabilities, specified font, and render prioritizing
Text.showMessageBox (msgText) Displays In-Game Message Box.
As difference to LunaLua, this message box works everywhere while in LunaLua works on levels only.

Deprecated LunaLua functions

printText (text, x, y) Draw a text with default capabilities [Deprecated, use Text.print or Renderer.printText]
printText (text, fontType, x, y) Draw a text with default capabilities and specified font [Deprecated, use Text.print or Renderer.printText]
windowDebug (debugText) Writes debugText in an external message box and shows it to the user [Deprecated, use Text.windowDebug]


Renderer functions

Renderer.printText (text, x, y)
Draw a text with default capabilities

Parameters:

  • text string Text to print
  • x int X position on screen
  • y int Y position on screen
Renderer.printText (text, x, y, fontType)
Draw a text with default capabilities by specified font

Parameters:

  • text string Text to print
  • x int X position on screen
  • y int Y position on screen
  • fontType int ID of a font registered in config pack
Renderer.printText (text, x, y, fontType, size)
Draw a text by specified font and custom pixel size

Parameters:

  • text string Text to print
  • x int X position on screen
  • y int Y position on screen
  • fontType int ID of a font registered in config pack
  • size uint Pixel size of one font letter
Renderer.printText (text, x, y, fontType, size, rgba)
Draw a text with by specified font, pixel size, and RGBA-color

Parameters:

  • text string Text to print
  • x int X position on screen
  • y int Y position on screen
  • fontType int ID of a font registered in config pack
  • size uint Pixel size of one font letter
  • rgba uint RGBA (Red-Green-Blue-Alpha) color value in next format: 0xRRGGBBAA
Renderer.printTextWP (text, x, y, zValue)
Draw a text with default capabilities with render prioritizing

Parameters:

  • text string Text to print
  • x int X position on screen
  • y int Y position on screen
  • zValue double Z Value which defines a render priority
Renderer.printTextWP (text, x, y, fontType, zValue)
Draw a text with default capabilities by specified font with render prioritizing

Parameters:

  • text string Text to print
  • x int X position on screen
  • y int Y position on screen
  • fontType int ID of a font registered in config pack
  • zValue double Z Value which defines a render priority
Renderer.printTextWP (text, x, y, fontType, size, zValue)
Draw a text by specified font, custom pixel size, and render prioritizing

Parameters:

  • text string Text to print
  • x int X position on screen
  • y int Y position on screen
  • fontType int ID of a font registered in config pack
  • size uint Pixel size of one font letter
  • zValue double Z Value which defines a render priority
Renderer.printTextWP (text, x, y, fontType, size, rgba, zValue)
Draw a text with by specified font, pixel size, RGBA-color, and render prioritizing

Parameters:

  • text string Text to print
  • x int X position on screen
  • y int Y position on screen
  • fontType int ID of a font registered in config pack
  • size uint Pixel size of one font letter
  • rgba uint RGBA (Red-Green-Blue-Alpha) color value in next format: 0xRRGGBBAA
  • zValue double Z Value which defines a render priority

LunaLua text functions

Added for compatibility with LunaLua API.
Text.windowDebug (debugText)
Writes debugText in an external message box and shows it to the user.

Parameters:

  • debugText string Message text to show
Text.print (text, x, y)
Draw a text with default capabilities. Same as Renderer.printText.

Parameters:

  • text string Text to print
  • x int X position on screen
  • y int Y position on screen
Text.print (text, fontType, x, y)
Draw a text with default capabilities and specified font

Parameters:

  • text string Text to print
  • fontType int Fond type ID (Note: font #2 will be shown in black color)
  • x int X position on screen
  • y int Y position on screen
Text.printWP (text, x, y, zValue)
Draw a text with default capabilities and render prioritizing. Same as Renderer.printTextWP.

Parameters:

  • text string Text to print
  • x int X position on screen
  • y int Y position on screen
  • zValue double Z Value which defines a render priority
Text.printWP (text, fontType, x, y, zValue)
Draw a text with default capabilities, specified font, and render prioritizing

Parameters:

  • text string Text to print
  • fontType int Fond type ID (Note: font #2 will be shown in black color)
  • x int X position on screen
  • y int Y position on screen
  • zValue double Z Value which defines a render priority
Text.showMessageBox (msgText)
Displays In-Game Message Box.
As difference to LunaLua, this message box works everywhere while in LunaLua works on levels only.

Parameters:

Deprecated LunaLua functions

Added for compatibility with LunaLua API.
printText (text, x, y)
Draw a text with default capabilities [Deprecated, use Text.print or Renderer.printText]

Parameters:

  • text string Text to print
  • x int X position on screen
  • y int Y position on screen

See also:

printText (text, fontType, x, y)
Draw a text with default capabilities and specified font [Deprecated, use Text.print or Renderer.printText]

Parameters:

  • text string Text to print
  • fontType int Fond type ID (Note: font #2 will be shown in black color)
  • x int X position on screen
  • y int Y position on screen

See also:

windowDebug (debugText)
Writes debugText in an external message box and shows it to the user [Deprecated, use Text.windowDebug]

Parameters:

  • debugText string Message text to show
generated by LDoc 1.4.6 Last updated 2017-08-21 02:20:32