Инструменты пользователя

Инструменты сайта


Боковая панель

help:qspider_inclib

Это старая версия документа.


Встроенная библиотека ''qspider''

В плеер qSpider втроена специальная библиотека qspider, которая содержит набор функций для управления интерфейсом вашей игры.

Чтобы воспользоваться функциями библиотеки, её нужно подключить, как обычный модуль QSP, написав, например в самой первой локации в игре команду:

inclib 'qspider'

Все функции библиотеки вызываются из кода QSP.

Команды плеера

Данные функции позволяют управлять поведением плеера прямо из кода QSP.

  • qspider_quit — выход из игры на полку игр.
    @qspider_quit()
  • qspider_restart — перезапуск текущей игры.
    @qspider_restart()
  • qspider_resume — продолжить игру (закрыть меню паузы).
    @qspider_resume()
  • qspider_mute — Выключить звук.
    @qspider_mute()
  • qspider_unmute — Включить звук.
    @qspider_unmute()
  • qspider_toggle_mute — Переключить звук.
    @qspider_toggle_mute()
  • qspider_quicksave — Переключить звук.
    @qspider_quicksave()
  • qspider_quickload — Переключить звук.
    @qspider_quickload()
  • qspider_open_pause_screen — открыть меню паузы. Аргументы $args[0]:
    • saves — меню сохранений.
      @qspider_open_pause_screen('saves')
    • preferences — меню настроек.
      @qspider_open_pause_screen('preferences')
    • без аргументов — основной раздел меню паузы.
      @qspider_open_pause_screen()
  • qspider_scroll — прокрутить окно (вверх или вниз). Аргументы:
    • $args[0] — указать окно:
      • main — окно основного описания.
        @qspider_scroll('main', 'bottom')
      • stats — окно дополнительного описания.
        @qspider_scroll('stats', 'bottom')
    • $args[1] — указать направление:
      • top — прокрутить до верха.
        @qspider_scroll('main', 'top')
      • bottom — прокрутить до низа.
        @qspider_scroll('main', 'bottom')

Управление темами

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

  • qspider_change_theme' — включить указанную тему оформления.<sxh qsp>@qspider_change_theme('dark-theme')</sxh> Аргументом указывается название темы. ===== Управление слоями ===== Эти функции позволяют управлять поведением слоёв, созданных с помощью специальных тегов qsp-layer. По умолчанию все слои скрыты. Пример слоя: <sxh html><qsp-layer name="layer1" index="10">Some UI</qsp-layer></sxh> * qspider_show_layer' — показать слой на экране.
    @qspider_show_layer('layer1')
    В качестве аргумента передаётся название слоя, соответствующее значению атрибута name.
  • qspider_hide_layer' — скрыть слой с экрана.<sxh qsp>@qspider_hide_layer('layer1')</sxh> В качестве аргумента передаётся название слоя. * qspider_show_only_layer' — показать указанный слой, а остальные скрыть.
    @qspider_show_only_layer('layer1')
    В качестве аргумента передаётся название слоя.

Управление регионами

Данные функции позволяют управлять поведением регионов, созданных с помощью специального тега qsp-region.

Пример региона:

<qsp-region name="region1"></qsp-region>

  • qspider_update_region' — полностью перезаписать содержимое региона.<sxh qsp>@qspider_update_region('region1', '<b>Текст</b>')</sxh> Аргументы: * $args[0] — название региона. * $args[1] — новое содержимое региона. * qspider_prepend_region' — вставить содержимое в начало региона.
    @qspider_prepend_region('region1', 'Текст<br>')
    Аргументы:
    • $args[0] — название региона.
    • $args[1] — добавляемое содержимое региона.
  • qspider_append_region' — вставить содержимое в начало региона.<sxh qsp>@qspider_append_region('region1', '<br>Конец')</sxh> Аргументы: * $args[0] — название региона. * $args[1] — добавляемое содержимое региона. * qspider_scroll_region' — прокрутить регион. Аргументы:
    • $args[0] — название региона.
    • $args[1] — направление прокрутки:
      • top — прокрутить до верха.
        @qspider_scroll_region('region1', 'top')
      • bottom — прокрутить до низа.
        @qspider_scroll_region('region1', 'bottom')
  • qspider_clear_region' — очистить содержимое региона.<sxh qsp>@qspider_clear_region('region1')</sxh> В качестве аргумента передаётся название региона. ===== Вызов событий на объекте window ===== При необходимости вы можете вызвать на объекте window браузера/плеера событие с указанным именем. Это позволит, например, в нужный момент запустить JavaScript. Команда для вызова события из кода QSP: * qspider_event — вызывает событие с указанным именем. Аргументы: * $args[0] — имя события, которое нужно вызвать. * args[1] … args[18]'' — числовые и текстовые аргументы, которые нужно передать в событие.

Примеры вызова событий:

@qspider_event('test_event') & ! вызов события без аргументов
@qspider_event('event_with_args', 1, "test") & ! с аргументами

Также, см. статью: qSpider v.0.10.0

help/qspider_inclib.1710332364.txt.gz · Последние изменения: 2024/03/13 12:19 — aleks_versus