Version: 2021.3
LanguageEnglish
  • C#

PropertyName

struct in UnityEngine

/

Implemented in:UnityEngine.CoreModule

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

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.

Close

Cancel

Description

Represents a string as an int for efficient lookup and comparison. Use this for common PropertyNames.

Internally stores just an int to represent the string. A PropertyName can be created from a string but can not be converted back to a string. The same string always results in the same int representing that string. Thus this is a very efficient string representation in both memory and speed when all you need is comparison.

PropertyName is serializable.

ToString() is only implemented for debugging purposes in the editor it returns "theName:3737" in the player it returns "Unknown:3737".

Constructors

PropertyNameInitializes the PropertyName using a string.

Public Methods

EqualsDetermines whether this instance and a specified object, which must also be a PropertyName object, have the same value.
GetHashCodeReturns the hash code for this PropertyName.
ToStringFor debugging purposes only. Returns the string value representing the string in the Editor. Returns "UnityEngine.PropertyName" in the player.

Static Methods

IsNullOrEmptyIndicates whether the specified PropertyName is an Empty string.

Operators

operator !=Determines whether two specified PropertyName have a different string value.
operator ==Determines whether two specified PropertyName have the same string value. Because two PropertyNames initialized with the same string value always have the same name index, we can simply perform a comparison of two ints to find out if the string value equals.
PropertyNameConverts the string passed into a PropertyName. See Also: PropertyName.ctor(System.String).