Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

Input.inputString

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static var inputString: string;
public static string inputString;
public static inputString as string

Description

Returns the keyboard input entered this frame. (Read Only)

Only ASCII characters are contained in the inputString.

The string can contain two special characters which should be handled: Character "\b" represents backspace.
Character "\n" represents return or enter.

	// Shows how to read typing input from the keyboard
	// (eg. the user entering his name).
	// You need to attach this script to a GUIText object.

function Update () { for (var c : char in Input.inputString) { // Backspace - Remove the last character if (c == "\b"[0]) { if (guiText.text.Length != 0) guiText.text = guiText.text.Substring(0, guiText.text.Length - 1); } // End of entry else if (c == "\n"[0] || c == "\r"[0]) {// "\n" for Mac, "\r" for windows. print ("User entered his name: " + guiText.text); } // Normal text input - just append to the end else { guiText.text += c; } } }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Update() {
        foreach (char c in Input.inputString) {
            if (c == "\b"[0])
                if (guiText.text.Length != 0)
                    guiText.text = guiText.text.Substring(0, guiText.text.Length - 1);
                
            else
                if (c == "\n"[0] || c == "\r"[0])
                    print("User entered his name: " + guiText.text);
                else
                    guiText.text += c;
        }
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Update() as void:
		for c as char in Input.inputString:
			if c == '\b'[0]:
				if guiText.text.Length != 0:
					guiText.text = guiText.text.Substring(0, (guiText.text.Length - 1))
			elif (c == '\n'[0]) or (c == '\r'[0]):
				print(('User entered his name: ' + guiText.text))
			else:
				guiText.text += c