Unity Script Reference – GUILayout.TextArea

GUILayout.TextArea

static function TextArea (text : string, params options : GUILayoutOption[]) : string

static function TextArea (text : string, maxLength : int, params options : GUILayoutOption[]) : string

static function TextArea (text : string, style : GUIStyle, params options : GUILayoutOption[]) : string

static function TextArea (text : string, maxLength : int, style : GUIStyle, params options : GUILayoutOption[]) : string

Parameters

Name	Description
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 textField style from the current GUISkin is used.
options	An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style. See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

string - the edited string.

Description

Make a multi-line text field where the user can edit a string.

Text area in the Game View.

JavaScripts

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

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

using UnityEngine;
using System.Collections;

public class example : MonoBehaviour {
public string stringToEdit = "Hello World\nI've got 2 lines...";
void OnGUI() {
stringToEdit = GUILayout.TextArea(stringToEdit, 200);
}
}

import UnityEngine
import System.Collections

class example(MonoBehaviour):

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

def OnGUI():
stringToEdit = GUILayout.TextArea(stringToEdit, 200)