EditboxMultiline

Classes

Class: EditboxMultiline

Extends Widget, Editboxbase

EditboxMultiline

A EditboxMultiline widget is for entering and displaying multiple lines of text. Provides cursor position queries, line and text metrics, configurable insets, and adjustable line spacing. Intended for longer text.

Method: Clear

(method) EditboxMultiline:Clear()

Clears all text in the EditboxMultiline.

Method: GetTextHeight

(method) EditboxMultiline:GetTextHeight()
  -> textHeight: number

Retrieves the total height of the text in the EditboxMultiline.

@return textHeight — The total text height.

Method: GetTextLength

(method) EditboxMultiline:GetTextLength()
  -> textLength: number

Retrieves the length of the text in the EditboxMultiline.

@return textLength — The length of the text.

Method: SetInset

(method) EditboxMultiline:SetInset(left: number, top: number, right: number, bottom: number)

Sets the inset for the EditboxMultiline.

@param left — The left inset.

@param top — The top inset.

@param right — The right inset.

@param bottom — The bottom inset.

Method: GetLineHeight

(method) EditboxMultiline:GetLineHeight()
  -> lineHeight: number

Retrieves the height of a single line in the EditboxMultiline.

@return lineHeight — The height of a line.

Method: GetCursorPosY

(method) EditboxMultiline:GetCursorPosY()
  -> cursorPosY: number

Retrieves the y-coordinate of the cursor in the EditboxMultiline.

@return cursorPosY — The y-coordinate of the cursor.

Method: GetLineCount

(method) EditboxMultiline:GetLineCount()
  -> lineCount: number

Retrieves the number of lines in the EditboxMultiline.

@return lineCount — The number of lines.

Method: GetCursorPosX

(method) EditboxMultiline:GetCursorPosX()
  -> cursorPosX: number

Retrieves the x-coordinate of the cursor in the EditboxMultiline.

@return cursorPosX — The x-coordinate of the cursor.

Method: SetLineSpace

(method) EditboxMultiline:SetLineSpace(space: number)

Sets the line spacing for the EditboxMultiline.

@param space — The line spacing value.