Инструменты пользователя
help:qspider_inclib
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Следущая версия | Предыдущая версия | ||
|
help:qspider_inclib [2024/03/13 12:18] aleks_versus создано |
help:qspider_inclib [2024/10/26 17:01] (текущий) aleks_versus |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | ====== Встроенная библиотека ''qspider'' ====== | + | ====== Встроенная библиотека qspider ====== |
| В плеер **qSpider** втроена специальная библиотека ''qspider'', которая содержит набор функций для управления интерфейсом вашей игры. | В плеер **qSpider** втроена специальная библиотека ''qspider'', которая содержит набор функций для управления интерфейсом вашей игры. | ||
| Строка 5: | Строка 5: | ||
| Чтобы воспользоваться функциями библиотеки, её нужно подключить, как [[help:modules|обычный модуль QSP]], написав, например в самой первой локации в игре команду: | Чтобы воспользоваться функциями библиотеки, её нужно подключить, как [[help:modules|обычный модуль QSP]], написав, например в самой первой локации в игре команду: | ||
| - | <sxh qsp>inclib 'qspider'</sxh> | + | <sxh qsp> |
| + | inclib 'qspider' | ||
| + | </sxh> | ||
| Все функции библиотеки вызываются из кода QSP. | Все функции библиотеки вызываются из кода QSP. | ||
| Строка 13: | Строка 15: | ||
| Данные функции позволяют управлять поведением плеера прямо из кода QSP. | Данные функции позволяют управлять поведением плеера прямо из кода QSP. | ||
| - | * ''qspider_quit'' — выход из игры на полку игр. <sxh qsp>@qspider_quit()</sxh> | + | * ''qspider_quit'' — выход из игры на полку игр. <sxh qsp> |
| - | * ''qspider_restart'' — перезапуск текущей игры. <sxh qsp>@qspider_restart()</sxh> | + | @qspider_quit() |
| - | * ''qspider_resume'' — продолжить игру (закрыть меню паузы). <sxh qsp>@qspider_resume()</sxh> | + | </sxh> |
| - | * ''qspider_mute'' — Выключить звук. <sxh qsp>@qspider_mute()</sxh> | + | * ''qspider_restart'' — перезапуск текущей игры. <sxh qsp> |
| - | * ''qspider_unmute'' — Включить звук. <sxh qsp>@qspider_unmute()</sxh> | + | @qspider_restart() |
| - | * ''qspider_toggle_mute'' — Переключить звук. <sxh qsp>@qspider_toggle_mute()</sxh> | + | </sxh> |
| - | * ''qspider_quicksave'' — Переключить звук. <sxh qsp>@qspider_quicksave()</sxh> | + | * ''qspider_resume'' — продолжить игру (закрыть меню паузы). <sxh qsp> |
| - | * ''qspider_quickload'' — Переключить звук. <sxh qsp>@qspider_quickload()</sxh> | + | @qspider_resume() |
| - | * ''qspider_open_pause_screen'' — открыть меню паузы. Аргументы ''$args[0]'': | + | </sxh> |
| - | * ''saves'' — меню сохранений. <sxh qsp>@qspider_open_pause_screen('saves')</sxh> | + | * ''qspider_mute'' — Выключить звук. <sxh qsp> |
| - | * ''preferences'' — меню настроек. <sxh qsp>@qspider_open_pause_screen('preferences')</sxh> | + | @qspider_mute() |
| - | * без аргументов — основной раздел меню паузы. <sxh qsp>@qspider_open_pause_screen()</sxh> | + | </sxh> |
| - | * ''qspider_scroll' — прокрутить окно (вверх или вниз). Аргументы: | + | * ''qspider_unmute'' — Включить звук. <sxh qsp> |
| - | * ''$args[0]'' — указать окно: | + | @qspider_unmute() |
| - | * ''main'' — окно основного описания. <sxh qsp>@qspider_scroll('main', 'bottom')</sxh> | + | </sxh> |
| - | * ''stats'' — окно дополнительного описания. <sxh qsp>@qspider_scroll('stats', 'bottom')</sxh> | + | * ''qspider_toggle_mute'' — Переключить звук. <sxh qsp> |
| - | * ''$args[1]'' — указать направление: | + | @qspider_toggle_mute() |
| - | * ''top'' — прокрутить до верха. <sxh qsp>@qspider_scroll('main', 'top')</sxh> | + | </sxh> |
| - | * ''bottom'' — прокрутить до низа. <sxh qsp>@qspider_scroll('main', 'bottom')</sxh> | + | * ''qspider_quicksave'' — Быстро сохранить игру. <sxh qsp> |
| + | @qspider_quicksave() | ||
| + | </sxh> | ||
| + | * ''qspider_quickload'' — Загрузить быстрое сохранение. <sxh qsp> | ||
| + | @qspider_quickload() | ||
| + | </sxh> | ||
| + | * ''qspider_open_pause_screen'' — открыть меню паузы. Аргументы ''%%$args[0]%%'': | ||
| + | * ''%%saves%%'' — меню сохранений. <sxh qsp> | ||
| + | @qspider_open_pause_screen('saves') | ||
| + | </sxh> | ||
| + | * ''%%preferences%%'' — меню настроек. <sxh qsp> | ||
| + | @qspider_open_pause_screen('preferences') | ||
| + | </sxh> | ||
| + | * без аргументов — основной раздел меню паузы. <sxh qsp> | ||
| + | @qspider_open_pause_screen() | ||
| + | </sxh> | ||
| + | * ''qspider_scroll'' — прокрутить окно (вверх или вниз). Аргументы: | ||
| + | * ''%%$args[0]%%'' — указать окно: | ||
| + | * ''%%main%%'' — окно основного описания. <sxh qsp> | ||
| + | @qspider_scroll('main', 'bottom') | ||
| + | </sxh> | ||
| + | * ''%%stats%%'' — окно дополнительного описания. <sxh qsp> | ||
| + | @qspider_scroll('stats', 'bottom') | ||
| + | </sxh> | ||
| + | * ''%%$args[1]%%'' — указать направление: | ||
| + | * ''%%top%%'' — прокрутить до верха. <sxh qsp> | ||
| + | @qspider_scroll('main', 'top') | ||
| + | </sxh> | ||
| + | * ''%%bottom%%'' — прокрутить до низа. <sxh qsp> | ||
| + | @qspider_scroll('main', 'bottom') | ||
| + | </sxh> | ||
| ===== Управление темами ===== | ===== Управление темами ===== | ||
| Строка 37: | Строка 69: | ||
| Вы можете переключать созданные заранее [[help:qspider_themes|темы оформления]], используя встроенную функцию библиотеки: | Вы можете переключать созданные заранее [[help:qspider_themes|темы оформления]], используя встроенную функцию библиотеки: | ||
| - | * ''qspider_change_theme' — включить указанную тему оформления.<sxh qsp>@qspider_change_theme('dark-theme')</sxh> Аргументом указывается название темы. | + | * ''qspider_change_theme'' — включить указанную тему оформления. <sxh qsp> |
| + | @qspider_change_theme('dark-theme') | ||
| + | </sxh> Аргументом указывается название темы. | ||
| ===== Управление слоями ===== | ===== Управление слоями ===== | ||
| Строка 45: | Строка 79: | ||
| Пример слоя: | Пример слоя: | ||
| - | <sxh html><qsp-layer name="layer1" index="10">Some UI</qsp-layer></sxh> | + | <sxh html> |
| + | <qsp-layer name="layer1" index="10">Some UI</qsp-layer> | ||
| + | </sxh> | ||
| - | * ''qspider_show_layer' — показать слой на экране.<sxh qsp>@qspider_show_layer('layer1')</sxh> В качестве аргумента передаётся название слоя, соответствующее значению атрибута ''name''. | + | * ''qspider_show_layer'' — показать слой на экране. <sxh qsp> |
| - | * ''qspider_hide_layer' — скрыть слой с экрана.<sxh qsp>@qspider_hide_layer('layer1')</sxh> В качестве аргумента передаётся название слоя. | + | @qspider_show_layer('layer1') |
| - | * ''qspider_show_only_layer' — показать указанный слой, а остальные скрыть.<sxh qsp>@qspider_show_only_layer('layer1')</sxh> В качестве аргумента передаётся название слоя. | + | </sxh> В качестве аргумента передаётся название слоя, соответствующее значению атрибута ''%%name%%''. |
| + | * ''qspider_hide_layer'' — скрыть слой с экрана. <sxh qsp> | ||
| + | @qspider_hide_layer('layer1') | ||
| + | </sxh> В качестве аргумента передаётся название слоя. | ||
| + | * ''qspider_show_only_layer'' — показать указанный слой, а остальные скрыть. <sxh qsp> | ||
| + | @qspider_show_only_layer('layer1') | ||
| + | </sxh> В качестве аргумента передаётся название слоя. | ||
| ===== Управление регионами ===== | ===== Управление регионами ===== | ||
| Строка 57: | Строка 99: | ||
| Пример региона: | Пример региона: | ||
| - | <sxh html><qsp-region name="region1"></qsp-region></sxh> | + | <sxh html> |
| + | <qsp-region name="region1"></qsp-region> | ||
| + | </sxh> | ||
| - | * ''qspider_update_region' — полностью перезаписать содержимое региона.<sxh qsp>@qspider_update_region('region1', '<b>Текст</b>')</sxh> Аргументы: | + | * ''qspider_update_region'' — полностью перезаписать содержимое региона. <sxh qsp> |
| - | * ''$args[0]'' — название региона. | + | @qspider_update_region('region1', '<b>Текст</b>') |
| - | * ''$args[1]'' — новое содержимое региона. | + | </sxh> Аргументы: |
| - | * ''qspider_prepend_region' — вставить содержимое в начало региона.<sxh qsp>@qspider_prepend_region('region1', 'Текст<br>')</sxh> Аргументы: | + | * ''%%$args[0]%%'' — название региона. |
| - | * ''$args[0]'' — название региона. | + | * ''%%$args[1]%%'' — новое содержимое региона. |
| - | * ''$args[1]'' — добавляемое содержимое региона. | + | * ''qspider_prepend_region'' — вставить содержимое в начало региона. <sxh qsp> |
| - | * ''qspider_append_region' — вставить содержимое в начало региона.<sxh qsp>@qspider_append_region('region1', '<br>Конец')</sxh> Аргументы: | + | @qspider_prepend_region('region1', 'Текст<br>') |
| - | * ''$args[0]'' — название региона. | + | </sxh> Аргументы: |
| - | * ''$args[1]'' — добавляемое содержимое региона. | + | * ''%%$args[0]%%'' — название региона. |
| - | * ''qspider_scroll_region' — прокрутить регион. Аргументы: | + | * ''%%$args[1]%%'' — добавляемое содержимое региона. |
| - | * ''$args[0]'' — название региона. | + | * ''qspider_append_region'' — вставить содержимое в конец региона. <sxh qsp> |
| - | * ''$args[1]'' — направление прокрутки: | + | @qspider_append_region('region1', '<br>Конец') |
| - | * ''top'' — прокрутить до верха. <sxh qsp>@qspider_scroll_region('region1', 'top')</sxh> | + | </sxh> Аргументы: |
| - | * ''bottom'' — прокрутить до низа. <sxh qsp>@qspider_scroll_region('region1', 'bottom')</sxh> | + | * ''%%$args[0]%%'' — название региона. |
| - | * ''qspider_clear_region' — очистить содержимое региона.<sxh qsp>@qspider_clear_region('region1')</sxh> В качестве аргумента передаётся название региона. | + | * ''%%$args[1]%%'' — добавляемое содержимое региона. |
| + | * ''qspider_scroll_region'' — прокрутить регион. Аргументы: | ||
| + | * ''%%$args[0]%%'' — название региона. | ||
| + | * ''%%$args[1]%%'' — направление прокрутки: | ||
| + | * ''%%top%%'' — прокрутить до верха. <sxh qsp> | ||
| + | @qspider_scroll_region('region1', 'top') | ||
| + | </sxh> | ||
| + | * ''%%bottom%%'' — прокрутить до низа. <sxh qsp> | ||
| + | @qspider_scroll_region('region1', 'bottom') | ||
| + | </sxh> | ||
| + | * ''qspider_clear_region'' — очистить содержимое региона. <sxh qsp> | ||
| + | @qspider_clear_region('region1') | ||
| + | </sxh> В качестве аргумента передаётся название региона. | ||
| - | ===== Вызов событий на объекте ''window'' ===== | + | ===== Вызов событий на объекте window ===== |
| - | При необходимости вы можете вызвать на объекте ''window'' браузера/плеера событие с указанным именем. Это позволит, например, в нужный момент запустить JavaScript. | + | При необходимости вы можете вызвать на объекте ''%%window%%'' браузера/плеера событие с указанным именем. Это позволит, например, в нужный момент запустить JavaScript. |
| Команда для вызова события из кода QSP: | Команда для вызова события из кода QSP: | ||
| * ''qspider_event'' — вызывает событие с указанным именем. Аргументы: | * ''qspider_event'' — вызывает событие с указанным именем. Аргументы: | ||
| - | * ''$args[0]'' — имя события, которое нужно вызвать. | + | * ''%%$args[0]%%'' — имя события, которое нужно вызвать. |
| - | * ''args[1] ... args[18]'' — числовые и текстовые аргументы, которые нужно передать в событие. | + | * ''%%args[1] ... args[18]%%'' — числовые и текстовые аргументы, которые нужно передать в событие. |
| Примеры вызова событий: | Примеры вызова событий: | ||
| Строка 91: | Строка 147: | ||
| @qspider_event('event_with_args', 1, "test") & ! с аргументами | @qspider_event('event_with_args', 1, "test") & ! с аргументами | ||
| </sxh> | </sxh> | ||
| - | |||
| Также, см. статью: [[https://ifhub.club/2021/05/23/qspider-0100.html|qSpider v.0.10.0]] | Также, см. статью: [[https://ifhub.club/2021/05/23/qspider-0100.html|qSpider v.0.10.0]] | ||
| + | |||
| + | ===== Другие статьи по qSpider ===== | ||
| + | |||
| + | * [[help:qspider|qSpider — общая информация]] | ||
| + | * [[help:qspider_gamecfg|Конфигурационный файл]] | ||
| + | * [[help:qspider_aeroqsp|Особенности запуска и работы игр AeroQSP на qSpider]] | ||
| + | * [[help:qspider_interface|Взаимодействие с интерфейсом]] | ||
| + | * [[help:qspider_themes|Темы оформления]] | ||
| + | * [[help:qspider_spectags|Специальные теги]] | ||
| + | * [[help:qspider_standalone|Стандалон-сборка игры на qSpider]] | ||
| + | |||
help/qspider_inclib.1710332339.txt.gz · Последние изменения: 2024/03/13 12:18 — aleks_versus