Класс: Phaser.Keyboard

Конструктор

new Keyboard(game)

Параметры

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

Общедоступные свойства

callbackContext : Объект

Контекст, в котором выполняются обратные вызовы.

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

enabled : boolean

Обработка ввода с клавиатуры будет происходить только при включенном режиме.

Значение по умолчанию

• true

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

event : Объект

Последнее событие DOM из keydown или keyup. Обновляется каждый раз, когда нажимается или отпускается новая клавиша.

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

game : Phaser.Game

Локальная ссылка на игру.

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

[только для чтения] lastChar : строка

Возвращает строковое значение последней нажатой клавиши.

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

[только для чтения] lastKey : Phaser.Key

Возвращает последнюю нажатую клавишу. Это объект Phaser.Key, и он изменяется каждый раз при нажатии клавиши.

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

onDownCallback : Функция

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

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

onPressCallback : Функция

Этот обратный вызов вызывается каждый раз, когда возникает событие DOM onkeypress, которое относится только к печатаемым клавишам.

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

onUpCallback : Функция

Этот обратный вызов вызывается каждый раз, когда клавиша отпускается.

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

pressEvent : Объект

Последнее событие DOM из keypress.

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

Общедоступные методы

addCallbacks(context, onDown, onUp, onPress)

Добавить обработчики событий для обработчика клавиатуры, чтобы каждый раз при нажатии или отпускании клавиши вызывались эти обработчики.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
context	object			Контекст, в котором выполняются обработчики.
onDown	function	<optional>	null	Этот обработчик вызывается при каждом нажатии клавиши.
onUp	function	<optional>	null	Этот обработчик вызывается при каждом отпускании клавиши.
onPress	function	<optional>	null	Этот обработчик вызывается при каждом событии onkeypress.

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

addKey(keycode) → {Phaser.Key}

Если вам нужен более точный контроль над клавишей, вы можете создать новый объект Phaser.Key с помощью этого метода.
Объект Key можно затем опрашивать, добавлять к нему события и т. д.

Параметры

Имя	Тип	Описание
keycode	integer	Код клавиши keycode.

Возвращаемое значение

Phaser.Key -

Объект Key, который можно сохранить локально и использовать напрямую.

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

addKeyCapture(keycode)

По умолчанию, при нажатии клавиши Phaser не останавливает распространение события до браузера.
Для некоторых клавиш, таких как стрелки или пробел, это может быть неудобно, так как это вызывает прокрутку окна браузера.

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

Передайте либо код одной клавиши, либо массив/словарь кодов клавиш.

Параметры

Имя	Тип	Описание
keycode	integer | Array.<integer> | object	Либо одиночный код keycode, либо массив/словарь кодов клавиш, таких как [65, 67, 68].

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

addKeys(keys) → {object}

Практичный способ создания объекта, содержащего выбранные пользователем горячие клавиши.

Например,

addKeys( { 'up': Phaser.KeyCode.W, 'down': Phaser.KeyCode.S, 'left': Phaser.KeyCode.A, 'right': Phaser.KeyCode.D } );

вернёт объект, содержащий свойства (up, down, left и right), которые ссылаются на объекты Phaser.Key.

Параметры

Имя	Тип	Описание
keys	object	Объект сопоставления клавиш, т.е. { 'up': Phaser.KeyCode.W, 'down': Phaser.KeyCode.S } или { 'up': 52, 'down': 53 }.

Возвращаемое значение

object -

Объект, содержащий свойства, сопоставленные со значениями Phaser.Key.

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

clearCaptures()

Очистить все установленные захват клавиш.

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

createCursorKeys() → {object}

Создаёт и возвращает объект, содержащий 4 горячие клавиши: Вверх, Вниз, Влево и Вправо.

Возвращаемое значение

object -

Объект, содержащий свойства: up, down, left и right объектов Phaser.Key.

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

destroy()

Останавливает работу слушателей событий клавиатуры (keydown и keyup). Они удаляются из окна.
Также очищаются все захваченные клавиши и созданные объекты Key.

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

downDuration(keycode, duration) → {boolean}

Возвращает true если клавиша была нажата в течение duration заданного значения, или false если она не нажата или была нажата дольше, чем заданное время.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
keycode	integer			Код клавиши keycode для проверки: например, Phaser.KeyCode.UP или Phaser.KeyCode.SPACEBAR.
duration	number	<optional>	50	Время, в течение которого клавиша считается нажатой. Указано в мс.

Возвращаемое значение

boolean -

Истина, если клавиша была нажата в течение заданного времени, ложь — если нет, или null, если клавиша не найдена.

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

isDown(keycode) → {boolean}

Возвращает true, если клавиша нажата. Обратите внимание, что он может обнаруживать только нажатия клавиш в веб-браузере.

Параметры

Имя	Тип	Описание
keycode	integer	Код клавиши keycode для проверки: например, Phaser.KeyCode.UP или Phaser.KeyCode.SPACEBAR.

Возвращаемое значение

boolean -

Истина, если клавиша нажата, ложь — если нет, или null, если клавиша не найдена.

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

<internal> processKeyDown(event)

Обработка события keydown.

Параметры

Имя	Тип	Описание
event	KeyboardEvent

Внутреннее:

• Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.

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

<internal> processKeyPress(event)

Обработка события нажатия клавиши.

Параметры

Имя	Тип	Описание
event	KeyboardEvent

Внутреннее:

• Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.

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

<internal> processKeyUp(event)

Обработка события отпускания клавиши.

Параметры

Имя	Тип	Описание
event	KeyboardEvent

Внутреннее:

• Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.

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

removeKey(keycode)

Удаляет объект Key из менеджера Keyboard.

Параметры

Имя	Тип	Описание
keycode	integer	Код клавиши (keycode) для удаления.

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

removeKeyCapture(keycode)

Удаляет существующий захват клавиши.

Параметры

Имя	Тип	Описание
keycode	integer	Код клавиши (keycode), для которого нужно снять захват.

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

reset(hard)

Сбрасывает все клавиши.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
hard	boolean	<optional>	true	При мягком сбросе не сбрасываются события или коллбэки, привязанные к клавишам. Жесткий сброс сбросит всё.

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

<internal> start()

Запускает обработчики событий Keyboard (keydown и keyup). Они прикреплены к окну.
Вызывается автоматически Phaser.Input и обычно не должен вызываться напрямую.

Внутреннее:

• Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.

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

stop()

Останавливает обработчики событий Keyboard (keydown, keyup и keypress). Они удаляются из окна.

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

update()

Обновляет все текущие клавиши.

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

upDuration(keycode, duration) → {boolean}

Возвращает true , если клавиша была нажата в течение duration заданного значения, или false , если она либо не нажата, либо была нажата более duration заданной длительности.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
keycode	Phaser.KeyCode | integer			Код клавиши, например, Phaser.KeyCode.UP или Phaser.KeyCode.SPACEBAR.
duration	number	<optional>	50	Время, в течение которого клавиша считается только что отпущенной. Указано в мс.

Возвращаемое значение

boolean -

True, если клавиша была отпущена в течение заданной длительности, false - если нет, null - если клавиша не найдена.

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