Руководство API скрипты

Button

класс в UnityEngine.UIElements / Наследует от: UIElements.TextElement / Реализовано в: UnityEngine.UIElementsModule

Описание

Кнопка, на которую можно нажать.

Статические Свойства

ussClassName Имя класса USS элементов этого типа.

Свойства

clickable Clickable MouseManipulator для этой кнопки.

Конструкторы

Button Создает кнопку.

События

clicked Обратный вызов срабатывает при нажатии кнопки. Смотрите так же: Clickable.clicked.
onClick Устаревший. Вместо этого используйте Button.clicked.

Унаследованные члены

Статические Свойства

ussClassName Имя класса USS элементов этого типа.
disabledUssClassName Имя класса USS локальных отключенных элементов.

Свойства

binding Объект привязки, который будет обновлен.
bindingPath Путь к привязываемому целевому свойству.
canGrabFocus Возвращает значение true, если элемент может быть сфокусирован.
delegatesFocus Должен ли элемент делегировать фокус своим дочерним элементам.
focusable True, если элемент может быть сфокусирован..
focusController Вернуть контроллер фокуса для этого элемента.
tabIndex Целое число, используемое для сортировки объектов фокусировки в кольце фокусировки. Должен быть больше или равен нулю.
displayTooltipWhenElided Если установлено значение true, во всплывающей подсказке отображается полная версия пропущенного текста.
isElided Возвращает значение true, если текст пропущен, и значение false в противном случае.
text Текст, связанный с элементом.
childCount Количество дочерних элементов в контейнере содержимого этого объекта
contentContainer К этому элементу добавляются дочерние элементы
customStyle Возвращает метод доступа к свойствам пользовательского стиля для этого элемента.
enabledInHierarchy Возвращает значение true, если VisualElement включен в своей собственной иерархии.
enabledSelf Возвращает значение true, если VisualElement включен локально.
experimental Возвращает экспериментальные интерфейсы UIElements.
generateVisualContent Вызывается, когда необходимо (повторно) сгенерировать визуальное содержимое VisualElement.
hierarchy Доступ к физической иерархии этого элемента
pickingMode Определяет, может ли этот элемент быть выбран во время запросов mouseEvents или IPanel.Pick.
resolvedStyle Возвращает значения разрешенного стиля VisualElement.
schedule Получает IVisualElementScheduler этого VisualElement
style Ссылка на объект стиля этого элемента.
styleSheets Возвращает VisualElementStyleSheetSet, который управляет таблицами стилей, прикрепленными к этому элементу.
this[int] Доступ к физической иерархии этого элемента
tooltip Текст, отображаемый внутри информационного поля после того, как пользователь наведет курсор на элемент в течение небольшого промежутка времени.
usageHints Комбинация значений подсказок, указывающих предполагаемые шаблоны использования высокого уровня для VisualElement.
Это свойство можно задать только в том случае, если VisualElement еще не является частью панели. Будучи частью Panel, это свойство фактически становится доступным только для чтения, и попытки изменить его вызовут исключение. Спецификация надлежащих UsageHints побуждает систему принимать более эффективные решения о том, как обрабатывать или ускорять определенные операции на основе ожидаемого шаблона использования. Обратите внимание, что эти подсказки не влияют на поведенческие или визуальные результаты, а влияют только на общую производительность панели и элементов внутри.
Как правило, рекомендуется всегда рассматривать вопрос об указании правильных UsageHints, но имейте в виду, что некоторые UsageHints могут игнорироваться внутри при определенных условиях (например, из-за аппаратных ограничений на целевой платформе).
userData Это свойство можно использовать для связывания пользовательских данных приложения с этим VisualElement.
viewDataKey Используется для сохранения данных представления (т. е. развернутых состояний дерева, положения прокрутки, уровня масштабирования).

Публичные Методы

HandleEvent Обработка события, чаще всего путем выполнения обратных вызовов, связанных с событием.
HasBubbleUpHandlers Возвращает значение true, если к этому объекту прикреплены обработчики событий для этапа распространения события BubbleUp.
HasTrickleDownHandlers Возвращает значение true, если к этому объекту присоединены обработчики событий для этапа распространения события TrickleDown.
RegisterCallback Добавляет обработчик событий к экземпляру. Если обработчик события уже зарегистрирован для той же фазы (TrickleDown или BubbleUp), то этот метод не действует.
SendEvent Отправляет событие обработчику событий.
UnregisterCallback Удаляет обратный вызов из экземпляра.
Blur Указывает элементу снять фокус.
Focus Пробует передать фокус этому элементу.
MeasureTextSize Вычисляет размер, необходимый для отображения текстовой строки, на основе значений стиля элемента, таких как шрифт, размер шрифта, перенос слов и т. д.
Add Добавляет элемент в контейнер содержимого этого элемента
BringToFront Помещает этот элемент в конец списка родительских дочерних элементов. Элемент будет визуально находиться перед любыми перекрывающимися одноуровневыми элементами.
Children Возвращает элементы из контейнера содержимого
Clear Удаляет все дочерние элементы из контейнера содержимого этого элемента
Contains Возвращает значение true, если элемент является прямым дочерним элементом этого VisualElement
ElementAt Извлекает дочерний элемент в позиции
EnableInClassList Включает или отключает класс с заданным именем.
FindAncestorUserData Выполняет поиск в иерархии этого VisualElement и извлекает сохраненные данные пользователя, если они найдены.
FindCommonAncestor Находит наименьшего общего предка между двумя элементами VisualElements внутри иерархии VisualTree
GetClasses Получает классы для этого элемента.
GetFirstAncestorOfType Проходит вверх по иерархии, начиная с родительского элемента, и возвращает первый VisualElement этого типа
GetFirstOfType Проходит вверх по иерархии, начиная с этого элемента, и возвращает первый VisualElement этого типа
IndexOf Получает дочерний индекс указанного VisualElement.
Insert Вставляет элемент в контейнер содержимого этого элемента
MarkDirtyRepaint Запускает перерисовку VisualElement в следующем кадре.
PlaceBehind Помещает этот элемент прямо перед родственным элементом в их родительском списке дочерних элементов. Если элемент и позиция родственного элемента перекрываются, элемент будет визуально позади своего родственного элемента.
PlaceInFront Помещает этот элемент сразу после родственного элемента в списке родительских дочерних элементов. Если элемент и позиция родственного элемента перекрываются, элемент будет визуально впереди своего родственного элемента.
Remove Удаляет этот дочерний элемент из иерархии
RemoveAt Удалить дочерний элемент, расположенный в этой позиции, из контейнера содержимого этого элемента
RemoveFromHierarchy Удаляет этот элемент из его родительской иерархии
SendEvent Отправляет событие обработчику событий.
SendToBack Отправляет этот элемент в начало списка его родительских дочерних элементов. Элемент будет визуально находиться за любыми перекрывающимися одноуровневыми элементами.
SetEnabled Изменяет состояние включения VisualElement. Отключенный VisualElement не получает большинство событий.
Sort Переупорядочивает дочерние элементы из содержимого контейнера VisualElement.
ToggleInClassList Переключение между добавлением и удалением заданного имени класса из списка классов.
Вы можете отблагодарить автора, за перевод документации на русский язык. Донат
API скрипты 2021.3