Button

new Button(optionsopt)

Конструктор кнопок с текстом/иконкой.
Состоит из двух элементов: кнопки (button) и опционального текста\иконки (label).

Source:
Parameters:
Name Type Attributes Description
options object <optional>

Настройки кнопки.

Name Type Default Description
position object | function {x:0,y:0}

Позиция кнопки в виде объекта или функции, возвращающий объект вида {x, y}. В функцию передаются следующие параметры: width, height.
color string 'grey'

Цвет кнопки.
size string 'wide'

Тип кнопки ('small', 'big', 'wide', 'circle')
action function

Действие кнопки.
context any null

Контекст действия.
group external:Phaser.Group null

Группа, в которую будет помещена кнопка.
scale number 1

Масштаб кнопки.
text string null

Текст кнопки.
textColor string 'black'

Цвет текста.
font string 'Exo,

Helvetica' Шрифт текста.
fontSize number 26

Размер шрифта.
icon string null

Иконка кнопки.
name string null

Имя кнопки.
downOffset number 4

На сколько сдвигать текст\иконку кнопку, когда она нажата.
mobileClickProtect boolean false

На мобильных устройствах можно отменить нажатие кнопки, отведя от нее палец.
Extends

Members

action alpha angle children isDown label length name options rotation visible x y

action :function

Действие.

Source:

alpha :number

Прозрачность.

Inherited From:
Source:

angle :number

Поворот в градусах.

Inherited From:
Source:

children :Array.<DisplayObject>

Элементы, входящие в группу.

Inherited From:
Source:

isDown :Boolean

Находится ли кнопка в нажатом положении (нажата или отключена).

Source:

label :Phaser.Text|Phaser.Image

Текст или иконка кнопки.

Properties:
Name Type Description
isText boolean

является ли элемент текстом
Source:

(readonly) length :number

Кол-во элементов, входящих в группу.

Inherited From:
Source:

name :string

Имя группы.

Inherited From:
Source:

options :object

Опции.

Source:

rotation :number

Поворот в радианах.

Inherited From:
Source:

visible :boolean

Отрисовывается ли элемент игрой.

Overrides:
Source:

x :number

Позиция по горизонтали.

Overrides:
Source:

y :number

Позиция по вертикали.

Overrides:
Source:

Methods

add bringToTop cursorIsOver destroy disable enable forEach getByName getDefaultOptions hide remove removeAll setChildIndex show update updatePosition

add()

Добавляет элемент в группу.

Inherited From:
Source:

bringToTop()

Поднимает элемент группы наверх.

Inherited From:
Source:

cursorIsOver() → {boolean}

Возвращает находится ли курсор над кнопкой.

Source:
Returns:
Type:
boolean

destroy()

Уничтожает группу, убирая все элементы из нее, опционально уничтожая их тоже.

Inherited From:
Source:

disable(changeToDefaultFrame)

Выключает кнопку.

Source:
Parameters:
Name Type Description
changeToDefaultFrame boolean

Текстура кнопки переходит в обычное состояние, вместо выключенного.

enable()

Включает кнопку.

Source:

forEach()

Выполняет callback для каждого элемента группы.

Inherited From:
Source:

getByName()

Возвращает элемент группы с указанным именем.

Inherited From:
Source:

getDefaultOptions() → {object}

Возвращает опции по умолчанию.

Source:
Returns:
Type:
object

hide()

Прячет кнопку

Source:

remove()

Убирает элемент из группы.

Inherited From:
Source:

removeAll()

Удаляет все элементы из группы, опционально уничтожая их.

Inherited From:
Source:

setChildIndex()

Устанавливает индекс элемента группы по вертикали.

Inherited From:
Source:

show()

Показывает кнопку.

Source:

update()

Проверяет находится ли курсор над кнопкой.

Overrides:
Source:

updatePosition(position)

Меняет или восстанавливает заданную позицию.

Source:
Parameters:
Name Type Description
position object | function

позиция