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

На главную

astral.GetPOIInfo( poiId )

Возвращает информацию о точке астрального эвента по её идентификатору.

-- система:
UIState/GameState
функция имеет основную реализация в логике и расширенную реализацию в UI

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

-- объявление:
function GetPOIInfo( poiId )

-- параметры:
poiId: ObjectId - идентификатор точки

-- возвращаемые значения:
table or nil - если информация доступна, то таблица с полями:
  id: ObjectId - идентификатор точки
  sectorId: ObjectId - идентификатор сектора
  name: WString or nil - название евента
  description: WString or nil - описание евента
  visibleOnMap: boolean - false, если показывать POI только в списке POI для прыжка; true, если надо показывать и на астральной карте
  canJump: boolean - false, если нельзя прыгнуть к этой POI с помощью астролябии. Не надо показывать в списке для прыжка
  --{ часть таблицы, реализованная только для UI
  texture: TextureId - идентификатор текстуры для иконки точки
  --}

-- пример:
local pois = astral.GetAllPOIs()
if pois[ 0 ] then
  local poiInfo = astral.GetPOIInfo( pois[ 0 ] )
  if poiInfo then
    LogInfo( poiInfo.name )
  end
end

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

На главную