Version: 2018.3 (switch to 2019.1)
LanguageEnglish
  • C#

GUILayout.PasswordField

Other Versions
Leave feedback
public static string PasswordField(string password, char maskChar, params GUILayoutOption[] options);
public static string PasswordField(string password, char maskChar, int maxLength, params GUILayoutOption[] options);
public static string PasswordField(string password, char maskChar, GUIStyle style, params GUILayoutOption[] options);
public static string PasswordField(string password, char maskChar, int maxLength, GUIStyle style, params GUILayoutOption[] options);

Parameters

passwordPassword to edit. The return value of this function should be assigned back to the string as shown in the example.
maskCharCharacter to mask the password with.
maxLengthThe maximum length of the string. If left out, the user can type for ever and ever.
styleThe 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.


Password field in the Game View.

using UnityEngine;

public class ExampleScript : MonoBehaviour
{
    string passwordToEdit = "My Password";

    void OnGUI()
    {
        // Make a password field that modifies passwordToEdit.
        passwordToEdit = GUILayout.PasswordField(passwordToEdit, "*"[0], 25);
    }
}

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

  • Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

    Copyright © 2019 Unity Technologies. Publication: 2018.3-002V. Built: 2019-04-15.
    TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information