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.

GUI.PasswordField

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 function PasswordField(position: Rect, password: string, maskChar: char): string;
public static string PasswordField(Rect position, string password, char maskChar);
public static def PasswordField(position as Rect, password as string, maskChar as char) as string
public static function PasswordField(position: Rect, password: string, maskChar: char, maxLength: int): string;
public static string PasswordField(Rect position, string password, char maskChar, int maxLength);
public static def PasswordField(position as Rect, password as string, maskChar as char, maxLength as int) as string
public static function PasswordField(position: Rect, password: string, maskChar: char, style: GUIStyle): string;
public static string PasswordField(Rect position, string password, char maskChar, GUIStyle style);
public static def PasswordField(position as Rect, password as string, maskChar as char, style as GUIStyle) as string
public static function PasswordField(position: Rect, password: string, maskChar: char, maxLength: int, style: GUIStyle): string;
public static string PasswordField(Rect position, string password, char maskChar, int maxLength, GUIStyle style);
public static def PasswordField(position as Rect, password as string, maskChar as char, maxLength as int, style as GUIStyle) as string

Parameters

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.

	var passwordToEdit : String = "My Password";
	function OnGUI () {
		// Make a password field that modifies passwordToEdit.
		passwordToEdit = GUI.PasswordField (Rect (10, 10, 200, 20), passwordToEdit, "*"[0], 25);
	}

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);
    }
}

import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public passwordToEdit as string = 'My Password'

	def OnGUI() as void:
		passwordToEdit = GUI.PasswordField(Rect(10, 10, 200, 20), passwordToEdit, '*'[0], 25)
Copyright © 2014 Unity Technologies
LearnCommunityAsset StoreBuyDownload