Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

GUI.PasswordField

static function PasswordField(position: Rect, password: string, maskChar: char): string;
static string PasswordField(Rect position, string password, char maskChar);
static def PasswordField(position as Rect, password as string, maskChar as char) as string
static function PasswordField(position: Rect, password: string, maskChar: char, maxLength: int): string;
static string PasswordField(Rect position, string password, char maskChar, int maxLength);
static def PasswordField(position as Rect, password as string, maskChar as char, maxLength as int) as string
static function PasswordField(position: Rect, password: string, maskChar: char, style: GUIStyle): string;
static string PasswordField(Rect position, string password, char maskChar, GUIStyle style);
static def PasswordField(position as Rect, password as string, maskChar as char, style as GUIStyle) as string
static function PasswordField(position: Rect, password: string, maskChar: char, maxLength: int, style: GUIStyle): string;
static string PasswordField(Rect position, string password, char maskChar, int maxLength, GUIStyle style);
static def PasswordField(position as Rect, password as string, maskChar as char, maxLength as int, style as GUIStyle) as string

Parameters

positionRectangle on the screen to use for the text field.
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.

	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)