Menu

Меню.

Source:

UI/Menu/Menu.js, line 7

Parameters:

Name	Type	Description
`options`	`object`	Опции.

Extends

external:Phaser.Group

Members

_bitmapArea _elementTypeMap _fader _fading alpha angle background children disabledElements elements hiddenElements layout length name options rotation specialElements visible x y

(private) _bitmapArea :Phaser.BitmapData

Графика фона меню.

Source:

UI/Menu/Menu.js, line 33

(private) _elementTypeMap :object

Методы добавления элементов по типу элемента.

Source:

UI/Menu/Menu.js, line 87

(private) _fader :Phaser.Tween

Твин анимации фейда меню.

Source:

UI/Menu/Menu.js, line 48

(private) _fading :number

Направление анимации фейда (-1 - скрывается, 0 - стоит на месте, 1 - показывается).

Source:

UI/Menu/Menu.js, line 54

alpha :number

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

Overrides:

external:Phaser.Group#alpha

Source:

types.js, line 145

angle :number

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

Inherited From:

external:Phaser.Group#angle

Source:

types.js, line 151

background :Phaser.Image

Фон меню.

Source:

UI/Menu/Menu.js, line 39

children :Array.<DisplayObject>

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

Inherited From:

external:Phaser.Group#children

Source:

types.js, line 169

disabledElements :Array

Отключенные элементы меню.

Source:

UI/Menu/Menu.js, line 75

elements :Array

Элементы меню.

Source:

UI/Menu/Menu.js, line 60

hiddenElements :Array

Скрытые элементы меню.

Source:

UI/Menu/Menu.js, line 70

layout :Array

Макет меню.

Source:

UI/Menu/Menu.js, line 81

(readonly) length :number

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

Inherited From:

external:Phaser.Group#length

Source:

types.js, line 175

name :string

Имя меню.

Overrides:

external:Phaser.Group#name

Source:

UI/Menu/Menu.js, line 21

options :object

Переданные при создании меню опции.

Source:

UI/Menu/Menu.js, line 13

rotation :number

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

Inherited From:

external:Phaser.Group#rotation

Source:

types.js, line 157

specialElements :Array

Элементы меню, которые не влияют на размер меню.

Source:

UI/Menu/Menu.js, line 65

visible :Boolean

Видимость меню.

Overrides:

external:Phaser.Group#visible

Source:

UI/Menu/Menu.js, line 27

x :number

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

Overrides:

external:Phaser.Group#x

Source:

types.js, line 133

y :number

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

Overrides:

external:Phaser.Group#y

Source:

types.js, line 139

Methods

align alignAlternate alignJustify alignLeft alignRight alignSpecial button buttonPopup drawPanel drawRoundedRectangle _addButton _addElement _calculateAlign _createArea _getTypeMap _hide _resize _show _stopFader add addCloseButton bringToTop createLayout destroy disable disableElement enable enableElement fadeIn fadeOut fadeToggle forEach forEachElement getByName getDefaultOptions getElementByName hide hideElement remove removeAll removeAllElements setChildIndex show showElement toggle update updatePosition

(static) align(align, options) → {array}

Возвращает массив с настройками элементов для передачи в Menu#createLayout с установленным флагом выравневания.

Source:

UI/Menu/MenuStatic.js, line 130

Parameters:

Name	Type	Description
`align`	`string`	значения флага выравнивания
`options`	`array` \| `object`	опции элементов меню

Returns:

Type:: array

Возвращает массив с настройками элементов и флагом выравнивания.

(static) alignAlternate(options) → {array}

Четные элементы будут выравнены по левому краю, нечетные - по правому.

Source:

UI/Menu/MenuStatic.js, line 98

See:

Menu.align

Parameters:

Name	Type	Description
`options`	`array` \| `object`	опции элементов меню

Returns:

Type:: array

Возвращает массив с настройками элементов и флагом выравнивания.

(static) alignJustify(options) → {array}

Первый элемент будет выравнен по левому краю, последний - по правому, остальные - по центру.

Source:

UI/Menu/MenuStatic.js, line 87

See:

Menu.align

Parameters:

Name	Type	Description
`options`	`array` \| `object`	опции элементов меню

Returns:

Type:: array

Возвращает массив с настройками элементов и флагом выравнивания.

(static) alignLeft(options) → {array}

Элементы будут выравнены по левому краю.

Source:

UI/Menu/MenuStatic.js, line 65

See:

Menu.align

Parameters:

Name	Type	Description
`options`	`array` \| `object`	опции элементов меню

Returns:

Type:: array

Возвращает массив с настройками элементов и флагом выравнивания.

(static) alignRight(options) → {array}

Элементы будут выравнены по правому краю.

Source:

UI/Menu/MenuStatic.js, line 76

See:

Menu.align

Parameters:

Name	Type	Description
`options`	`array` \| `object`	опции элементов меню

Returns:

Type:: array

Возвращает массив с настройками элементов и флагом выравнивания.

(static) alignSpecial(aligns, options) → {array}

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

Source:

UI/Menu/MenuStatic.js, line 109

Parameters:

Name	Type	Description
`aligns`	`Array.<string>`	выравнивания всех элементов (`'left', 'right', 'center'`), `'center'` по умолчанию
`options`	`array` \| `object`	опции элементов меню

Returns:

Type:: array

Возвращает массив с настройками элементов и флагом выравнивания.

(static) button(options)

Возвращает объект с настройками кнопки (UI.Button) для передачи в Menu#createLayout.

Source:

UI/Menu/MenuStatic.js, line 8

Parameters:

Name	Type	Description
`options`	`object`	настройки кнопки

(static) buttonPopup(options)

Возвращает объект с настройками кнопки с текстом при наведении (UI.ButtonPopup) для передачи в Menu#createLayout.

Source:

UI/Menu/MenuStatic.js, line 20

Parameters:

Name	Type	Description
`options`	`object`	настройки кнопки

(static) drawPanel(bitmap, width, height, x, y, color, header)

Рисует панель с закругленными углами.

Source:

UI/Menu/MenuStatic.js, line 161

Parameters:

Name	Type	Description
`bitmap`	`Phaser.BitmapData`	где рисовать
`width`	`number`	ширина
`height`	`number`	высота
`x`	`number`	отступ по краям по горизонтали
`y`	`number`	отступ по краям по вертикали
`color`	`string`	цвет панели
`header`	`boolean` \| `number`	нужно ли рисовать шапку для названия меню

(static) drawRoundedRectangle(bitmap, width, height, x, y, radius, lineWidth, alpha, fillStyle, strokeStyle)

Рисует прямоугольник с загругленными углами.

Source:

UI/Menu/MenuStatic.js, line 238

Parameters:

Name	Type	Description
`bitmap`	`Phaser.BitmapData`	где рисовать
`width`	`number`	ширина
`height`	`number`	высота
`x`	`number`	отступ по краям по горизонтали
`y`	`number`	отступ по краям по вертикали
`radius`	`number`	радиус углов
`lineWidth`	`number`	ширина рамки
`alpha`	`number`	прозрачность заливки
`fillStyle`	`string` \| `CanvasPattern`	стиль заливки
`strokeStyle`	`string` \| `CanvasPattern`	стиль рамки

(private) _addButton()

Создает и добавляет кнопку UI.Button в меню.

Source:

UI/Menu/MenuAdd.js, line 106

(private) _addElement(element)

Создает и добавляет элемент меню в меню.

Source:

UI/Menu/MenuAdd.js, line 92

Parameters:

Name	Type	Description
`element`	`object`	Тип и настройки элемента в виде `{type, options}`.

(private) _calculateAlign() → {number}

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

Source:

UI/Menu/MenuPosition.js, line 64

Returns:

Type:: number

(private) _createArea()

Рисует фон меню.

Source:

UI/Menu/MenuPosition.js, line 159

(private) _getTypeMap() → {object}

Возвращает объект с функциями для создания элементов по названию элемента.

Source:

UI/Menu/MenuAdd.js, line 5

Returns:

Type:: object

(private) _hide()

Прячет меню.

Source:

UI/Menu/MenuState.js, line 4

(private) _resize()

Устанавливает размер фона меню в соответствии с элементами.

Source:

UI/Menu/MenuPosition.js, line 108

(private) _show()

Показывает и обновляет позицию меню.

Source:

UI/Menu/MenuState.js, line 11

(private) _stopFader()

Останавливает анимацию меню.

Source:

UI/Menu/MenuFader.js, line 69

add()

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

Inherited From:

external:Phaser.Group#add

Source:

types.js, line 188

addCloseButton(actionopt)

Добавляет кнопку закрытия меню.

Source:

UI/Menu/MenuAdd.js, line 67

Parameters:

Name	Type	Attributes	Description
`action`	`function`	<optional>	Действие кнопки. По умолчанию будет вызвано плавное закрытие меню.

bringToTop()

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

Inherited From:

external:Phaser.Group#bringToTop

Source:

types.js, line 198

createLayout(layout)

Создает макет меню и соответствующие макету элементы. Предварительно удаляет любые существующие элементы меню.

Source:

UI/Menu/MenuAdd.js, line 46

Parameters:

Name	Type	Description
`layout`	`array`	Массив с настройками и типами элементов, представляющий макет меню.

Example

var menu = new Menu();
menu.createLayout([
	// Строка, выравненная по правому краю
	Menu.alignRight(				
		Menu.button({text: 'row0element0'}),	// Тип элемента указывается вызовом Menu.elementType
		{text: 'row0element1'}					// Кнопка создается по умолчанию без указания типа
	),

	// Вместо вызова функции можно передавать обычный массив, тогда элементы будут выравнены по центру
	[				
		Menu.checkbox({text: 'row2element0'}),
		Menu.text({text: 'row2element1'})
	],

	// Строка с одним элементом выравненная может быть не обернута в массив, элемент будет выравнен по центру
	{text: 'row1element0'},

	// Строка с одним элементов, выравненным по левому краю
	Menu.alignLeft(
		Menu.button({text: 'row'})
	)
]);

destroy()

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

Inherited From:

external:Phaser.Group#destroy

Source:

types.js, line 223

disable(changeToDefaultFrame)

Отключает элементы меню.

Source:

UI/Menu/MenuState.js, line 37

Parameters:

Name	Type	Description
`changeToDefaultFrame`	`boolean`	заставляет элемент переключиться на дефолтный кадр текстуры, вместо кадра, соответствующего отключенному состоянию

disableElement(name)

Отключает элемент с указанным именем.

Source:

UI/Menu/MenuElement.js, line 104

Parameters:

Name	Type	Description
`name`	`string`	Имя элемента.

enable()

Включает элементы игры, не входящие в Menu#disabledElements

Source:

UI/Menu/MenuState.js, line 44

enableElement(name)

Включает элемент с указанным именем.

Source:

UI/Menu/MenuElement.js, line 122

Parameters:

Name	Type	Description
`name`	`string`	Имя элемента.

fadeIn()

Плавно показывает меню.

Source:

UI/Menu/MenuFader.js, line 23

fadeOut()

Плавно скрывает меню.

Source:

UI/Menu/MenuFader.js, line 2

fadeToggle()

Плавно показывает или скрывает меню в зависимости от текущего состояния.

Source:

UI/Menu/MenuFader.js, line 45

forEach()

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

Inherited From:

external:Phaser.Group#forEach

Source:

types.js, line 208

forEachElement(callback, includeSpecialopt)

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

Source:

UI/Menu/MenuElement.js, line 6

Parameters:

Name	Type	Attributes	Description
`callback`	`function`		Выполняется для каждого элемента, имеет три параметра `element, i, len`.
`includeSpecial`	`boolean`	<optional>	Нужно ли включать в цикл специальные элементы из Menu#specialElements.

getByName()

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

Inherited From:

external:Phaser.Group#getByName

Source:

types.js, line 213

getDefaultOptions() → {object}

Опции по умолчанию

Source:

UI/Menu/Menu.js, line 119

Returns:

Type:: object

опции

getElementByName(name) → {DisplayObject}

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

Source:

UI/Menu/MenuElement.js, line 42

Parameters:

Name	Type	Description
`name`	`string`	Имя элемента.

Returns:

Type:: DisplayObject

Элемент с name, равным указанному.

hide()

Прячет меню, останавливая анимацию и убирая возможность нажимать на элементы.

Source:

UI/Menu/MenuState.js, line 17

hideElement(name)

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

Source:

UI/Menu/MenuElement.js, line 58

Parameters:

Name	Type	Description
`name`	`string`	Имя элемента.

remove()

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

Inherited From:

external:Phaser.Group#remove

Source:

types.js, line 193

removeAll()

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

Inherited From:

external:Phaser.Group#removeAll

Source:

types.js, line 228

removeAllElements(destroyopt)

Удаляет и опционально уничтожает все элементы меню.

Source:

UI/Menu/MenuElement.js, line 26

Parameters:

Name	Type	Attributes	Description
`destroy`	`boolean`	<optional>	нужно ли уничтожать объекты

setChildIndex()

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

Inherited From:

external:Phaser.Group#setChildIndex

Source:

types.js, line 203

show()

Показывает меню, останавливая анимацию и давая возможность нажимать на элементы.

Source:

UI/Menu/MenuState.js, line 25

showElement(name)

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

Source:

UI/Menu/MenuElement.js, line 81

Parameters:

Name	Type	Description
`name`	`string`	Имя элемента.

toggle()

Переключает видимость меню

Source:

UI/Menu/MenuState.js, line 56

update()

Обновляет все элементы, входящие в группу.

Inherited From:

external:Phaser.Group#update

Source:

types.js, line 218

updatePosition(positionopt)

Позиционирует меню и элементы.

Source:

UI/Menu/MenuPosition.js, line 5

Parameters:

Name	Type	Attributes	Description
`position`	`object`	<optional>	новая позиция меню `{x, y}`.

new Menu(options)

Parameters:

Extends

Members

(private) _bitmapArea :Phaser.BitmapData

(private) _elementTypeMap :object

(private) _fader :Phaser.Tween

(private) _fading :number

alpha :number

angle :number

background :Phaser.Image

children :Array.<DisplayObject>

disabledElements :Array

elements :Array

hiddenElements :Array

layout :Array

(readonly) length :number

name :string

options :object

rotation :number

specialElements :Array

visible :Boolean

x :number

y :number

Methods

(static) align(align, options) → {array}

Parameters:

Returns:

(static) alignAlternate(options) → {array}

Parameters:

Returns:

(static) alignJustify(options) → {array}

Parameters:

Returns:

(static) alignLeft(options) → {array}

Parameters:

Returns:

(static) alignRight(options) → {array}

Parameters:

Returns:

(static) alignSpecial(aligns, options) → {array}

Parameters:

Returns:

(static) button(options)

Parameters:

(static) buttonPopup(options)

Parameters:

(static) drawPanel(bitmap, width, height, x, y, color, header)

Parameters:

(static) drawRoundedRectangle(bitmap, width, height, x, y, radius, lineWidth, alpha, fillStyle, strokeStyle)

Parameters:

(private) _addButton()

(private) _addElement(element)

Parameters:

(private) _calculateAlign() → {number}

Returns:

(private) _createArea()

(private) _getTypeMap() → {object}

Returns:

(private) _hide()

(private) _resize()

(private) _show()

(private) _stopFader()

add()

addCloseButton(actionopt)

Parameters:

bringToTop()

createLayout(layout)

Parameters:

Example

destroy()

disable(changeToDefaultFrame)

Parameters:

disableElement(name)

Parameters:

enable()

enableElement(name)

Parameters:

fadeIn()