Spec-Zone.ru › Phaser

Класс: Phaser.DeviceButton

Конструктор

new DeviceButton(parent, buttonCode)

DeviceButtons относятся к экземплярам Phaser.Pointer и Phaser.SinglePad (Gamepad).

Для указателей они представляют собой различные кнопки, которые могут существовать на мышах и стилусах, такие как левая кнопка, правая кнопка,
средняя кнопка и расширенные кнопки, такие как «назад» и «вперед».

Доступ к ним осуществляется через Pointer.leftbutton, Pointer.rightButton и т. д.

На геймпадах они представляют все кнопки на джойстике: от кнопок на плечах до функциональных кнопок.

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

  • В Windows, если вы установите драйвер мыши, и его утилита позволяет настраивать действия кнопок
    (например, IntelliPoint и SetPoint), средняя (колесо) кнопка, 4-я и 5-я кнопки могут не быть установлены,
    даже при нажатии.
  • В Linux (GTK) 4-я и 5-я кнопки не поддерживаются.
  • В Mac OS X 10.5 нет платформенного API для реализации каких-либо расширенных кнопок.
Параметры
Имя Тип Описание
parent Phaser.Pointer | Phaser.SinglePad

Ссылка на родительский элемент этой кнопки. Либо указатель, либо геймпад.

buttonCode число

Код кнопки, за который отвечает этот DeviceButton.

Исходный код: input/DeviceButton.js (Строка 31)

Свойства

altKey : boolean

Истина, если клавиша Alt была нажата при последнем нажатии или отпускании этой кнопки.
Не поддерживается на геймпадах.

Исходный код: input/DeviceButton.js (Строка 87)

buttonCode : число

Код кнопки на геймпаде или значение события DOM для указателя.

Исходный код: input/DeviceButton.js (Строка 114)

ctrlKey : boolean

Истина, если клавиша Ctrl была нажата при последнем нажатии или отпускании этой кнопки.
Не поддерживается на геймпадах.

Исходный код: input/DeviceButton.js (Строка 103)

[только для чтения] duration : число

Время удерживания кнопки в миллисекундах.
Если кнопка не нажата, возвращает -1.

Исходный код: input/DeviceButton.js (Строка 300)

event : Объект

Событие DOM, вызвавшее изменение состояния кнопки.

Исходный код: input/DeviceButton.js (Строка 47)

game : Phaser.Game

Ссылка на запущенную игру.

Исходный код: input/DeviceButton.js (Строка 41)

isDown : boolean

Состояние нажатия кнопки.

Исходный код: input/DeviceButton.js (Строка 53)

isUp : boolean

Состояние отпускания кнопки.

Значение по умолчанию
  • true
Исходный код: input/DeviceButton.js (Строка 59)

onDown : Phaser.Signal

Этот сигнал отправляется каждый раз, когда эта DeviceButton нажата.
Отправляется только один раз (до тех пор, пока кнопка не отпущена).
При отправке он передает 2 аргумента: ссылку на эту DeviceButton и значение кнопки.

Исходный код: input/DeviceButton.js (Строка 122)

onFloat : Phaser.Signal

Только для геймпадов.
Этот сигнал отправляется каждый раз, когда значение плавания этой DeviceButton изменяется (между, но не точно, 0 и 1).
При отправке он передает 2 аргумента: ссылку на эту DeviceButton и значение кнопки.

Исходный код: input/DeviceButton.js (Строка 138)

onUp : Phaser.Signal

Этот сигнал отправляется каждый раз, когда эта DeviceButton отпущена.
Отправляется только один раз (до тех пор, пока кнопка не нажата снова).
При отправке он передает 2 аргумента: ссылку на эту DeviceButton и значение кнопки.

Исходный код: input/DeviceButton.js (Строка 130)

parent : Phaser.Pointer | Phaser.SinglePad

Ссылка на указатель или геймпад, которому принадлежит эта кнопка.

Тип
  • Phaser.Pointer | Phaser.SinglePad
Исходный код: input/DeviceButton.js (Строка 36)

repeats : число

Только для геймпадов.
Если кнопка удерживается, это число показывает количество повторов нажатия кнопки.

Исходный код: input/DeviceButton.js (Строка 79)

shiftKey : boolean

Истина, если клавиша Shift была нажата при последнем нажатии или отпускании этой кнопки.
Не поддерживается на геймпадах.

Исходный код: input/DeviceButton.js (Строка 95)

timeDown : число

Отметка времени последнего нажатия кнопки.

Исходный код: input/DeviceButton.js (Строка 65)

timeUp : число

Отметка времени последнего отпускания кнопки.

Исходный код: input/DeviceButton.js (Строка 71)

value : число

Значение кнопки. В основном полезно для проверки аналоговых кнопок (например, спусковых крючков) на геймпадах.

Исходный код: input/DeviceButton.js (Строка 109)

Методы

destroy()

Уничтожает эту DeviceButton, удаляя сигналы onDown, onUp и onFloat
и очищая ссылки на родителя и игру.

Исходный код: input/DeviceButton.js (Строка 279)

justPressed(duration) → {boolean}

Возвращает состояние «только что нажато» для этой кнопки.
Состояние «только что нажато» считается истинным, если кнопка была нажата в течение указанного интервала времени (по умолчанию 250 мс).

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
duration number <optional>
250

Время в мс, в течение которого кнопка считается нажатой.

Возвращает
boolean -

Истина, если кнопка только что нажата, иначе ложь.

Исходный код: input/DeviceButton.js (Строка 228)

justReleased(duration) → {boolean}

Возвращает состояние «только что отпущена» для этой кнопки.
Состояние «только что отпущена» считается истинным, если кнопка была отпущена в течение заданного интервала времени (по умолчанию 250 мс).

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
duration number <optional>
250

Время в мс, в течение которого кнопка считается только что отпущенной.

Возвращает
boolean -

Истина, если кнопка только что отпущена, иначе ложь.

Исходный код: input/DeviceButton.js (Строка 244)

<internal> padFloat(value)

Вызывается автоматически классом Phaser.SinglePad.

Параметры
Имя Тип Описание
value number

Значение кнопки

Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: input/DeviceButton.js (Строка 213)

reset()

Сбрасывает состояние этой DeviceButton, переводит ее в состояние isUp и сбрасывает счетчики интервала и повторов.

Исходный код: input/DeviceButton.js (Строка 260)

<internal> start(event, value)

Вызывается автоматически Phaser.Pointer и Phaser.SinglePad.
Обрабатывает состояние нажатия кнопки.

Параметры
Имя Тип Аргумент Описание
event object <optional>

Событие DOM, вызвавшее изменение состояния кнопки.

value number <optional>

Значение кнопки. Доступно только для Gamepads.

Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: input/DeviceButton.js (Строка 144)

<internal> stop(event, value)

Вызывается автоматически Phaser.Pointer и Phaser.SinglePad.
Обрабатывает состояние отпускания кнопки.

Параметры
Имя Тип Аргумент Описание
event object <optional>

Событие DOM, вызвавшее изменение состояния кнопки.

value number <optional>

Значение кнопки. Доступно только для Gamepads.

Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: input/DeviceButton.js (Строка 179)

© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.DeviceButton.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API