Счётчик¶
- объект Счётчик; CounterReactor¶
Объект счётчик необходим для подсчёта различных событий, происходящих в приложении. Например, с его помощью можно рассчитывать количество меток, распознаваемых в данный момент, или число нажатий пользователя на кнопку:
Начальное значение¶
Вводится в Счётчик (CounterReactor)
Параметр |
Описание |
|---|---|
Начальное значение. По умолчанию равно 0. |
Событие |
Описание |
|---|---|
Вызывается при сбросе счётчика на Начальное значение (initialValue) (см. действие Сбросить на начальное значение (resetValue)). |
Действие |
Описание |
|---|---|
Сброс счётчика на Начальное значение (initialValue). |
- параметр Начальное значение; initialValue¶
Параметр задаёт начальное значение счётчика. Данное значение нельзя изменить во время работы приложения. Начальное значение определяет, чему будет равно Текущее значение (value) счётчика при старте приложения.
Примечание
В начале работы приложения Текущее значение (value) равно Начальное значение (initialValue). Во время работы приложения Текущее значение (value) меняется, а значение параметра Начальное значение (initialValue) остаётся неизменным, чтобы иметь возможность произвести сброс счётчика.
- событие Значение сброшено; onValueReset¶
Вызывается при сбросе значения счетчика (см. действие Сбросить на начальное значение (resetValue)).
- действие Сбросить на начальное значение; resetValue()¶
Сбросить Текущее значение (value) счётчика на начальное (см. параметр Начальное значение (initialValue)). Возбуждает событие Значение сброшено (onValueReset).
Работа со счётчиком¶
Свойство |
Описание |
|---|---|
Текущее значение. При старте приложения равно Начальное значение (initialValue). Значение можно изменить, см. Установить значение (setValue) |
Основное событие |
Описание |
|---|---|
Вызывается при равенстве Текущее значение (value) заданному. |
|
Вызывается при неравенстве Текущее значение (value) заданному. |
|
Вызывается, когда Текущее значение (value) больше заданного. |
|
Вызывается, когда Текущее значение (value) меньше заданного. |
|
Вызывается, когда Текущее значение (value) принадлежит заданному сегменту. |
|
Вызывается, когда Текущее значение (value) не принадлежит заданному сегменту. |
Специальное событие |
Описание |
|---|---|
Вызывается при добавлении заданного числа (см. действие Прибавить (add)). |
|
Вызывается при вычитании заданного числа (см. действие Вычесть (subtract)). |
|
Вызывается при увеличении текущего значения (см. действие Прибавить (add)). |
|
Вызывается при уменьшении текущего значения (см. действие Вычесть (subtract)). |
Примечание
События разделены на основные и специальные только для наглядности и упрощения документации. Во время разработки и работы с приложением они абсолютно равноправны.
Действие |
Описание |
|---|---|
Прибавить заданное значение. |
|
Вычесть заданное значение. |
|
Установить заданное значение. |
|
Установить случайное значение. |
Примечание
Все события могут быть возбуждены только после вызова какого-либо действия.
- свойство Текущее значение; value¶
Параметр задаёт текущее значение счётчика. При старте приложения оно равно Начальное значение (initialValue). Текущее значение, в отличие от начального значения, можно изменить действием Установить значение (setValue).
- событие Равно; onEqual¶
Вызывается, когда Текущее значение (value) становится равно заданному в параметрах события. Например, параметр события: 5. Событие будет возбуждено, когда Текущее значение (value) счётчика после какого-либо действия станет равным 5.
- Param Значение / value – number:
значение, при котором вызовется событие.
- событие Не равно; onNotEqual¶
Вызывается, когда Текущее значение (value) становится неравно заданному в параметрах события. Например, параметр события: 5. Событие будет возбуждено, когда Текущее значение (value) счётчика после какого-либо действия будет отлично от 5.
- Param Значение / value – number:
значение, при котором вызовется событие.
- событие Больше чем; onGreater¶
Вызывается, когда Текущее значение (value) становится больше заданного в параметрах события.
- Param Значение / value – number:
значение, при котором вызовется событие.
- событие Меньше чем; onLess¶
Вызывается, когда Текущее значение (value) становится меньше заданного в параметрах события.
- Param Значение / value – number:
значение, при котором вызовется событие.
- событие Принадлежит отрезку; onInsideSegment¶
Вызывается, когда Текущее значение (value) принадлежит заданному сегменту, границы которого определены в параметрах события.
- Param От / From – number:
левая граница отрезка.
- Param До / To – number:
правая граница отрезка.
Примечание
Если Текущее значение (value) равно какому-либо граничному значению отрезка (то есть равно левой или правой границе), событие возбуждается.
- событие Не принадлежит отрезку; onOutsideSegment¶
Вызывается, когда Текущее значение (value) не принадлежит заданному сегменту, границы которого определены в параметрах события.
- Param От / From – number:
левая граница отрезка.
- Param До / To – number:
правая граница отрезка.
Примечание
Если Текущее значение (value) равно какому-либо граничному значению отрезка (то есть равно левой или правой границе), событие не возбуждается.
- событие Прибавлено; onAdd¶
Вызывается, когда к Текущее значение (value) прибавляется число, заданное в параметрах события (см. действие Прибавить (add)).
- Param Значение / value – number:
число, при добавлении которого возбуждается событие.
Примечание
При прибавлении числа, отличного от заданного в параметрах действия, данное событие вызвано не будет. Например, параметр события равен 5. При добавлении к Текущее значение (value) числа 6 событие вызвано не будет.
- событие Вычтено; onSubtract¶
Вызывается, когда из Текущее значение (value) вычитают число, заданное в параметре события (см. действие Вычесть (subtract)). Например, параметр события равен 5. При вычитании из Текущее значение (value) числа 6 событие вызвано не будет.
- Param Значение / value – number:
число, при вычитании которого возбуждается событие.
- событие Увеличено; onIncrease¶
Вызывается при увеличении Текущее значение (value). Например, установлено новое значение, которое больше предыдущего.
- событие Уменьшено; onDecrease¶
Вызывается при уменьшении Текущее значение (value). Например при вызове действия Вычесть (subtract).
- действие Прибавить; add(value)¶
Прибавить заданное значение к Текущее значение (value) счётчика. После сложения возбуждаются события: Прибавлено (onAdd) с аргументом, равным параметру
value, затем все основные события, соответствующие заданному аргументу, и в конце Увеличено (onIncrease).- Параметры:
Значение / value – аргумент арифметической операции.
- действие Вычесть; subtract(value)¶
Вычесть заданное значение из Текущее значение (value) счётчика. После вычитания возбуждаются события: Вычтено (onSubtract) с аргументом, равным параметру
value, затем все основные события, соответствующие заданному аргументу, и в конце Уменьшено (onDecrease).- Параметры:
Значение / value – аргумент арифметической операции.
- действие Установить значение; setValue(value)¶
Установить Текущее значение (value) счётчика равным параметру
value. После установки значения возбуждаются все основные события, соответствующие заданному аргументу, и в конце Уменьшено (onDecrease) или Увеличено (onIncrease), в зависимости от установленного аргумента.- Параметры:
Значение / value – новое текущее значение.
- действие Установить случайное значение; setRandomValue(from, to)¶
Установить Текущее значение (value) счётчика равным случайному число, принадлежащему указанному сегменту. Параметры действия задают границы сегмента. После установки значения возбуждаются все основные события, соответствующие заданному аргументу, и в конце Уменьшено (onDecrease) или Увеличено (onIncrease), в зависимости от установленного аргумента.
- Параметры:
От / From – левая граница.
До / To – правая граница.
Advanced¶
Пример кода:
local counter = reactorController:getReactorByName("Counter")
local text = reactorController:getReactorByName("Text")
counter:subscribeEvent("onAdd", function()
text:setText_value(5)
end, 5) -- функция-подписчик вызывается только когда прибавляется 5 к счетчику
counter:add(5)