Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Suggest a change

GUI.TextArea

static function TextArea(position: Rect, text: string): string;
static string TextArea(Rect position, string text);
static def TextArea(position as Rect, text as string) as string
static function TextArea(position: Rect, text: string, maxLength: int): string;
static string TextArea(Rect position, string text, int maxLength);
static def TextArea(position as Rect, text as string, maxLength as int) as string
static function TextArea(position: Rect, text: string, style: GUIStyle): string;
static string TextArea(Rect position, string text, GUIStyle style);
static def TextArea(position as Rect, text as string, style as GUIStyle) as string
static function TextArea(position: Rect, text: string, maxLength: int, style: GUIStyle): string;
static string TextArea(Rect position, string text, int maxLength, GUIStyle style);
static def TextArea(position as Rect, text as string, maxLength as int, style as GUIStyle) as string

Parameters

positionRectangle on the screen to use for the text field.
textText to edit. The return value of this function should be assigned back to the string as shown in the example.
maxLengthThe maximum length of the string. If left out, the user can type for ever and ever.
styleThe style to use. If left out, the textArea style from the current GUISkin is used.

Returns

string The edited string.

Description

Make a Multi-line text area where the user can edit a string.

	var stringToEdit : String = "Hello World\nI've got 2 lines...";

function OnGUI () { // Make a multiline text area that modifies stringToEdit. stringToEdit = GUI.TextArea (Rect (10, 10, 200, 100), stringToEdit, 200); }

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public string stringToEdit = "Hello World\nI've got 2 lines...";
    void OnGUI() {
        stringToEdit = GUI.TextArea(new Rect(10, 10, 200, 100), stringToEdit, 200);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public stringToEdit as string = 'Hello World\nI\'ve got 2 lines...'

	def OnGUI() as void:
		stringToEdit = GUI.TextArea(Rect(10, 10, 200, 100), stringToEdit, 200)

Your name (optional):
Your email (optional):
Please write your suggestion here: