new QueueManager(server, quickConfig)
Менеджер очередей и игр.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
server |
Server
|
сервер |
quickConfig |
object
|
настройки быстрой игры |
Members
(static) PLAYER_STATUS :number
Статус игрока.
Properties:
Name | Type | Description |
---|---|---|
FREE |
number
|
Игрок свободен. |
IN_QUEUE |
number
|
Игрок в очереди. |
IN_GAME |
number
|
Игрок в игре. |
- Source:
queueList :Array
Очереди, в которые могут подключаться игроки (с type
не равным private
или botmatch
).
На время прохождения игр очереди убираются из этого списка.
- Source:
quickQueues :Array
Очереди быстрой игры, в которые могут подключаться игроки (с type
равным quick
).
На время прохождения игр быстрые очереди убираются из этого списка.
- Source:
Methods
addCustomQueue
addPlayerToCustomQueue
addPlayerToQuickQueue
addQueue
addQueueToList
concedePlayer
disconnectPlayer
getQueueList
playerIsBusy
reconnectPlayer
removePlayerFromQueue
removeQueue
removeQueueFromList
addCustomQueue(player, gameMode, queueConfig, gameRulesopt)
Создает очередь с заданными настройками и добавляет в нее игрока.
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
player |
Player
|
игрок |
|
gameMode |
string
|
режим игры |
|
queueConfig |
object
|
настройки очереди |
|
gameRules |
object
|
<optional> |
настройки игры |
addPlayerToCustomQueue(player, qid)
Добавляет игрока в очередь по id очереди.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
player |
Player
|
игрок |
qid |
string
|
id очереди |
addPlayerToQuickQueue(player)
Создает очередь со стандартными настройками и добавляет в нее игрока.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
player |
Player
|
игрок |
addQueue(type, config) → {Queue}
Создает и добавляет новую очередь.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
type |
string
|
Тип очереди.
Значения: |
config |
object
|
Конфигурация очереди. |
addQueueToList(queue)
Добавляет очередь в список очередей, к которым можно присоединиться.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
queue |
Queue
|
concedePlayer(player)
Удаляет игрока из игры.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
player |
Player
|
disconnectPlayer(player) → {boolean}
Устанавливает статус соединения игрока на false
и возвращает false
,
если игрок находится в игре, либо убирает игрока из очереди и возвращает true
,
если игрок не находится в игре.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
player |
Player
|
Returns:
- Type:
-
boolean
Возвращает нужно ли удалить игрока.
getQueueList(page, paginationopt, hideStartedopt) → {Array.<object>}
Возвращает список с информацией о существующих очередях.
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
page |
number
|
номер страницы очередей |
||
pagination |
number
|
<optional> |
10 |
во очередей на странице |
hideStarted |
boolean
|
<optional> |
не добавлять очереди с начатыми играми |
Returns:
- Type:
-
Array.<object>
Возвращает массив с объектами с информацией об очередях.
playerIsBusy(player, silentopt) → {QueueManager.PLAYER_STATUS}
Возвращает статус игрока.
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
player |
Player
|
|||
silent |
boolean
|
<optional> |
false |
убирает вывод статуса в консоль |
Returns:
reconnectPlayer(player)
Переподсоединяет игрока к игре.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
player |
Player
|
removePlayerFromQueue(player)
Удаляет игрока из очереди.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
player |
Player
|
removeQueue(queue)
Удаляет очередь из менеджера.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
queue |
Queue
|
removeQueueFromList(queue)
Удаляет очередь из списка очередей к которым можно присоединиться.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
queue |
Queue
|