Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


PasswordField

Make a text field where the user can enter a password.
Read time 3 minutesLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.IMGUIModule

PasswordField(Rect, string, char)

Make a text field where the user can enter a password.
public static string PasswordField(Rect position, string password, char maskChar)

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.

Returns

Type

Description

stringThe edited password.

Examples

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

PasswordField(Rect, string, char, int)

Make a text field where the user can enter a password.
public static string PasswordField(Rect position, string password, char maskChar, int maxLength)

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.

Returns

Type

Description

stringThe edited password.

Examples

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

PasswordField(Rect, string, char, GUIStyle)

Make a text field where the user can enter a password.
public static string PasswordField(Rect position, string password, char maskChar, GUIStyle style)

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.

The style to use. If left out, the
textField
style from the current GUISkin is used.

Returns

Type

Description

stringThe edited password.

Examples

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

PasswordField(Rect, string, char, int, GUIStyle)

Make a text field where the user can enter a password.
public static string PasswordField(Rect position, string password, char maskChar, int maxLength, GUIStyle style)

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.

The style to use. If left out, the
textField
style from the current GUISkin is used.

Returns

Type

Description

stringThe edited password.

Examples

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