reckfellENGINE

PropertyHint

Перечисление C#.

На этой странице
enum PropertyHintReckfellSharpНаследует Enum

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Поля и константы46

ArrayTypeПоле
# ArrayType
C#
ArrayType = 31

Указывает, что свойство представляет собой Reckfell.Collections.Array с сохраненным типом, указанным в строке подсказки. Строка подсказки содержит тип массива (например, "String"). Используйте формат строки подсказки из PROPERTY_HINT_TYPE_STRING для большего контроля над сохраненным типом.

AudioBusПоле
# AudioBus
C#
AudioBus = 45

Помехи, что string или StringName Это позволяет выбирать предопределенные названия автобусов, зарегистрированные на аудиосервере.

ColorNoAlphaПоле
# ColorNoAlpha
C#
ColorNoAlpha = 21

Подсказка о том, что свойство Color следует редактировать, не влияя на его прозрачность (Color.A не подлежит редактированию).

DictionaryTypeПоле
# DictionaryType
C#
DictionaryType = 38

Указывает, что свойство представляет собой Reckfell.Collections.Dictionary с сохраненными типами, указанными в строке подсказки. Строка подсказки содержит типы ключа и значения, разделенные точкой с запятой (например, "int;String"). Используйте формат строки подсказки из PROPERTY_HINT_TYPE_STRING для большего контроля над сохраненными типами.

DirПоле
# Dir
C#
Dir = 14

Указывает, что свойство string — это путь к каталогу. При его редактировании откроется диалоговое окно файла для выбора пути.

EntityPathToEditedNodeПоле
# EntityPathToEditedNode
C#
EntityPathToEditedNode = 24
EntityPathValidTypesПоле
# EntityPathValidTypes
C#
EntityPathValidTypes = 26

Подсказка о том, что строка подсказки указывает допустимые типы узлов для свойства типа EntityPath.

EnumПоле
# Enum
C#
Enum = 2

Подсказка указывает, что свойство типа string или StringName представляет собой перечисляемое значение, которое нужно выбрать из списка, указанного в строке подсказки. Строка подсказки представляет собой список имен, разделенных запятыми, например, "Hello,Something,Else". Пробелы не удаляются с обоих концов имени. Для целочисленных свойств первое имя в списке имеет значение 0, следующее — 1 и так далее. Явные значения также можно указать, добавив к имени :integer, например, "Zero,One,Three:3,Four,Six:6".

EnumSuggestionПоле
# EnumSuggestion
C#
EnumSuggestion = 3

Подсказка указывает, что свойство типа string или StringName может представлять собой перечисляемое значение, которое можно выбрать из списка, указанного в строке подсказки, например, "Hello,Something,Else". Подробнее см. PROPERTY_HINT_ENUM. В отличие от PROPERTY_HINT_ENUM, свойство с этой подсказкой по-прежнему принимает произвольные значения и может быть пустым. Список значений служит для предложения возможных значений.

ExpEasingПоле
# ExpEasing
C#
ExpEasing = 4

Указывает на то, что свойство типа [float] следует редактировать с помощью редактора кривых, отображающего функцию экспоненциального сглаживания. Строка подсказки может включать "attenuation" для горизонтального переворота кривой и/или "positive_only" для исключения сглаживания на входе/выходе и ограничения значений значением больше или равным нулю. Это отображается иначе, чем свойство, использующее PROPERTY_HINT_RANGE с ключевым словом "exp", поскольку оно редактируется ползунком, а не редактором кривых.

ExpressionПоле
# Expression
C#
Expression = 19

Указывает, что свойство string является Expression.

FileПоле
# File
C#
File = 13

Подсказка, что свойство string представляет собой путь к файлу. При его редактировании откроется диалоговое окно для выбора пути. Строка подсказки может представлять собой набор фильтров с подстановочными знаками, например, "*.png,*.jpg". По умолчанию файл будет сохранён как UID (если он доступен). Вы можете использовать методы ResourceUid, чтобы преобразовать его обратно в путь. Для сохранения необработанного пути используйте PROPERTY_HINT_FILE_PATH.

FilePathПоле
# FilePath
C#
FilePath = 44

Аналогично PROPERTY_HINT_FILE, но свойство хранится как необработанный путь, а не UID. Это означает, что ссылка будет повреждена при перемещении файла. По возможности используйте PROPERTY_HINT_FILE.

FlagsПоле
# Flags
C#
Flags = 6

Подсказка указывает, что свойство типа [int] представляет собой битовую маску с именованными битовыми флагами. Строка подсказки представляет собой список имен, разделенных запятыми, например, "Bit0,Bit1,Bit2,Bit3". Пробелы не удаляются с обоих концов имени. Первое имя в списке имеет значение 1, следующее — 2, затем 4, 8, 16 и так далее. Явные значения также можно указать, добавив к имени :integer, например, "A:4,B:8,C:16". Вы также можете комбинировать несколько флагов ("A:4,B:8,AB:12,C:16"). Примечание: Значение флага должно быть не менее 1 и не более 2 ** 32 - 1. Примечание: В отличие от PROPERTY_HINT_ENUM, предыдущее явное значение не учитывается. Для подсказки "A:16,B,C" A равно 16, B равно 2, C равно 4.

GlobalDirПоле
# GlobalDir
C#
GlobalDir = 16

Указывает, что свойство string — это абсолютный путь к каталогу вне папки проекта. При его редактировании откроется диалоговое окно файла для выбора пути.

GlobalFileПоле
# GlobalFile
C#
GlobalFile = 15

Указывает, что свойство string является абсолютным путем к файлу вне папки проекта. При его редактировании откроется диалоговое окно для выбора пути. Подсказка может быть набором фильтров с подстановочными знаками, например "*.png,*.jpg".

GlobalSaveFileПоле
# GlobalSaveFile
C#
GlobalSaveFile = 28

Подсказка, что свойство string является путем к файлу. При его редактировании откроется диалоговое окно для выбора пути сохранения файла. Диалоговое окно имеет доступ ко всей файловой системе. Строка подсказки может быть набором фильтров с подстановочными знаками, например "*.png,*.jpg". См. также FileDialog.Filters.

GroupEnableПоле
# GroupEnable
C#
GroupEnable = 42

Указывает, что логическое свойство включит функцию, связанную с группой, в которой оно встречается. Свойство будет отображаться в виде флажка в заголовке группы. Работает только внутри группы или подгруппы. По умолчанию отключение свойства скрывает все свойства в группе. Используйте необязательную строку подсказки "checkbox_only", чтобы отключить это поведение.

HideQuaternionEditПоле
# HideQuaternionEdit
C#
HideQuaternionEdit = 35

Подсказка о том, что свойство кватерниона должно отключать временный редактор Эйлера.

InputNameПоле
# InputName
C#
InputName = 43

Помехи, что string или StringName - название вводимого действия. Это позволяет выбрать любое имя действия из Input Карта в параметрах проекта. Строка подсказки может содержать два варианта, разделенные запятыми:

  • Если он содержит "show_builtin", включенные в систему вводные данные включаются в выборку.
  • Если он содержит "loose_mode", свободный режим включен. Это позволяет вводить любое имя действия, даже если оно не присутствует на входных картах.
IntIsObjectidПоле
# IntIsObjectid
C#
IntIsObjectid = 29
IntIsPointerПоле
# IntIsPointer
C#
IntIsPointer = 30

Подсказывает, что свойство [int] является указателем. Используется ReckfellExtension.

Layers2DNavigationПоле
# Layers2DNavigation
C#
Layers2DNavigation = 9

Указывает, что свойство [int] является битовой маской, использующей необязательно именованные слои 2D-навигации.

Layers2DPhysicsПоле
# Layers2DPhysics
C#
Layers2DPhysics = 8

Указывает, что свойство [int] является битовой маской, использующей необязательно именованные 2D-физические слои.

Layers2DRenderПоле
# Layers2DRender
C#
Layers2DRender = 7

Указывает, что свойство [int] является битовой маской, использующей необязательно именованные слои 2D-рендеринга.

Layers3DNavigationПоле
# Layers3DNavigation
C#
Layers3DNavigation = 12

Указывает, что свойство [int] является битовой маской, использующей необязательно именованные слои 3D-навигации.

СОБЛЮДЕНИЕ

Layers3DPhysicsПоле
# Layers3DPhysics
C#
Layers3DPhysics = 11

Указывает, что свойство [int] является битовой маской, использующей необязательно именованные слои 3D-физики.

Layers3DRenderПоле
# Layers3DRender
C#
Layers3DRender = 10

Указывает, что свойство [int] является битовой маской, использующей необязательно именованные слои 3D-рендеринга.

LayersAvoidanceПоле
# LayersAvoidance
C#
LayersAvoidance = 37

Указывает, что целочисленное свойство является битовой маской, используя необязательно именованные слои избегания в навигации.

LinkПоле
# Link
C#
Link = 5

Указывает на то, что свойство вектора должно позволять связывать его компоненты. Например, это позволяет редактировать Vector2.X и Vector2.Y одновременно. Эта подсказка поддерживается для Vector2, Vector2I, Vector3, Vector3I, Vector4 и Vector4I. Строка подсказки может использоваться для указания суффикса, обозначающего единицу измерения каждого значения, с помощью синтаксиса "suffix:px/s".

СОБЛЮДЕНИЕ

LocaleIdПоле
# LocaleId
C#
LocaleId = 32

Подсказки, что строковое свойство — это код локали. При его редактировании откроется диалоговое окно локали для выбора языка и страны.

LocalizableStringПоле
# LocalizableString
C#
LocalizableString = 33

Подсказки о том, что словарь - это карта перевода струн. Dictionary Ключи - это локальные коды, а значения - транслируемые строки.

MaxПоле
# Max
C#
Max = 46

Представляет размер перечисления PropertyHint.

MultilineTextПоле
# MultilineText
C#
MultilineText = 18

Подсказка указывает, что свойство string содержит текст с переносами строк. При его редактировании появится текстовое поле ввода, куда можно вводить переносы строк. Строку подсказки можно установить на "monospace", чтобы принудительно использовать моноширинный шрифт в поле ввода. Если задана строка подсказки "no_wrap", поле ввода не будет переносить строки по границам, вместо этого область будет прокручиваться.

NodeTypeПоле
# NodeType
C#
NodeType = 34

Подсказки, что свойство является экземпляром типа, производного от Entity, опционально указываемого через строку подсказки (например, "Entity2D"). При его редактировании отобразится диалоговое окно для выбора узла из сцены.

NoneПоле
# None
C#
None = 0

Для данного свойства нет подсказки для редактора. Однако строка подсказки всё равно считывается, и её можно использовать для указания суффикса для свойства, не имеющего ограничения диапазона (см. описание константы PROPERTY_HINT_RANGE).

СОБЛЮДЕНИЕ

ObjectIdПоле
# ObjectId
C#
ObjectId = 22

Указывает, что значение свойства - это объект, представленный как ID объекта, тип которого указан в строке подсказки. Используется отладчиком.

ObjectTooBigПоле
# ObjectTooBig
C#
ObjectTooBig = 25

Указывает, что обьект слишком большой для отправки через отладчик.

OneshotПоле
# Oneshot
C#
Oneshot = 40

Подсказки о том, что свойство будет изменено само по себе после настройки, например AudioStreamPlayer.Playing или GpuParticles3D.Emitting.

PasswordПоле
# Password
C#
Password = 36

Указывает, что строковое свойство является паролем и каждый символ заменяется секретным символом.

PlaceholderTextПоле
# PlaceholderText
C#
PlaceholderText = 20

Указывает, что свойство string должно отображать текст-заполнитель в своем поле ввода, если оно пустое. Строка подсказки — это текст-заполнитель для использования.

RangeПоле
# Range
C#
Range = 1

Подсказка указывает, что свойство типа Reckfell.Collections.Array, содержащий типы [int] или [float], должно находиться в диапазоне, указанном в строке подсказки "min,max" или "min,max,step". Строка подсказки может дополнительно включать "or_greater" и/или "or_less", чтобы разрешить ручной ввод значений, превышающих или не превышающих минимальное значение соответственно. Пример: "-360,360,1,or_greater,or_less". Кроме того, можно добавить другие ключевые слова: "exp" для редактирования диапазона в экспоненциальных значениях, "radians_as_degrees" для редактирования углов в радианах в градусах (значения диапазона также указываются в градусах), "degrees" для указания угла, "prefer_slider" для отображения ползунка для целых чисел, "hide_control" для скрытия ползунка или стрелок вверх-вниз и "suffix:px/s" для отображения суффикса, указывающего единицу измерения значения (например, px/s для пикселей в секунду).

ResourceTypeПоле
# ResourceType
C#
ResourceType = 17

Указывает, что свойство является экземпляром типа, производного от Resource, опционально указываемого через строку подсказки (например, "Texture2D"). При его редактировании отобразится всплывающее меню допустимых типов ресурсов для создания экземпляра.

SaveFileПоле
# SaveFile
C#
SaveFile = 27

Подсказка, что свойство string является путем к файлу. При его редактировании откроется диалоговое окно для выбора пути сохранения файла. Диалоговое окно имеет доступ к каталогу проекта. Строка подсказки может быть набором фильтров с подстановочными знаками, например "*.png,*.jpg". См. также FileDialog.Filters.

ToolButtonПоле
# ToolButton
C#
ToolButton = 39

Подсказки, что свойство Callable должно отображаться как кнопка, на которую можно нажать. При нажатии кнопки вызывается вызываемый объект. Строка подсказки указывает текст кнопки и, при необходимости, значок из типа темы "EditorIcons".

Текст
"Click me!" - A button with the text "Click me!" and the default "Callable" icon.
"Click me!,ColorRect" - A button with the text "Click me!" and the "ColorRect" icon.

Примечание: Callable не может быть правильно сериализован (serialized) и сохранен в файле, поэтому рекомендуется использовать PROPERTY_USAGE_EDITOR вместо PROPERTY_USAGE_DEFAULT.

TypeStringПоле
# TypeString
C#
TypeString = 23

Если свойство имеет тип string, подсказывает, что оно представляет определённый тип (класс). Это позволяет выбирать тип из диалога создания. Свойство будет хранить выбранный тип в виде строки. Если свойство имеет тип Reckfell.Collections.Array, подсказывает редактору, как отображать элементы. В hint_string вложенные типы должны кодироваться с помощью ":" и "/". Если свойство имеет тип Reckfell.Collections.Dictionary, подсказывает редактору, как отображать элементы. hint_string формируется так же, как для Reckfell.Collections.Array, но ключ и значение разделяются символом ";".

C#
// Array of elemType.
hintString = $"{elemType:D}:";
hintString = $"{elemType:D}/{elemHint:D}:{elemHintString}";
// Two-dimensional array of elemType (array of arrays of elemType).
hintString = $"{Variant.Type.Array:D}:{elemType:D}:";
hintString = $"{Variant.Type.Array:D}:{elemType:D}/{elemHint:D}:{elemHintString}";
// Three-dimensional array of elemType (array of arrays of arrays of elemType).
hintString = $"{Variant.Type.Array:D}:{Variant.Type.Array:D}:{elemType:D}:";
hintString = $"{Variant.Type.Array:D}:{Variant.Type.Array:D}:{elemType:D}/{elemHint:D}:{elemHintString}";

Примеры:

C#
hintString = $"{Variant.Type.Int:D}/{PropertyHint.Range:D}:1,10,1"; // Array of integers (in range from 1 to 10).
hintString = $"{Variant.Type.Int:D}/{PropertyHint.Enum:D}:Zero,One,Two"; // Array of integers (an enum).
hintString = $"{Variant.Type.Int:D}/{PropertyHint.Enum:D}:Zero,One,Three:3,Six:6"; // Array of integers (an enum).
hintString = $"{Variant.Type.String:D}/{PropertyHint.File:D}:*.png"; // Array of strings (file paths).
hintString = $"{Variant.Type.Object:D}/{PropertyHint.ResourceType:D}:Texture2D"; // Array of textures.

hintString = $"{Variant.Type.Array:D}:{Variant.Type.Float:D}:"; // Two-dimensional array of floats.
hintString = $"{Variant.Type.Array:D}:{Variant.Type.String:D}/{PropertyHint.MultilineText:D}:"; // Two-dimensional array of multiline strings.
hintString = $"{Variant.Type.Array:D}:{Variant.Type.Float:D}/{PropertyHint.Range:D}:-1,1,0.1"; // Two-dimensional array of floats (in range from -1 to 1).
hintString = $"{Variant.Type.Array:D}:{Variant.Type.Object:D}/{PropertyHint.ResourceType:D}:Texture2D"; // Two-dimensional array of textures.

Примечание: Завершающее двоеточие обязательно для корректного определения встроенных типов.

Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.