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

На главную

## objects.GetTrackInfo( trackId )

Возвращает описание "отслеживаемого" объекта - Track - в зоне игрока. Такие объекты, например, могут обозначть хорунжего или т.п.

См. также GamePosition - позиция объекта, MutationInfo - информация о мутации.

    -- система:
    UIState - расширенная информация, GameState - базовая информация

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

    -- объявление:
    function GetTrackInfo( trackId )

    -- параметры:
    objectId: ObjectId (not nil) - идентификатор Track-а

    -- возвращаемые значения:
    table or nil - описание объекта. Таблица (если объект найден) с полями:
      id: ObjectId - идентификатор объекта (важно: этот ObjectId не совпадает с ObjectId самого отслеживаемого юнита!)
      text: WString - описание объекта. Может быть шаблоном строки
      playerName: WString - имя объекта (например, игрока)
      position or nil: GamePosition - координаты объекта, если можно получить
      durationMs: number (integer) - сколько миллисекунд полностью длится отслеживание
      remainingMs: number (integer) - сколько миллисекунд осталось до окончания отслеживания
      mutation or nil: MutationInfo - информация о мутации распространяемой данным объектом

      {Часть, доступная только в UI:}
      image: TextureId or nil - текстура с иконкой объекта

    -- пример:
    local trackInfo = objects.GetTrackInfo( trackId )
    if trackInfo then
      local valuedText = common.CreateValuedText()
      valuedText:SetFormat( trackInfo.text )
      valuedText:SetVal( "name", trackInfo.playerName )
    end

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

CategoryObjects
EventTrackAdded
EventTrackPosChanged
EventTrackRemoved
FunctionObjectsGetTrackInfo
FunctionObjectsGetTracks

CategoryLuaApi CategoryFunction CategoryObjects

На главную