PropertyHint

Cases

• case none

  The property has no hint for the editor.

• case range

  Hints that an integer or float property should be within a range specified via the hint string "min,max" or "min,max,step". The hint string can optionally include "or_greater" and/or "or_less" to allow manual input going respectively above the max or below the min values.

• case `enum`

  Hints that an integer or String property is an enumerated value to pick in a list specified via a hint string.

• case enumSuggestion

  Hints that a String property can be an enumerated value to pick in a list specified via a hint string such as "Hello,Something,Else".

• case expEasing

  Hints that a float property should be edited via an exponential easing function. The hint string can include "attenuation" to flip the curve horizontally and/or "positive_only" to exclude in/out easing and limit values to be greater than or equal to zero.

• case link

  Hints that a vector property should allow its components to be linked. For example, this allows x and y to be edited together.

• case flags

  Hints that an integer property is a bitmask with named bit flags.

• case layers2dRender

  Hints that an integer property is a bitmask using the optionally named 2D render layers.

• case layers2dPhysics

  Hints that an integer property is a bitmask using the optionally named 2D physics layers.

• case layers2dNavigation

  Hints that an integer property is a bitmask using the optionally named 2D navigation layers.

• case layers3dRender

  Hints that an integer property is a bitmask using the optionally named 3D render layers.

• case layers3dPhysics

  Hints that an integer property is a bitmask using the optionally named 3D physics layers.

• case layers3dNavigation

  Hints that an integer property is a bitmask using the optionally named 3D navigation layers.

• case layersAvoidance

  Hints that an integer property is a bitmask using the optionally named avoidance layers.

• case file

  Hints that a String property is a path to a file. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like "*.png,*.jpg".

• case dir

  Hints that a String property is a path to a directory. Editing it will show a file dialog for picking the path.

• case globalFile

  Hints that a String property is an absolute path to a file outside the project folder. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards, like "*.png,*.jpg".

• case globalDir

  Hints that a String property is an absolute path to a directory outside the project folder. Editing it will show a file dialog for picking the path.

• case resourceType

  Hints that a property is an instance of a Resource-derived type, optionally specified via the hint string (e.g. "Texture2D"). Editing it will show a popup menu of valid resource types to instantiate.

• case multilineText

  Hints that a String property is text with line breaks. Editing it will show a text input field where line breaks can be typed.

• case expression

  Hints that a String property is an Expression.

• case placeholderText

  Hints that a String property should show a placeholder text on its input field, if empty. The hint string is the placeholder text to use.

• case colorNoAlpha

  Hints that a Color property should be edited without affecting its transparency (Color/a is not editable).

• case objectId

  Hints that the property’s value is an object encoded as object ID, with its type specified in the hint string. Used by the debugger.

• case typeString

  If a property is String, hints that the property represents a particular type (class). This allows to select a type from the create dialog. The property will store the selected type as a string.

• case nodePathToEditedNode

  Deprecated. This hint is not used anywhere and will be removed in the future.

• case objectTooBig

  Hints that an object is too big to be sent via the debugger.

• case nodePathValidTypes

  Hints that the hint string specifies valid node types for property of type NodePath.

• case saveFile

  Hints that a String property is a path to a file. Editing it will show a file dialog for picking the path for the file to be saved at. The dialog has access to the project’s directory. The hint string can be a set of filters with wildcards like "*.png,*.jpg". See also filters.

• case globalSaveFile

  Hints that a String property is a path to a file. Editing it will show a file dialog for picking the path for the file to be saved at. The dialog has access to the entire filesystem. The hint string can be a set of filters with wildcards like "*.png,*.jpg". See also filters.

• case intIsObjectid

  Hints that an integer property is an object ID.

• case intIsPointer

  Hints that an integer property is a pointer. Used by GDExtension.

• case arrayType

  Hints that a property is an GArray with the stored type specified in the hint string.

• case localeId

  Hints that a string property is a locale code. Editing it will show a locale dialog for picking language and country.

• case localizableString

  Hints that a dictionary property is string translation map. Dictionary keys are locale codes and, values are translated strings.

• case nodeType

  Hints that a property is an instance of a Node-derived type, optionally specified via the hint string (e.g. "Node2D"). Editing it will show a dialog for picking a node from the scene.

• case hideQuaternionEdit

  Hints that a quaternion property should disable the temporary euler editor.

• case password

  Hints that a string property is a password, and every character is replaced with the secret character.

• case max

  Represents the size of the PropertyHint enum.