Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

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

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> 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;

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.

// Reading typed input from the keyboard
// (eg, the user entering their name).
// You need to attach this script to an object with
// a GUIText component.

var gt: GUIText;

function Start() { gt = GetComponent.<GUIText>(); }

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

public class ExampleScript : MonoBehaviour { public GUIText gt;

void Start() { gt = GetComponent<GUIText>(); }

void Update() { foreach (char c in Input.inputString) { if (c == '\b') // has backspace/delete been pressed? { if (gt.text.Length != 0) { gt.text = gt.text.Substring(0, gt.text.Length - 1); } } else if ((c == '\n') || (c == '\r')) // enter/return { print("User entered their name: " + gt.text); } else { gt.text += c; } } } }

Did you find this page useful? Please give it a rating: