new PopupField(options, style, popupStyle, iconStyle)
Поле стола с сообщением при наведении.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
options |
object
|
|
style |
object
|
|
popupStyle |
object
|
настройки сообщения при наведении |
iconStyle |
object
|
Extends
Members
_angles
_bitmapArea
_cardSpacing
_debugActiveSpace
_delays
_entranceTween
_expectedDelay
_hoverTextChanged
_popupArea
_popupPlacement
_popupText
_queuedCards
_uninteractibleTimer
alpha
angle
area
cards
cardsToRemove
children
delayTime
focusedCard
highlighted
icon
iconStyle
id
inDebugMode
interactible
length
linkedField
moveTime
name
options
playable
poppedOut
rotation
savedPosition
specialId
style
type
validCards
visible
x
y
(private) _angles :Object.<number>
Углы карт по id карт.
- Inherited From:
- Source:
(private) _bitmapArea :Phaser.BitmapData
BitmapData поверхности поля.
- Inherited From:
- Source:
(private) _cardSpacing :Number
Расчитанное расстояние между картами для Field#cardIsInside
- Inherited From:
- Source:
(private) _debugActiveSpace :Phaser.Rectangle
Размер активного места поля для дебага.
- Inherited From:
- Source:
(private) _delays :object.<string>
Задержки карт по id карт.
- Inherited From:
- Source:
(private) _entranceTween :Phaser.Tween
Твин появления поля.
- Inherited From:
- Source:
(private) _expectedDelay :Number
Ожидаемая задержка для установки Field#_uninteractibleTimer
- Inherited From:
- Source:
(private) _hoverTextChanged :Boolean
Ведет к обновлению значения текста при наведении.
- Overrides:
- Source:
(private) _popupArea :DisplayObject
Элемент, который будет обрабатывать наведение курсора.
- Inherited From:
- Source:
(private) _popupPlacement :string
Позиция всплывающего текста.
- Inherited From:
- Source:
(private) _popupText :string
Статичный всплывающий текст.
- Inherited From:
- Source:
(private) _uninteractibleTimer
- Inherited From:
- Source:
angle :number
Поворот в градусах.
- Inherited From:
- Source:
delayTime :number
Задержка между движением карт.
- Inherited From:
- Source:
highlighted :Boolean
Подсвечено ли поле.
- Inherited From:
- Default Value:
- false
- Source:
icon :Phaser.Image
Иконка поля, если iconStyle.texture
указано.
- Inherited From:
- Source:
iconStyle :object
Внешний вид иконки поля.
- Inherited From:
- Source:
inDebugMode :boolean
Находится ли поле в дебаг режиме
- Inherited From:
- Source:
interactible :Boolean
Интерактивно ли поле.
- Inherited From:
- Default Value:
- true
- Source:
(readonly) length :number
Кол-во элементов, входящих в группу.
- Inherited From:
- Source:
moveTime :number
Время движения карт.
- Inherited From:
- Source:
options :object
Настройки поля.
Изменения не повлияют на само поле, т.к. все свойства сохранены в this
.
- Inherited From:
- Source:
playable :string|boolean
Можно ли играть карты на это поле и тип действия.
- Inherited From:
- Default Value:
- false
- Source:
poppedOut :Boolean
Увеличен ли масштаб поля
- Inherited From:
- Default Value:
- false
- Source:
rotation :number
Поворот в радианах.
- Inherited From:
- Source:
specialId :number
Специальное id поля для полей, пренадлежащих одной группе.
- Inherited From:
- Source:
validCards :Array.<Card>
Карты, которые могут быть сыграны на это поле.
- Inherited From:
- Source:
- See:
-
- highlightPossibleActions
visible :boolean
Отрисовывается ли элемент игрой.
- Inherited From:
- Source:
x :number
Позиция по горизонтали.
- Inherited From:
- Source:
Methods
_appendCards
_applyOptions
_calculateCardSpacing
_calculateCircleCenter
_calculateMargin
_compareCards
_createArea
_createDelayArray
_fixCardDraggability
_getHoverText
_getLastAngle
_moveCard
_notifyPopupManager
_rotateCard
_setDebugActiveSpace
_setUninteractibleTimer
_startCardMovers
add
addCards
animateAppearance
bringToTop
cardIsInside
destroy
endAnimation
focusOffCard
focusOnCard
forEach
getByName
getCustomHoverText
getDefaultOptions
placeCards
placeQueuedCards
queueCards
remove
removeAll
removeAllCards
removeCards
removeMarkedCards
reset
resetQueue
rotateCards
setBase
setCardsHighlight
setCardsPlayability
setChildIndex
setIconVisibility
setOwnHighlight
setOwnPlayability
setPopOut
setSize
setupAnimatedAppearance
setVisibility
sortCards
toggleDebugMode
update
updateDebug
zAlignCards
(private) _appendCards(cards)
Добавляет карты в Field#cards. Вычисляет и сохраняет угол карты в Field#_angles, если указан Field#randomAngle.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
cards |
Array.<Card>
|
карты для добавления |
(private) _applyOptions(optionsopt, styleopt)
Совмещает переданные опции со стандартными и сохраняет их, как свойства объекта.
- Inherited From:
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
object
|
<optional> |
Настройки поля. |
style |
object
|
<optional> |
Внешний вид поля. |
(private) _calculateCardSpacing(activeWidth) → {number}
Считает отступ между картами.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
activeWidth |
number
|
Активная ширина поля. |
Returns:
- Type:
-
number
Возвращает отступ между картами.
(private) _calculateCircleCenter(a, b, c) → {Phaser.Point}
Считает центр круга по трем точкам. Взято со stackoverflow.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
a |
object
|
точка a |
b |
object
|
точка b |
c |
object
|
точка c |
Returns:
- Type:
-
Phaser.Point
Возвращает центр круга.
(private) _calculateMargin(requiredActiveWidth, areaActiveWidth, areaWidth, areaHeight, cardWidth, cardHeight) → {object}
Считает отступы сверху и слева
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
requiredActiveWidth |
number
|
необходимая ширина для размещения карт |
areaActiveWidth |
number
|
реальная ширина для размещения карт |
areaWidth |
number
|
ширина поля |
areaHeight |
number
|
высота поля |
cardWidth |
number
|
ширина карты |
cardHeight |
number
|
высота карты |
Returns:
- Type:
-
object
Возвращает отступы {top, left}
(private) _compareCards()
Компаратор для сортировки.
- Inherited From:
- Source:
- See:
(private) _createArea(width, height)
Запоминает размеры поля и рисует прямоугольник с закругленными углами.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
width |
number
|
ширина поля |
height |
number
|
высота поля |
(private) _createDelayArray(noDelay) → {array}
Создает массив задержек.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
noDelay |
boolean
|
все задержки равны нулю |
Returns:
- Type:
-
array
Возращает массив задержек.
(private) _fixCardDraggability(card)
Выставляет перетаскиваемость карты для тех случаев, когда карта была перемещена без использования presetField метода.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
card |
Card
|
(private) _getHoverText(anyway) → {string|boolean}
Используется вместе с PopupManager'ом, чтобы получить текст для вывода на экран.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
anyway |
boolean
|
предоставить текст, даже если он не изменился |
Returns:
- Type:
-
string
|boolean
Возвращает строку для вывода или false
, если текст не изменился.
(private) _getLastAngle() → {number|null}
Возвращает угол последней карты в поле.
- Inherited From:
- Source:
Returns:
- Type:
-
number
|null
Угол последней карты или null
.
(private) _moveCard(card, index, topMargin, leftMargin, cardSpacing, angle, shift, focusedIndex, delayArray, delayIndex, bringToTopOn)
Рассчитывает позицию для карты в соотвествии с индексом и перемещает карту в эту позицию.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
card |
Card
|
карта |
index |
number
|
индекс карты в поле |
topMargin |
number
|
отступ сверху |
leftMargin |
number
|
отступ слева |
cardSpacing |
number
|
отступ от предыдущей карты |
angle |
number
|
угол поворота |
shift |
number
|
сдвиг от выделенной карты |
focusedIndex |
number
|
индекс выделенной карты в поле |
delayArray |
Array.<number>
|
массив задержек карт |
delayIndex |
number
|
индекс задержки карты |
bringToTopOn |
BRING_TO_TOP_ON
|
когда поднимать карту на передний план |
(private) _notifyPopupManager(now)
Оповещает PopupManager о том, что курсор находится над элементом.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
now |
boolean
|
нужно ли вывести сообщение сразу |
(private) _rotateCard(card, angle, x, y, delay) → {number}
Поворачивает карту и считает корректированную позицию по оси y.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
card |
Card
|
карта |
angle |
number
|
угол |
x |
number
|
позиция по x |
y |
number
|
позиция по y |
delay |
number
|
время задержки |
Returns:
- Type:
-
number
Возвращает откорректированную позицию по оси y.
(private) _setDebugActiveSpace(activeWidth, cardHeight, leftMargin, topMargin, shift)
Сохраняет размеры активного места для отображения.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
activeWidth |
number
|
ширина активного места |
cardHeight |
number
|
высота карт |
leftMargin |
number
|
отступ слева |
topMargin |
number
|
отступ сверху |
shift |
number
|
отступ от выделенной карты |
(private) _setUninteractibleTimer(time)
Запускает таймер, во время которого карты не реагируют на курсор.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
time |
number
|
время таймера |
(private) _startCardMovers(card, angle, x, y, margin, delay, bringToTopOn)
Запускает твины карты.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
card |
Card
|
|
angle |
number
|
|
x |
number
|
|
y |
number
|
|
margin |
number
|
|
delay |
number
|
|
bringToTopOn |
BRING_TO_TOP_ON
|
add()
Добавляет элемент в группу.
- Inherited From:
- Source:
addCards(newCards, bringToTopOnopt, noDelayopt) → {number}
Добавляет карты в поле.
- Inherited From:
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
newCards |
Array.<Card>
|
добавляемые карты |
||
bringToTopOn |
BRING_TO_TOP_ON
|
<optional> |
BRING_TO_TOP_ON.START |
когда поднимать карты на передний план |
noDelay |
boolean
|
<optional> |
false |
убирает время ожидания перед добавлением карт |
Returns:
- Type:
-
number
Время добавления
animateAppearance(delay)
Запускает твин появления поля.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
delay |
number
|
задержка до запуска твина |
bringToTop()
Поднимает элемент группы наверх.
- Inherited From:
- Source:
cardIsInside(card, includeSpacingopt, includeWholeCardopt) → {boolean}
Проверяет нахождение карты внутри поля (по координатам).
- Inherited From:
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
card |
Card
|
проверяемая карта |
||
includeSpacing |
boolean
|
<optional> |
true |
нужно ли учитывать сдвиг карт друг от друга |
includeWholeCard |
boolean
|
<optional> |
false |
любая часть карты |
Returns:
- Type:
-
boolean
Находится ли карта в поле.
destroy()
Полностью уничтожает поле, убирает все карты предварительно.
- Overrides:
- Source:
endAnimation()
Завершает твин появления поля.
- Inherited From:
- Source:
focusOffCard(card, forcedopt)
Убирает выделение карты.
- Inherited From:
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
card |
Card
|
выделенная карта |
|
forced |
boolean
|
<optional> |
заставляет поле убрать выделение карты, даже если поле не стало бы этого делать |
focusOnCard(card, pointer, forcedopt)
Выделяет карту, над которой находится курсор.
- Inherited From:
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
card |
Card
|
выделенная карта |
|
pointer |
Phaser.Pointer
|
курсор |
|
forced |
boolean
|
<optional> |
заставляет поле выделить карту, даже если она не находится в пределах поля или поле не выделяет карты при наведении |
forEach()
Выполняет callback для каждого элемента группы.
- Inherited From:
- Source:
getByName()
Возвращает элемент группы с указанным именем.
- Inherited From:
- Source:
getCustomHoverText() → {string}
Возвращает количество карт или результат из popupStyle.getTextFunction
для вывода в тексте при наведении.
- Overrides:
- Source:
Returns:
- Type:
-
string
getDefaultOptions()
Возвращает опции по умолчанию
- Inherited From:
- Source:
placeCards(newCardsopt, bringToTopOnopt, noDelayopt) → {number}
Размещает карты в поле.
- Overrides:
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
newCards |
Array.<Card>
|
<optional> |
null |
только что добавленные карты, они будут перемещены в поле по очереди |
bringToTopOn |
BRING_TO_TOP_ON
|
<optional> |
когда поднимать карту на передний план |
|
noDelay |
boolean
|
<optional> |
false |
все карты будут перемещены без задержки |
Returns:
- Type:
-
number
Возвращает задержку следующей карты.
placeQueuedCards(bringToTopOnopt, noDelayopt)
Размещает карты из очереди.
- Inherited From:
- Source:
- See:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
bringToTopOn |
BRING_TO_TOP_ON
|
<optional> |
BRING_TO_TOP_ON.START |
когда поднимать карты на передний план |
noDelay |
boolean
|
<optional> |
false |
убирает время ожидания перед добавлением карт |
queueCards(newCards, delay) → {number}
Добавляет карты в очередь на добавление.
- Inherited From:
- Source:
- See:
Parameters:
Name | Type | Description |
---|---|---|
newCards |
Array.<Card>
|
добавляемые карты |
delay |
number
|
задержка, добавляемая к первой карте в очереди |
Returns:
- Type:
-
number
Планируемое время добавления
remove()
Убирает элемент из группы.
- Inherited From:
- Source:
removeAll()
Удаляет все элементы из группы, опционально уничтожая их.
- Inherited From:
- Source:
removeAllCards()
Удаляет все карты из поля.
- Inherited From:
- Source:
- See:
removeCards(cardsToRemove)
Удаляет карты из поля.
- Overrides:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
cardsToRemove |
Array.<Card>
|
карты для удаления |
reset()
Ресет поля. Убирает все карты из поля и очереди.
- Inherited From:
- Source:
resetQueue()
Очищает очередь на добавление.
- Inherited From:
- Source:
- See:
rotateCards()
Поворачивает все карты.
- Inherited From:
- Source:
setBase(xopt, yopt, shouldPlaceopt)
Устанавливает позицию поля.
- Inherited From:
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
x |
number
|
<optional> |
this.style.x |
по горизонтали |
y |
number
|
<optional> |
this.style.y |
по вертикали |
shouldPlace |
boolean
|
<optional> |
false |
нужно ли размещать карты после установки |
setCardsHighlight(highlight)
Устанавливает подсветку всех карт в поле.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
highlight |
boolean
|
подсветка карт |
setCardsPlayability(playable)
Устанавливает играбильность всех карт в поле.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
playable |
boolean
|
играбильность карт |
setChildIndex()
Устанавливает индекс элемента группы по вертикали.
- Inherited From:
- Source:
setIconVisibility(visible)
Устанавливает видимость иконки поля.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
visible |
boolean
|
видимость |
setOwnHighlight(onopt, tintopt)
Устанавливает подсветку поля. По умолчанию зависит от того, включен ли дебаг поля.
- Inherited From:
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
on |
boolean
|
<optional> |
Field#inDebugMode |
подствечивать ли поле |
tint |
number
|
<optional> |
ui.colors.lightBlue |
цвет подсветки |
setOwnPlayability(playable, linkedFieldIdopt)
Устанавливает возможность играть карты на поле и подсветку.
- Inherited From:
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
playable |
string
|
boolean
|
играбильность и тип применимого действия |
||
linkedFieldId |
string
|
<optional> |
null |
связанное поле, используется |
setPopOut(popped)
Увеличивает или восстанавливает масштаб последней карты в поле.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
popped |
boolean
|
нужно ли увеличить или восстановить масштаб |
setSize(widthopt, heightopt, shouldPlaceopt)
Устанавливает размер поля.
- Inherited From:
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
width |
number
|
<optional> |
this.style.width |
ширина |
height |
number
|
<optional> |
this.style.height |
высота |
shouldPlace |
boolean
|
<optional> |
false |
нужно ли размещать карты после установки |
setupAnimatedAppearance()
Создает твин анимации появления поля.
- Inherited From:
- Source:
setVisibility(visible)
Устанавливает видимость подсветки поля.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
visible |
boolean
|
видимость |
toggleDebugMode()
Переключает режим дебага
- Inherited From:
- Source:
update()
Обновляет все элементы, входящие в группу.
- Inherited From:
- Source:
updateDebug()
Обновляет дебаг
- Inherited From:
- Source:
zAlignCards(checkDelayopt, forcedCardopt)
Устанавливает z-index карт.
- Inherited From:
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
checkDelay |
boolean
|
<optional> |
если |
forcedCard |
Card
|
<optional> |
Карта, которая поднимается, даже если |