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

На главную

## battleground.GetCheckpointInfo( checkpointId )

Выдаёт информацию о контрольной точке баттлграунда.

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

    -- объявление:
    function GetCheckpointInfo( checkpointId )

    -- параметры:
    checkpointId: ObjectId - id контрольной точки

    -- возвращаемое значение:
    table или nil - nil если контрольная точка с таким checkpointId не существует; иначе таблица с полями:
      name: WSting - локализованое имя контрольной точки
      textureId: TextureId - идентификатор текстуры иконки для обозначения контрольной точки
      state: string (enum "ENUM_RecapturablePlayerSpawnPlaceState_...") - состояние контрольной точки (свободна, в процессе захвата, захвачена)
      ownerMarkId: BattlegroundMarkId или nil - идентификатор команды, которой захвачена контрольная точка
      prevState: string (enum "ENUM_RecapturablePlayerSpawnPlaceState_...") - предыдущее состояние контрольной точки (до того, как её начал захватывать нынешняя команда-владелец)
      prevOwnerMarkId: BattlegroundMarkId или nil - идентификатор команды, которой раньше была захвачена контрольная точка (nil, если точка ранее была свободна)
      capturedTime: number (integer) или nil - время (в миллисекундах), оставшееся до окончания захвата контрольной точки; если контрольная в данный момент не захватывается (свободна или захват уже завершён), то nil
      captureDuration: number (integer) или nil - длительность (в миллисекундах) захвата контрольной точки; если контрольная точка в силу каких-то обстоятельств не может захватываться, то nil
      gain: number (integer) или nil - прогресс захвата точки
      defendersCount: number (integer) или nil - возвращает число защищающих, если поддерживается стеллой
      attackersCount: number (integer) или nil - возвращает число атакующих, если поддерживается стеллой
      oldMechanics: boolean - true, если используется старая механика

Пример:

    local checkpoints = battleground.GetCheckpoints()
    if checkpoints[0] != nil then
      LogInfo( "1st battleground checkpoint info: ", battleground.GetCheckpointInfo(checkpoints[0]) )
    end

См. также battleground.GetCheckpoints(), battleground.GetAvatarMark(), ENUM_RecapturablePlayerSpawnPlaceState_...

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

BattlegroundMarkId
CategoryBattleground
EnumBattlegroundRecapturablePlayerSpawnPlaceState
EventBattlegroundCheckpointAdded
EventBattlegroundCheckpointRemoved
EventBattlegroundCheckpointsChanged
EventBattlegroundCheckpointStateChanged
FunctionBattlegroundGetAvatarMark
FunctionBattlegroundGetCheckpointInfo
FunctionBattlegroundGetCheckpoints
FunctionBattlegroundGetPlayerMark

CategoryLuaApi CategoryFunction CategoryBattleground

На главную