WhoLib

Хочешь карту со своим ником? Оформить ❤️

Обновите свою ссылку. Новый репозиторий выглядит следующим образом: https://github.com/sylvanaar/who-lib.git

Смотрите README в репозитории github — форматирование markdown там намного лучше.

LibWho-2.0

Эта документация предназначена для разработчиков, желающих использовать подсистему World of Warcraft /who. Подсистема / who является общим ресурсом для всех аддонов, использующих ее. Используя эту библиотеку, вы гарантируете, что не будете конфликтовать с другими аддонами, использующими подсистему /who

Эта библиотека предоставляет следующие возможности:

• Интерфейс для получения информации о пользователе
• Лучшее событие для тех, кто
• Очередь /who и SendWho()
• Гораздо лучший интерфейс ВОЗ, с гарантией выполнения и обратного вызова

Использование

Существует два способа использования WhoLib: встраивание в объект или прямое использование библиотеки

Встроенный

-- в начале вашего аддона
LibStub:GetLibaray ('LibWho-2.0'): Embed(self)

-- вызов функции внутри метода:
function mod: xxx(...)
собственная личность:сведений о пользователях(...)
конец

Внешний

-- в начале вашего аддона
local wholib = LibStub:GetLibrary ('LibWho-2.0'): библиотека()

-- вызов функции:
wholib:сведений о пользователях(...)

Замечания

Примеры в этой документации используют встроенную версию, но их должно быть легко адаптировать к внешней.

Документация по API

lib:Embed(обработчик)

Аргументы

обработчик
   таблица-встраивание публичных функций/констант в объект, указанный обработчиком
Возвращается
   нуль

Пример

LibStub:GetLibrary ('LibWho-2.0'): Embed(self)

lib: библиотека()

Возвращается
    стол-библиотека
Пример
    LibStub:GetLibrary ('LibWho-2.0'): Библиотека()

:Сведений о пользователях(имя [, ОПЦ])

Аргументы

имя
    string-точное имя игрока
, выбирающего
    необязательно, стол - варианты
ОПЦ.очереди
    необязательно, номер очереди этого запроса (см. ниже) -. WHOLIB_QUEUE_QUIET (по умолчанию) или. WHOLIB_QUEUE_SCANNING
выбирает тайм-аут
    необязательно, количество - если результат кэшируется, и не старше, чем ОПЦ.тайм-аут минут кэше будет возвращено отрицательное значение: всегда используйте кэш (если имеется), в противном случае: отправить запрос, который, по умолчанию: 5 (минут)
ОПЦ.обратного вызова, ОПЦ.обработчик
    необязательно, обратный вызов-см. раздел "Информация о обратном вызове" ниже
opts. flags
    необязательно, номер-один из нескольких флагов или ' вместе взятых, см. Flags (bit. bor(flag1, flag2 [, flag3 [, ...]]))
Возвращается
    ноль, если не было подходящего кэша
    false
см. флаги: 'WHOLIB_FLAG_ALWAYS_CALLBACK`
пользователь, время
    для кэшированных результатов
пользователь
    таблица-информация пользователя
user.Name
    строка-имя
пользователя плеера.Онлайн
    true, если онлайн, false, если оффлайн, nil, если неизвестно (больше результатов, чем может быть отображено)
если Online не соответствует истине, то все следующие записи будут от последнего успешного вызова или нулевого
пользователя.Гильдия
    строка-Гильдия или "
пользователь".Класс
    
пользователь класса string.Гонка
    строка - гонки
пользователей.Уровень
    строка - уровень
пользователей.Зоны
 строка - зоны
время
 количество минут, сколько данных было

Замечания

Если вас интересует только эта функция,то вам не нужно читать о: Who() и WHOLIBQUERYRESULT.
Не используйте .WHOLIB_FLAG_ALWAYS_CALLBACK при сканировании списка снова и снова делайте 5-секундную паузу после кэшированного возврата, потому что у вас может быть короткий список и время кэширования настолько велико, что все записи могут быть кэшированы, и в этом случае эта функция генерирует почти бесконечный цикл!

Обратный звонок

Когда функция обратного вызова задана и функция не вернулась сразу, то обратный вызов будет вызван, когда они будут результатом. Функция обратного вызова получит те же аргументы, что и функция UserInfo ().

Флаги

.WHOLIB_FLAG_ALWAYS_CALLBACK

если :UserInfo() вернет кэшированные данные, немедленно вызовите обратный вызов с этими данными вместо возврата, а затем верните false

Пример

    -- длинная версия
    локальный пользователь, time = self:UserInfo(friendsname, { callback = 'UserDataReturned' } )
    если пользователь, то
    -- данные были немедленно доступны
    self:UserDataReturned(пользователь, время)
    ещё
    -- ничего
    -- нам позвонят, когда будут доступны данные
    конец

    -- короткая версия
    себя:пользовательские данные(friendsname, { обратного вызова = 'UserDataReturned, флаги = собственн.WHOLIB_FLAG_ALWAYS_CALLBACK } )

    -- функция обратного
вызова function mod: UserDataReturned(пользователь, время)
    локальное состояние
, если пользователь.Online = = true then
state = 'Online'
    пользователь elseif.Онлайн == ложь тогда
 государство = 'оффлайн'
    ещё
        -- пользователь.Онлайн-это ноль
        состояние = 'неизвестно'
    конец
    DEFAULT_CHAT_FRAME:AddMessage(user.Имя .. "есть" .. состояние)
    конец

:CachedUserInfo(имя)

Аргументы

имя
    string-точное имя игрока
Возвращается
    ноль, если не было подходящего
пользователя кэша, время
    для кэшированных результатов, идентичных :UserInfo()

:RegisterCallback(событие, обратный вызов [, обработчик])

Аргументы

строка события-событие, которое вы хотите зарегистрировать для
обратного вызова, обработчик
    обратный вызов-см. раздел" Информация о обратном вызове " ниже
Возвращается
    нуль

Пример

см. раздел «События» ниже

:Который(запрос [ , ОПЦ])

Аргументы

запрос
    string-строка поиска
выбирает
    необязательно, стол - варианты
ОПЦ.очереди
    необязательно, номер-очередь этого запроса (см. ниже) - .`WHOLIB_QUEUE_QUIET` (по умолчанию) или .`WHOLIB_QUEUE_USER " или .`WHOLIB_QUEUE_SCANNING`
ОПЦ.обратного вызова, ОПЦ.обработчик
    необязательно, обратный вызов-см. раздел" Информация о обратном вызове " ниже
Возвращается
    нуль

Замечания

Это регистрация события через CallbackHandler-1.0 все, кроме запроса, будет проигнорировано, когда очередь будет .WHOLIB_QUEUE_USER.
Если вы уже зарегистрировали WHOLIB_QUERY_RESULT, то вам, возможно, не нужен обратный вызов.

Обратный звонок

Если задана функция обратного вызова, то она будет вызвана после выполнения запроса. Функция обратного вызова получит те же аргументы, что и событие: WHOLIB_QUERY_RESULT.

Пример

self: Who ({query = 'n-' .. friendsname, queue = self.`WHOLIB_QUERY_QUIET`, callback = 'DisplayPlayers'})
-- self:DisplayPlayers находится в Примере WHOLIB_QUERY_RESULT ниже

Замечания

Если вас интересует только информация об одном игроке, используйте вместо этого :UserInfo (). (Вы можете установить ОПЦ.таймаут в 0, если вы не согласны с кэшированными данными.)

Константы

.WHOLIB_QUEUE_USER
.WHOLIB_QUEUE_QUIET
.WHOLIB_QUEUE_SCANNING
.WHOLIB_FLAG_ALWAYS_CALLBACK

Обратный звонок информация

Некоторые функции WhoLib принимают свою собственную форму обратных вызовов или обратных вызовов через CallbackHandler, у вас всегда есть два способа их использования.

Использование функции

функция обратного вызова-просто укажите на функцию, которая должна быть вызвана
обработчиком
nil - должна быть nil

Пример 1

локальная функция eventmanager (event, a1, a2,...)
-- не имеет "собственного"
конца

wholib:RegisterCallback ('WHOLIB_QUERY_RESULT', eventmanager)

Пример 2

функция mod. eventmanager(event, a1, a2, ...)
-- не имеет "собственного"
конца

wholib:RegisterCallback(‘WHOLIBQUERYRESULT’, mod. eventmanager)

Использование метода

строка обратного вызова - имя метода, который должен быть вызван
обработчиком
    таблица-объект, на котором должен быть вызван метод, если используется вызывающий объект nil

Пример

функция mod: eventmanager(event, a1, a2,...)
    -- имеет "собственный"
конец

mod:RegisterCallback ('WHOLIB_QUERY_RESULT', 'eventmanager')
-- эквивалентно
wholib:RegisterCallback ('WHOLIB_QUERY_RESULT', 'eventmanager', self)

События

Событие: WHOLIB_QUERY_RESULT — запрос, результаты, полное имя

Аргументы

запрос
    string-
Результаты поиска строк
    table-таблица результатов
results [i]. Name
    string-имя результата игрока
[i].Онлайн
    true, если онлайн, false, если оффлайн, nil, если неизвестно (больше результатов, чем может быть отображено)
результаты[i].Гильдия
    string-guild или "
results[i]. Class
    строка - класса
результаты[я].Гонки
    string-race
results[i].Уровень
    
результаты строкового уровня[i]. Zone
string-zone
complete
    boolean-показывает, могут ли быть возвращены все результаты (true) или нет (false), если нет, выполните более конкретное
имя запроса
    string-если запрос был инициирован вызовом :UserInfo (), то это имя игрока вызова :UserInfo (), в противном случае ноль

Замечания

Все эти поля возвращаются при любом вызове «/ who»,» SendWho () » или :Who (), даже когда результаты отображаются в чате.

Пример

функция mod:OnEnable()
...
self:RegisterCallback ('WHOLIB_QUERY_RESULT', 'DisplayPlayers')
...
конец

функция mod:DisplayPlayers(запрос, результаты, полный)
если не полный, то
    DEFAULT_CHAT_FRAME:AddMessage("там было больше игроков, чем здесь показано!")
конец
для _,результат в парах(результаты) делать
    DEFAULT_CHAT_FRAME:AddMessage ('Player' .. result.Название .. в настоящее время в результате...Зоны)
конец
конец

Очереди

WHOLIB_QUEUE_USER

Используется в запросах пользователей (например, «/ who», SocialFrame ‘ s Who)
Результаты будут отображаться в чате, если только некоторые, или в who-frame, если больше.

WHOLIB_QUEUE_QUIET

Должна быть стандартная очередь для запросов аддона, которые не предназначены для сканирования и не приводят к действию Пользователя: use .WHOLIB_QUEUE_USER.
Не будет показывать ни сообщения чата, ни кто-кадр.
Будет медленно, поинтересовался, в то время как WhoFrame работает. (TODO)

WHOLIB_QUEUE_SCANNING

Используйте для сканирования.
Не будет показывать ни сообщения чата, ни кто-кадр.
Не будет запрашиваться, пока открыт WhoFrame. (TODO)

Замечания

Сначала будут выполняться запросы . WHOLIB_QUEUE_USER, затем.WHOLIB_QUEUE_QUIET и, наконец,.WHOLIB_QUEUE_SCANNING.

Отлаживать

Когда отладка включена, чат будет заполнен добавленными / возвращенными записями, по одной для каждого запроса.

21: 01:40 WhoLib: [3] добавлено «n-Lager», очереди=0, 0, 1
21: 01:40 WhoLib: [3] возвращено «n-Lager», total=0, queues=0, 0, 0
[3] означает очередь 3 = WHOLIB_QUEUE_SCANNING, каждый запрос сначала будет «добавлен», а затем» возвращен», при возвращенных запросах также будет напечатано общее количество записей. «Queues=0, 0, 1» означает, что 0 запросов находятся в очереди .WHOLIB_QUEUE_USER, 0 in.WHOLIB_QUEUE_QUIET, и 1 (дополнительное), в .WHOLIB_QUEUE_SCANNING.
For: UserInfo () будет напечатано еще больше записей.

: SetWhoLibDebug(состояние)

Аргументы

государство
    boolean-включает или отключает отладку
Возвращается
    нуль

/wholibdebug
Включение отладки.

Похожие аддоны

MooUnit StatLogicLib MooSpec MooZone