Skip to content

components.NumberInput

vasili.kostin edited this page Aug 22, 2021 · 11 revisions

компоненты : Иконка компонента NumberInput

Наследуется от Container, и включает в себя все его свойства.

NumberInput - интерактивный компонент, обеспечивающий ввод игроком числа без использования клавиатуры. Ввод производится перетаскиванием счетчика вверх/вниз, прокруткой колесом мыши, или кнопками увеличения/уменьшения, привязанными к методам increase, decrease NumberInput объекта. NumberInput хранит текущее числовое значение в javascript переменной указанной разработчиком.

Редактируемые свойства:

value

Тип: Number

Текущее значение.


max

Тип: Number

Максимальное значение.


min

Тип: Number

Минимальное значение.


step

Тип: Number

Шаг изменения значения.


decimalsCount

Тип: Number

Количество отображаемых десятичных нулей.


textView

Тип: String

Имя префаба, который будет задавать внешний вид числового значения. Для создания эффекта прокрутки, NumberInput создает несколько Text объектов, и использует их для отображения числового значения на экран. textView позволяет подменить обычный Text на префаб, имеющий заданное разработчиком оформление. При этом в префабе должен содержаться как минимум один Text объект, который будет использоваться для отображения числа.


dataPath

Тип: data-path

Данное поле указывает путь к переменной javascript (либо путь к свойству объекта на экране), которая будет выступать в качестве значения, изменяемого пользователем. Подробнее о путях к переменным: Data-Path редактор Поле dataPath может быть пустым, тогда текущее значение будет доступно только через свойство value


refreshInterval

Тип: Number

Интервал в кадрах (60 кадров равно 1 секунде), задающий периодичность проверки переменной, указанной в dataPath. И обновления значения счетчика в случае ее изменения.


onChanged

Тип: call

Поле, позволяющее привязать действие, которое будет вызываться при изменении значения NumberInput. Подробнее см. Callback редактор


valuesList

Тип: String

Указанный через запятую, фиксированный набор числовых значений, доступных для ввода игроком.


wrapValue

Тип: Boolean

Включение этого свойства в true, зацикливает вводимое игроком число.


Свойства доступные из Javascript:

canDecrease

Тип: Boolean

Возвращает true, если увеличение значения счетчика возможно. Если включена зацикленность счетчика wrapValue, то canDecrease всегда возвращает true.


canIncrease

Тип: Boolean

Возвращает true, если уменьшение значения счетчика возможно. Если включена зацикленность счетчика wrapValue, то canIncrease всегда возвращает true.


canDecreaseVisual

Тип: Boolean

Возвращает true, если увеличение значения счетчика возможно, при этом учитывается доступность самого NumberInput объекта для игрока (isCanBePressed).


canIncreaseVisual

Тип: Boolean

Возвращает true, если уменьшение значения счетчика возможно, при этом учитывается доступность самого NumberInput объекта для игрока (isCanBePressed).



Методы:

increase ()

Увеличивает текущее значение.


decrease ()

Уменьшает текущее значение.


setValuesList (valuesArray : Array<Number>)

Метод позволяет переопределить набор значений, доступных для ввода игроком.


formatValue (val)

возвращаемое значение: String

Этот метод полезен при создании собственных компонентов, наследующихся от NumberInput. Переопределение этого метода позволяет добавить свою обработку для значения перед его выводом на кран. Например, выводить вместо числовых значений произвольный текст, или знак бесконечности вместо нуля.


setValue (val : Number)

Устанавливает текущее значение.


resetValue ()

Сбрасывает текущее значение к значению по умолчанию.


refreshNow ()

Обновляет значение счетчика из переменной указанной в dataPath игнорируя refreshInterval.


<- Предыдущая страница Следующая страница ->

Связанные темы:

Data-Path редактор

Библиотека префабов

Свойства, унаследованные от Container

Компоненты

Редактируемые поля

Clone this wiki locally