Пользовательские дополнения

На главную


progressiveDownloadLib.GetStatus()

Возвращает статус прогрессивной загрузки. При изменении информации приходит EVENT_PROGRESSIVEDOWNLOADING_STATUS_CHANGED.

-- библиотека:
progressiveDownloadLib

-- объявление:
GetStatus()

-- параметры:
нет

-- структуры данных
PacksInfo - Информация о группе паков
table или nil - таблица с полями:
  count: number - количество
  size: number - общий размер, байт

DownloadInfo - Информация об объёмах скачанных данных
table или nil - таблица с полями:
  total: number - всего нужно скачать, байт
  done: number - уже скачено, байт
  left: number - осталось скачать, байт

DownloadPacksInfo - Информация о скачиваемой группе паков
table или nil - таблица с полями:
  count: number - количество
  size: number - общий размер, байт
  download: DownloadInfo - информация об объёмах скачанных данных для данной группы

CompletenessMetrics - Численные показатели готовности части дистрибутива на основе какого-либо критерия
  isComplete: boolean - часть дистрибутива полностью готово
  percent: number - процент готовности (вещественное число)
  completePacksInfo: PacksInfo - информация о готовых паках

DataPartStatus - Статус части дистрибутива
  readyMetrics: CompletenessMetrics - Численные показатели о полностью готовых к использованию паках
  onDiskMetrics: CompletenessMetrics - Численные показатели о полностью скаченных (но, возможно, ещё не готовых к использованию) паках (percent - интегральный показатель, котоорый учитывает даже частично скаченные/пропатченные паки)
  totalPacksInfo: DownloadPacksInfo - Информация обо всех паках, входящих в данную часть дистрибутива

-- возвращаемые значения (с учётом перечисленных выше структур данных):
table или nil - таблица с полями:
  activityLevel: number (enum PROGRESSIVE_DOWNLOAD_ACTIVITY_...) - Индикатор того, насколько важные (для текущего момента времени) данные сейчас скачиваются (либо проверяются на целостность)
  isHiResRequired: boolean - если true, то требуются ли high-res текстуры (игрок их может отключить в настройках и в этом случае они скачиваться вообще не будут, это валидная ситуация)
  isActivityRequired: boolean - если true, то требуется ли активность по выкачиванию (либо проверке целостности) чего-либо, чтобы дистрибутив, соответствующий пользовательским настройкам (с high-res текстурами или без таковых) был полностью готов
  topPacksCount: number - Количество не скаченных паков. Для отображения топа запросов на скачивание.
  netDownSpeed: number - Фактическая скорость скачивания (пока что считается в клиенте вручную)
  netUpSpeed: number - Фактическая скорость отдачи (пока не указывается - всегда равна нулю)
  netConnectionsCount: number - Фактическое количество соединений (пока не указывается - всегда равна нулю)
  isGameCenterConnected: boolean - Есть ли соединение с Игровым Центром
  gameCenterReconnectionsCount: number - Число реконнектов к Игровому Центру с момента запуска игры
  baseDataStatus: DataPartStatus - Статус базовой части дистрибутива (чёрный сектор + все паки белого сектора, кроме текстур высокого разрешения)
  hiResDataStatus: DataPartStatus - Статус части дистрибутива, содержащей текстуры высокого разрешения
  fullDataStatus: DataPartStatus - Статус всего дистрибутива целиком
  fastCheckQueueInfo: PacksInfo - Информация о паках, стоящих в очереди на проверку целостности
  forcedHiResPacksInfo: DownloadPacksInfo - Информация о паках высокого разрешения, которые должны быть выкачены независимо от настроек графики (например, итема на главном аватаре)

-- пример:
local status = progressiveDownloadLib.GetStatus()

См. также

Связанные страницы: "CategoryLuaApi" "CategoryProgressiveDownloadLib"

CategoryProgressiveDownloadLib
EnumProgressiveDownloadActivity
EventProgressiveDownloadingErrorApiMismatch
EventProgressiveDownloadingErrorConnectionLost
EventProgressiveDownloadingErrorFileAccessDenied
EventProgressiveDownloadingErrorFileGeneral
EventProgressiveDownloadingErrorNotReady
EventProgressiveDownloadingErrorProto
EventProgressivedownloadingErrorSimple
EventProgressivedownloadingFileDiskFull
EventProgressivedownloadingHaltedPacksChanged
EventProgressiveDownloadingLatestMsgsChanged
EventProgressiveDownloadingLatestPacksChanged
EventProgressivedownloadingMapPercentChanged
EventProgressiveDownloadingRecheckPacksChanged
EventProgressivedownloadingStatusChanged
EventProgressiveDownloadingTopPacksChanged
EventProgressiveDownloadingWarningReconnections
EventProgressiveDownloadingWhiteInfoChanged
FunctionProgressiveDownloadLibGetDownloadRateLimit
FunctionProgressiveDownloadLibGetHaltedPacks
FunctionProgressiveDownloadLibGetLatestDownloadedPacks
FunctionProgressiveDownloadLibGetLatestErrors
FunctionProgressiveDownloadLibGetMapDownloadedPercent
FunctionProgressiveDownloadLibGetPackInfoById
FunctionProgressiveDownloadLibGetPriorityGroup
FunctionProgressiveDownloadLibGetPriorityGroupsCount
FunctionProgressiveDownloadLibGetRecheckPacks
FunctionProgressiveDownloadLibGetStatus
FunctionProgressiveDownloadLibGetTopRequestedPacks
FunctionProgressiveDownloadLibGetUploadRateLimit
FunctionProgressiveDownloadLibGetWhiteDescr
FunctionProgressiveDownloadLibSetDownloadRateLimit
FunctionProgressiveDownloadLibSetTopPacksWindow
FunctionProgressiveDownloadLibSetUploadRateLimit


CategoryLuaApi CategoryFunction CategoryProgressiveDownloadLib

На главную