Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

GUI.TextArea

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

Parameters

position Rectangle on the screen to use for the text field.
text Text to edit. The return value of this function should be assigned back to the string as shown in the example.
maxLength The maximum length of the string. If left out, the user can type for ever and ever.
style The 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); }