xButton.GetState

number xButton.GetState (

Описание

Возвращает состояние отпущена/нажата (up/down) объекта хКнопка (xButton).

Примечание: Это действие работает только на переключающихся хКнопках. Можно установить тип объекта хКнопка (xButton) (обычная/переключающаяся standard/toggle) изменением параметра Style в свойствах объекта хКнопка. Обычная (стандартная) хКнопка будет всегда возвращать состояние "отпущена - up".

Параметры

ObjectName

(строка) Имя объекта хКнопка (xButton).

Возврат

ResultVariable

(число) Текущее состояние объекта хКнопка (xButton):

КОНСТАНТА CONSTANT	ЗНАЧЕНИЕ VALUE	ОПИСАНИЕ DESCRIPTION
BTN_UP	0	хКнопка (xButton) в верхнем положении (отпущена).
BTN_DOWN	1	хКнопка (xButton) в нижнем положении (нажата).

Если случается ошибка, возвращается значение -1. Можно использовать действие Application.GetLastError для определения случился ли отказ в работе этого действия и почему.

При добавлении действия из редактора скрипта, можно использовать это поле для определения переменной, которая возвращает значение, сохраняющееся в ней.

Смотрите также: Связанные действия

Примеры

Пример 1

Mustard = xButton.GetState("Mustard Valve");

Получаем текущее состояние объекта хКнопка "Mustard Valve" и сохраняем результат в переменной Mustard.

Пример 2

music_on = xButton.GetState("Music Toggle");

Получаем текущее состояние объекта хКнопка "Music Toggle" и сохраняем результат (0 или 1) в переменной music_on.

Смотрите также: Связанные действия