Unity - Scripting API: GUI.PasswordField

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.

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.

Your name Your email Suggestion*

Cancel

Declaration

public static string PasswordField(Rect position, string password, char maskChar);

Declaration

public static string PasswordField(Rect position, string password, char maskChar, int maxLength);

Declaration

public static string PasswordField(Rect position, string password, char maskChar, GUIStyle style);

Declaration

public static string PasswordField(Rect position, string password, char maskChar, int maxLength, GUIStyle style);

Parameters

Parameter	Description
position	Rectangle on the screen to use for the text field.
password	Password to edit. The return value of this function should be assigned back to the string as shown in the example.
maskChar	Character to mask the password with.
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.

Returns

string The edited password.

Description

Make a text field where the user can enter a password.

using UnityEngine;
using System.Collections;public class ExampleClass : MonoBehaviour
{
    public string passwordToEdit = "My Password";
    void OnGUI()
    {
        passwordToEdit = GUI.PasswordField(new Rect(10, 10, 200, 20), passwordToEdit, "*"[0], 25);
    }
}