Класс: Phaser.SignalBinding
Конструктор
new SignalBinding(signal, listener, isOnce, listenerContext, priority, args)
Объект, представляющий привязку между объектом Signal и функцией-обработчиком.
Это внутренний конструктор и его не следует создавать напрямую.
На основе Joa Ebert AS3 SignalBinding и классов слотов Роберта Пеннера.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
signal | Phaser.Signal | Ссылка на объект Signal, к которому в данный момент привязан обработчик. | ||
listener | function | Функция-обработчик, привязанная к сигналу. | ||
isOnce | boolean | Если привязку следует выполнить только один раз. | ||
listenerContext | object | <optional> | null | Контекст, в котором будет выполнен обработчик (объект, который должен представлять переменную |
priority | number | <optional> | Уровень приоритета обработчика события. (по умолчанию = 0). | |
args | any | <optional> <repeatable> | (none) | Дополнительные аргументы, передаваемые в функцию-обработчик (слушатель). Они будут добавлены после любых обычно передаваемых аргументов. |
- Исходный код: core/SignalBinding.js (Строка 22)
Свойства общего доступа
- Значение по умолчанию
- true
- Исходный код: core/SignalBinding.js (Строка 93)
- Исходный код: core/SignalBinding.js (Строка 86)
- Исходный код: core/SignalBinding.js (Строка 63)
- array | null
- Исходный код: core/SignalBinding.js (Строка 100)
active : boolean
Если привязка активна и должна быть выполнена.
callCount : number
Количество вызовов функции-обработчика.
context : Object
Контекст, в котором будет выполнен обработчик (объект, который должен представлять переменную this внутри функции обработчика).
params :array | null
Параметры по умолчанию, передаваемые обработчику во время Signal.dispatch и SignalBinding.execute (параметры с замыканием).
Тип
Методы общего доступа
- Исходный код: core/SignalBinding.js (Строка 136)
- Исходный код: core/SignalBinding.js (Строка 102)
- Исходный код: core/SignalBinding.js (Строка 162)
- Исходный код: core/SignalBinding.js (Строка 170)
- Исходный код: core/SignalBinding.js (Строка 146)
- Исходный код: core/SignalBinding.js (Строка 154)
- Исходный код: core/SignalBinding.js (Строка 189)
detach() → {function | null}
Отсоединить привязку от сигнала.
Псевдоним для: @see mySignal.remove(myBinding.getListener());
Возвращаемое значение
Функция-обработчик, привязанная к сигналу или null, если привязка была ранее отключена.
execute(paramsArr) → {any}
Вызвать обработчик, передавая произвольные параметры.
Если привязка была добавлена с использованием Signal.addOnce(), она будет автоматически удалена из очереди обработки сигнала, этот метод используется внутренне для обработки сигнала.
Параметры
| Имя | Тип | Аргумент | Описание |
|---|---|---|---|
paramsArr | Array.<any> | <optional> | Массив параметров, которые должны быть переданы обработчику. |
Возвращаемое значение
Значение, возвращаемое обработчиком.
getListener() → {function}
Возвращаемое значение
Функция-обработчик, привязанная к сигналу.
getSignal() → {Phaser.Signal}
Возвращаемое значение
Сигнал, к которому привязан обработчик.
isBound() → {boolean}
Возвращаемое значение
True, если привязка по-прежнему привязана к сигналу и имеет обработчик.
isOnce() → {boolean}
Возвращаемое значение
Если SignalBinding будет выполнен только один раз.
toString() → {string}
Возвращаемое значение
Строковое представление объекта.
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.SignalBinding.html