Специальные параграфы Sugarcube: различия между версиями

Материал из IFВики
Перейти к навигации Перейти к поиску
← Предыдущая правка
Содержимое удалено Содержимое добавлено
ВизуальныйВики-текст
мНет описания правки
 
(не показано 5 промежуточных версий этого же участника)
Строка 1: Строка 1:
* Оригинал: [http://www.motoslave.net/sugarcube/2/docs/special-names.html Special Names]
* Оригинал: [http://www.motoslave.net/sugarcube/2/docs/special-names.html Special Names]
* Черновик перевода: [https://github.com/Wol4ik/Wol4ik.github.io/blob/master/twine2_engine/tw2_doc_enola.md Enola, Wol4ik]
* Черновик перевода: [https://github.com/Wol4ik/Wol4ik.github.io/blob/master/twine2_engine/tw2_doc_enola.md Enola, Wol4ik], 2018


Этот раздел посвящён специальным названиям параграфов, тегов и переменных, которые имеют особое значения для SugarCube.
Этот раздел посвящён специальным названиям параграфов, тегов и переменных, которые имеют особое значения для SugarCube.
Строка 59: Строка 59:
'''Twine 2:''' Не является специальным параграфом. Любой параграф может быть выбран в качестве стартового, путём отметки (иконка ракеты) в контекстном меню параграфа
'''Twine 2:''' Не является специальным параграфом. Любой параграф может быть выбран в качестве стартового, путём отметки (иконка ракеты) в контекстном меню параграфа


=== StoryAuthor ===
'''Twine 1:''' ''Required.'' The starting passage, the first passage displayed. Configurable, see [http://www.motoslave.net/sugarcube/2/docs/config-object.html#config-passages-start Config.passages.start] for more information.


Устанавливает авторскую подпись на панели пользовательского интерфейса (ID элемента: story-author)
'''Twine 2:''' ''Not special.'' Any passage may be chosen as the starting passage by marking it via the (rocket ship icon) passage context-menu item.


=== StoryBanner ===
StoryAuthor Устанавливает авторскую подпись на панели пользовательского интерфейса (ID элемента: story-author)


Устанавливает баннер истории на панели пользовательского интерфейса (ID элемента: story-banner)
Sets the authorial byline in the UI bar (element ID: story-author).


=== StoryCaption ===
StoryBanner Устанавливает баннер истории на панели пользовательского интерфейса (ID элемента: story-banner)


Устанавливает заглавие истории на панели пользовательского интерфейса (ID элемента: story-caption).
Sets the story's banner in the UI bar (element ID: story-banner).


=== StoryInit ===
StoryCaption Устанавливает заглавие истории на панели пользовательского интерфейса (ID элемента: (ID элемента: story-caption).


Используются для задач перед запуском инициализации истории, например, инициализации переменных (происходящей в начале инициализации истории)
Sets the story's caption in the UI bar (element ID: story-caption).


=== StoryInterface ===
StoryInit Используются для задач перед запуском инициализации истории, например, инициализации переменных (происходящей в начале инициализации истории)


''Добавлено в: v2.18.0''
Used for pre-story-start initialization tasks, like variable initialization (happens at the beginning of story initialization).


StoryInterface Добавлено в: v2.18.0 Используется, чтобы заменить панель пользовательского интерфейса SugarCube по умолчанию. Его содержимое обрабатывается как обычная HTML-разметка и должно содержать элемент с ID passages, который будет главным пространством отображаемой зоны и чьё содержимое будет заменяться каждый ход. Например:
Используется, чтобы заменить панель пользовательского интерфейса SugarCube по умолчанию. Его содержимое обрабатывается как обычная HTML-разметка и должно содержать элемент с ID passages, который будет главным пространством отображаемой зоны и чьё содержимое будет заменяться каждый ход. Например:


<div id="passages"></div>
<div id="passages"></div>


=== StoryMenu ===
Used to replace SugarCube's default UI. Its contents are processed as regular HTML markup and it must contain an element with the ID passages, which will be the main passage display area and whose contents will be replaced each turn. For example:


Устанавливает пункты меню истории на панели пользовательского интерфейса. (ID элемента: menu-story).
&lt;div id=&quot;passages&quot;&gt;&lt;/div&gt;


StoryMenu Устанавливает пункты меню истории на панели пользовательского интерфейса. (ID элемента: menu-story). '''Примечание:''' меню истории отображает только ссылки. Пока оно передаёт содержимое как любой другой параграф, вместо отображения выводимого как есть, оно пропускается через вывод и строит своё меню из сгенерированных ссылок, содержащихся в нём.
'''Примечание:''' меню истории отображает только ссылки. Пока оно передаёт содержимое как любой другой параграф, вместо отображения выводимого как есть, оно пропускается через вывод и строит своё меню из сгенерированных ссылок, содержащихся в нём.


=== StorySettings ===
Sets the story's menu items in the UI bar (element ID: menu-story).


В Sugarcube '''не используется.''' [http://www.motoslave.net/sugarcube/2/docs/config-object.html Configuration Object] выполняет те же базовые функции.
'''NOTE:''' The story menu only displays links. While it renders content just as any other passage does, instead of displaying the rendered output as-is, it sifts through the output and builds its menu from the generated links contained therein.


=== StoryShare ===
StorySettings Не используется. [http://www.motoslave.net/sugarcube/2/docs/config-object.html Configuration Object] выполняет те же базовые функции. ''Unused.'' The [http://www.motoslave.net/sugarcube/2/docs/config-object.html Configuration Object] serves the same basic purpose.


StoryShare Используются для распространения контента через меню Поделиться (Share). Понимает только ссылки. Used to populate the contents of the Share dialog.
Используются для распространения контента через меню Поделиться (Share). Понимает только ссылки.


=== StorySubtitle ===
StorySubtitle Устанавливает подзаголовок истории на панели пользовательского интерфейса (ID элемента: story-subtitle).


Устанавливает подзаголовок истории на панели пользовательского интерфейса (ID элемента: story-subtitle).
Sets the story's subtitle in the UI bar (element ID: story-subtitle).


=== StoryTitle ===
StoryTitle '''Twine 1:''' Необходим. Устанавливает заголовок истории на панели пользовательского интерфейса и повсюду. (ID элемента: story-title). Примечание: в заголовке должен быть чистый текст названия проекта и никакой разметки. '''Twine 2:''' Не используется. Заголовок/название истории – это часть проекта истории. '''Twine 1:''' ''Required.'' Sets the story's title in the UI bar and elsewhere (element ID: story-title). '''NOTE:''' The story title should the project's plain text title and contain no markup. '''Twine 2:''' ''Unused.'' The story's title/name is part of the story project. Tag Names (Специальные теги)


'''Twine 1:''' Необходим. Устанавливает заголовок истории на панели пользовательского интерфейса и повсюду. (ID элемента: story-title). Примечание: в заголовке должен быть чистый текст названия проекта и никакой разметки.
bookmark Отмечает параграф для меню «Перейти На» (''Jump To'' ) после того, как этот параграф посещён. Registers the passage into the ''Jump To'' menu.


'''Twine 2:''' Не используется. Заголовок/название истории – это часть проекта истории.
nobr Заменяет все переводы строк в параграфе (через Enter) на единичные пробелы. Равнозначен макросу [http://www.motoslave.net/sugarcube/2/docs/macros.html#macros-nobr &lt;&lt;nobr&gt;&gt;], применённому на весь параграф. См. [http://www.motoslave.net/sugarcube/2/docs/config-object.html#config-passages-nobr Config.passages.nobr], чтобы применить это свойство ко всем отображаемым параграфам истории.


== Специальные теги ==
Causes leading/trailing newlines to be removed and all remaining sequences of newlines to be replaced with single spaces before the passage is rendered. Equivalent to a full-passage [http://www.motoslave.net/sugarcube/2/docs/macros.html#macros-nobr &lt;&lt;nobr&gt;&gt;]. See [http://www.motoslave.net/sugarcube/2/docs/config-object.html#config-passages-nobr Config.passages.nobr] for a way to apply the same processing to all rendering passages.


=== bookmark ===
script '''Twine 1:''' Отмечает параграф как код JavaScript, который выполняется при запуске. '''Twine 2:''' Не специальный. Используйте для скриптов пункт «Редактировать ''JavaScript»'' в меню редактора истории. '''Twine 1:''' Registers the passage as JavaScript code, which is executed during startup. '''Twine 2:''' ''Not special.'' Use the ''Edit Story JavaScript'' story editor menu item for scripts.


Отмечает параграф для меню «Перейти На» (''Jump To'' ) после того, как этот параграф посещён.
stylesheet '''Twine 1:''' Отмечает параграф как Каскадную таблицу стилей (CSS), которая загружается при запуске истории. Настоятельно рекомендуется использовать только один параграф таблицы стилей в истории. Дополнительно, смотрите [http://www.motoslave.net/sugarcube/2/docs/css.html#tagged-stylesheet-warning tagged stylesheet warning]. '''Twine 2:''' Не специальный. Используйте для стилей пункт «Редактировать таблицу стилей» в меню редактора истории. '''Twine 1:''' Registers the passage as a CSS stylesheet, which is loaded during startup. It is '''strongly''' recommended that you use only one stylesheet passage. Additionally, see the [http://www.motoslave.net/sugarcube/2/docs/css.html#tagged-stylesheet-warning tagged stylesheet warning]. '''Twine 2:''' ''Not special.'' Use the ''Edit Story Stylesheet'' story editor menu item for styles.


=== nobr ===
widget Отмечает параграф как [http://www.motoslave.net/sugarcube/2/docs/macros.html#macros-widget &lt;&lt;widget&gt;&gt;] , который загружается во время запуска.


Заменяет все переводы строк в параграфе (через Enter) на единичные пробелы. Равнозначен макросу [http://www.motoslave.net/sugarcube/2/docs/macros.html#macros-nobr <nowiki><<nobr>></nowiki>], применённому на весь параграф. См. [http://www.motoslave.net/sugarcube/2/docs/config-object.html#config-passages-nobr Config.passages.nobr], чтобы применить это свойство ко всем отображаемым параграфам истории.
Registers the passage as [http://www.motoslave.net/sugarcube/2/docs/macros.html#macros-widget &lt;&lt;widget&gt;&gt;] definitions, which are loaded during startup.


=== script ===
== Variable Names (Специальные переменные) ==


'''Twine 1:''' Отмечает параграф как код JavaScript, который выполняется при запуске.
= $ =


'''Twine 2:''' Не специальный. Используйте для скриптов пункт «Редактировать ''JavaScript»'' в меню редактора истории.
Псевдоним для jQuery, по умолчанию. Примечание: Не путайте с переменными истории, которые начинаются с $ (например: $переменная).


=== stylesheet ===
Alias for jQuery, by default. '''NOTE:''' This should not be confused with [http://www.motoslave.net/sugarcube/2/docs/twinescript.html#variables story variables], which start with a $ (e.g. $foo).


'''Twine 1:''' Отмечает параграф как Каскадную таблицу стилей (CSS), которая загружается при запуске истории. Настоятельно рекомендуется использовать только один параграф таблицы стилей в истории. Дополнительно, смотрите [http://www.motoslave.net/sugarcube/2/docs/css.html#tagged-stylesheet-warning tagged stylesheet warning].
= $args =


'''Twine 2:''' Не специальный. Используйте для стилей пункт «Редактировать таблицу стилей» в меню редактора истории.
Массив параметров виджета (только внутри виджетов). См. [http://www.motoslave.net/sugarcube/2/docs/macros.html#macros-widget &lt;&lt;widget&gt;&gt;] для детальной информации.


=== widget ===
Widget arguments array (only inside widgets). See [http://www.motoslave.net/sugarcube/2/docs/macros.html#macros-widget &lt;&lt;widget&gt;&gt;] for more information.


Отмечает параграф как [http://www.motoslave.net/sugarcube/2/docs/macros.html#macros-widget &lt;&lt;widget&gt;&gt;] , который загружается во время запуска.
= Config =


== Специальные переменные ==
Объект настроек. См. [http://www.motoslave.net/sugarcube/2/docs/config-object.html Configuration Object] для детальной информации.


=== $ ===
Configuration object. See [http://www.motoslave.net/sugarcube/2/docs/config-object.html Configuration Object] for more information.


Псевдоним для jQuery по умолчанию. Примечание: Не путайте с переменными истории, которые начинаются с $ (например: <code>$переменная</code>).
= Dialog =


=== $args ===
Диалоговое API. См. [http://www.motoslave.net/sugarcube/2/docs/api-dialog.html Dialog API] для детальной информации.


Dialog API. See [http://www.motoslave.net/sugarcube/2/docs/api-dialog.html Dialog API] for more information.
Массив параметров виджета (только внутри виджетов). См. [http://www.motoslave.net/sugarcube/2/docs/macros.html#macros-widget &lt;&lt;widget&gt;&gt;].


= Engine =
=== Config ===


API движка. См. [http://www.motoslave.net/sugarcube/2/docs/api-engine.html Engine API] для детальной информации.
Объект настроек. См. [http://www.motoslave.net/sugarcube/2/docs/config-object.html Configuration Object].


=== Dialog ===
Engine API. See [http://www.motoslave.net/sugarcube/2/docs/api-engine.html Engine API] for more information.


Диалоговое API. См. [http://www.motoslave.net/sugarcube/2/docs/api-dialog.html Dialog API].
= jQuery =


=== Engine ===
Функция библиотеки jQuery


API движка. См. [http://www.motoslave.net/sugarcube/2/docs/api-engine.html Engine API].
jQuery library function.


= l10nStrings =
=== jQuery ===


Функция библиотеки jQuery.
Добавлено в: v2.10.0


=== l10nStrings ===
Строки локализации объекта. См. [http://www.motoslave.net/sugarcube/2/docs/localization.html Localization] для детальной информации.


''Добавлено в: v2.10.0''
Strings localization object. See [http://www.motoslave.net/sugarcube/2/docs/localization.html Localization] for more information.


Строки локализации объекта. См. [http://www.motoslave.net/sugarcube/2/docs/localization.html Localization].
= LoadScreen =


=== LoadScreen ===
Добавлено в: v2.15.0


''Добавлено в: v2.15.0''
API экрана загрузки. См. [http://www.motoslave.net/sugarcube/2/docs/api-loadscreen.html LoadScreen API] для детальной информации.


LoadScreen API. See [http://www.motoslave.net/sugarcube/2/docs/api-loadscreen.html LoadScreen API] for more information.
API экрана загрузки. См. [http://www.motoslave.net/sugarcube/2/docs/api-loadscreen.html LoadScreen API].


= Macro =
=== Macro ===


API макросов. См. [http://www.motoslave.net/sugarcube/2/docs/api-macro.html Macro API] для детальной информации.
API макросов. См. [http://www.motoslave.net/sugarcube/2/docs/api-macro.html Macro API].


=== Passage ===
Macro API. See [http://www.motoslave.net/sugarcube/2/docs/api-macro.html Macro API] for more information.


API параграфа. См. [http://www.motoslave.net/sugarcube/2/docs/api-passage.html Passage API].
= Passage =


=== postdisplay ===
API параграфа. См. [http://www.motoslave.net/sugarcube/2/docs/api-passage.html Passage API] для детальной информации.


Объект обратного вызова задачи после отображения параграфа, устанавливаемый автором/разработчиком. См. [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects].
Passage API. See [http://www.motoslave.net/sugarcube/2/docs/api-passage.html Passage API] for more information.


= postdisplay =
=== postrender ===


Объект обратного вызова задачи после отображения параграфа, устанавливаемый автором/разработчиком. См. [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects]для детальной информации.
Объект обратного вызова задачи после отрисовки параграфа, устанавливаемый автором/разработчиком.См. [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects].


=== predisplay ===
Post-display task callback object, set up by the author/developer. See [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects] for more information.


Pre-display task callback object, set up by the author/developer. См. [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects].
= postrender =


=== prehistory ===
Объект обратного вызова задачи после отрисовки параграфа, устанавливаемый автором/разработчиком.См. [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects]для детальной информации.


Post-render task callback object, set up by the author/developer. See [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects] for more information.
Pre-history task callback object, set up by the author/developer. См. [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects].


= predisplay =
=== prerender ===


См. [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects]для детальной информации.
Pre-render task callback object, set up by the author/developer. См. [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects]


=== Save ===
Pre-display task callback object, set up by the author/developer. See [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects] for more information.


API сохранений. См. [http://www.motoslave.net/sugarcube/2/docs/api-save.html Save API].
= prehistory =


=== Setting ===
Pre-history task callback object, set up by the author/developer. See [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects] for more information.


API настройки. См. [http://www.motoslave.net/sugarcube/2/docs/api-setting.html Setting API].
= prerender =


=== settings ===
Pre-render task callback object, set up by the author/developer. See [http://www.motoslave.net/sugarcube/2/docs/passage-events-task-objects.html#task-objects Task Objects] for more information.


Объект настроек игрока, устанавливаемый автором/разработчиком. См. [http://www.motoslave.net/sugarcube/2/docs/api-setting.html Setting API].
= Save =


=== setup ===
API сохранений. См. [http://www.motoslave.net/sugarcube/2/docs/api-save.html Save API] для детальной информации.

Save API. See [http://www.motoslave.net/sugarcube/2/docs/api-save.html Save API] for more information.

= Setting =

API настройки. См. [http://www.motoslave.net/sugarcube/2/docs/api-setting.html Setting API] для детальной информации

Setting API. See [http://www.motoslave.net/sugarcube/2/docs/api-setting.html Setting API] for more information.

= settings =

Объект настроек игрока, устанавливаемый автором/разработчиком. См. [http://www.motoslave.net/sugarcube/2/docs/api-setting.html Setting API] для детальной информации

Player settings object, set up by the author/developer. See [http://www.motoslave.net/sugarcube/2/docs/api-setting.html Setting API] for more information.

= setup =


Объект, который автор/разработчик может использовать для установки различной статичных данных – то есть, данных, которые не меняется и не должны храниться в переменных истории, которые сделают их частью истории.
Объект, который автор/разработчик может использовать для установки различной статичных данных – то есть, данных, которые не меняется и не должны храниться в переменных истории, которые сделают их частью истории.


=== State ===
Object that authors/developers may use to set up various bits of static data—generally, data that does not change and should not be stored within story variables, which would make it part of the history.


API состояния. См. [http://www.motoslave.net/sugarcube/2/docs/api-state.html State API].
= State =


=== Story ===
API состояния. См. [http://www.motoslave.net/sugarcube/2/docs/api-state.html State API] для детальной информации.


State API. See [http://www.motoslave.net/sugarcube/2/docs/api-state.html State API] for more information.
API истории. См. [http://www.motoslave.net/sugarcube/2/docs/api-story.html Story API].


= Story =
=== UI ===


API истории. См. [http://www.motoslave.net/sugarcube/2/docs/api-story.html Story API] для детальной информации.
API пользовательского интерфейса. См. [http://www.motoslave.net/sugarcube/2/docs/api-ui.html UI API].


=== UIBar ===
Story API. See [http://www.motoslave.net/sugarcube/2/docs/api-story.html Story API] for more information.


''Добавлено в: v2.17.0''
= UI =

API пользовательского интерфейса. См. [http://www.motoslave.net/sugarcube/2/docs/api-ui.html UI API]для детальной информации.

UI API. See [http://www.motoslave.net/sugarcube/2/docs/api-ui.html UI API] for more information.

= UIBar =

Добавлено в: v2.17.0


API панели пользовательского интерфейса.
API панели пользовательского интерфейса.


См. [http://www.motoslave.net/sugarcube/2/docs/api-uibar.html UIBar API] для детальной информации.
См. [http://www.motoslave.net/sugarcube/2/docs/api-uibar.html UIBar API].

UIBar API. See [http://www.motoslave.net/sugarcube/2/docs/api-uibar.html UIBar API] for more information.


== Порядок выполнения ==
События параграфа (Passage events) и объекты задач (task objects) позволяющие исполнять код JavaScript в определённые моменты во время перемещения по параграфам.


События параграфов и объекты задач позволяют исполнять код JavaScript в определённые моменты во время перемещения по параграфам.
Passage events and task objects allow the execution of JavaScript code at specific points during passage navigation.


В порядке исполнения (также включены Специальные параграфы (Passage Names) для справки):
В порядке исполнения (в список также включены Специальные параграфы для справки):


(«Рендер» означает преобразование кода в HTML в памяти, во время рендера выполняются макросы в тексте.)
In order of processing (also includes the Passage… special passages for reference):


* Инициализация параграфа. Происходит перед изменением истории состояния.
# Passage init. Happens before the modification of the state history.
:* Событие <code>passageinit</code>.
# :passageinit event.
:* Задачи <code>prehistory</code>.
# prehistory tasks.
* Начало параграфа. Идёт перед рендером входящего параграфа.
# Passage start. Happens before the rendering of the incoming passage.
:* Задачи <code>predisplay</code>.
# predisplay tasks.
:* Особый параграф [[#PassageReady|PassageReady]]
# [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages PassageReady] [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages ] [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages special passage].
# :passagestart event.
:* Событие <code>:passagestart</code>
:* Задачи <code>prerender</code>.
# prerender tasks.
:* Особый параграф [[#PassageHeader|PassageHeader]]
# [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages PassageHeader] [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages ] [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages special passage].
* Рендеринг параграфа. Идёт после рендера входящего параграфа.
# Passage render. Happens after the rendering of the incoming passage.
:* Особый параграф [[#PassageFooter|PassageFooter]]
# [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages PassageFooter] [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages ] [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages special passage].
# :passagerender event.
:* Событие <code>:passagerender</code>
:* Задачи <code>postrender</code>.
# postrender tasks.
* Вывод параграфа. Идёт после показа (т.е. вывода) входящего параграфа.
# Passage display. Happens after the display (i.e. output) of the incoming passage.
:* Особый параграф [[#PassageDone|PassageDone]]
# [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages PassageDone] [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages ] [http://www.motoslave.net/sugarcube/2/docs/special-names.html#special-passages special passage].
# :passagedisplay event.
:* Событие <code>:passagedisplay</code>
:* Задачи <code>postdisplay</code>.
# postdisplay tasks.
* Обновляется интерфейс (панель UI), например, <code>StoryCaption</code>. Это происходит перед концом навигации параграфа.
# Passage end. Happens at the end of passage navigation.
* Конец параграфа. Идёт после навигации параграфа.
# :passageend event.
:* Событие <code>:passageend</code>.


#конец фрагмента...
[[Категория:Документация Twine]]
[[Категория:Документация Twine]]

Текущая версия от 15:29, 28 февраля 2020

Этот раздел посвящён специальным названиям параграфов, тегов и переменных, которые имеют особое значения для SugarCube.

Примечания

  1. Все специальные наименования, перечисленные здесь, чувствительны к регистру, поэтому их нужно писать в точности как они показаны.
  2. Никогда не смешивайте специальные параграфы со специальными тегами. Поступая таким образом, вы, вероятно, сломаете что-либо, и потом будет сложно и трудно разобраться в причинах багов.

Passage Names (Специальные параграфы)

PassageDone

Используется для задач после отображения параграфа, например, повторные динамические изменения (происходящие после рендеринга и отображения каждого параграфа). Примерно равнозначен событию passagedisplay.

PassageFooter

Прилагается после каждого обработанного параграфа. Примерно равнозначен событию passagerender.

PassageHeader

Добавляется перед каждым параграфом. Примерно равнозначен событию passagestart.

PassageReady

Используется для задач перед отображением параграфа, например, повторные динамические изменения (происходящие после рендеринга и отображения каждого параграфа). Примерно равнозначен событию passagestart.

Поведение PassageDone PassageReady PassageFooter PassageHeader
Текст специальных параграфов Не отобразится в обычных параграфах. Не отобразится в обычных параграфах. Отобразится в обычных параграфах после их текста. Отобразится в обычных параграфах перед их текстом.
Код и макросы специальных параграфов Выполняются после отображения обычных параграфов и выполнения их кода и макросов. Макросы и код, выводящий значения (типа <<print>>) не отображаются в обычном параграфе. Выполняются перед отображением обычных параграфов и до выполнения их кода и макросов.Макросы и код, выводящий значения (типа <<print>>) не отображаются в обычном параграфе. Выполняются после отображения обычных параграфов и выполнения их кода и макросов.Макросы и код, выводящий значения(типа <<print>>) отображается после текста обычного параграфа. Выполняются перед отображением обычных параграфов и до выполнения их кода и макросов.Макросы и код, выводящий значения(типа <<print>>) отображается перед текстом обычного параграфа.
Похожее событие passagedisplay passagestart passagerender passagestart

Start

Twine 1: Необходим. Начальный параграф, первый отображаемый параграф истории. Настраиваемый, см. Config.passages.start

Twine 2: Не является специальным параграфом. Любой параграф может быть выбран в качестве стартового, путём отметки (иконка ракеты) в контекстном меню параграфа

StoryAuthor

Устанавливает авторскую подпись на панели пользовательского интерфейса (ID элемента: story-author)

StoryBanner

Устанавливает баннер истории на панели пользовательского интерфейса (ID элемента: story-banner)

StoryCaption

Устанавливает заглавие истории на панели пользовательского интерфейса (ID элемента: story-caption).

StoryInit

Используются для задач перед запуском инициализации истории, например, инициализации переменных (происходящей в начале инициализации истории)

StoryInterface

Добавлено в: v2.18.0

Используется, чтобы заменить панель пользовательского интерфейса SugarCube по умолчанию. Его содержимое обрабатывается как обычная HTML-разметка и должно содержать элемент с ID passages, который будет главным пространством отображаемой зоны и чьё содержимое будет заменяться каждый ход. Например:

StoryMenu

Устанавливает пункты меню истории на панели пользовательского интерфейса. (ID элемента: menu-story).

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

StorySettings

В Sugarcube не используется. Configuration Object выполняет те же базовые функции.

StoryShare

Используются для распространения контента через меню Поделиться (Share). Понимает только ссылки.

StorySubtitle

Устанавливает подзаголовок истории на панели пользовательского интерфейса (ID элемента: story-subtitle).

StoryTitle

Twine 1: Необходим. Устанавливает заголовок истории на панели пользовательского интерфейса и повсюду. (ID элемента: story-title). Примечание: в заголовке должен быть чистый текст названия проекта и никакой разметки.

Twine 2: Не используется. Заголовок/название истории – это часть проекта истории.

Специальные теги

bookmark

Отмечает параграф для меню «Перейти На» (Jump To ) после того, как этот параграф посещён.

nobr

Заменяет все переводы строк в параграфе (через Enter) на единичные пробелы. Равнозначен макросу <<nobr>>, применённому на весь параграф. См. Config.passages.nobr, чтобы применить это свойство ко всем отображаемым параграфам истории.

script

Twine 1: Отмечает параграф как код JavaScript, который выполняется при запуске.

Twine 2: Не специальный. Используйте для скриптов пункт «Редактировать JavaScript» в меню редактора истории.

stylesheet

Twine 1: Отмечает параграф как Каскадную таблицу стилей (CSS), которая загружается при запуске истории. Настоятельно рекомендуется использовать только один параграф таблицы стилей в истории. Дополнительно, смотрите tagged stylesheet warning.

Twine 2: Не специальный. Используйте для стилей пункт «Редактировать таблицу стилей» в меню редактора истории.

widget

Отмечает параграф как <<widget>> , который загружается во время запуска.

Специальные переменные

$

Псевдоним для jQuery по умолчанию. Примечание: Не путайте с переменными истории, которые начинаются с $ (например: $переменная).

$args

Массив параметров виджета (только внутри виджетов). См. <<widget>>.

Config

Объект настроек. См. Configuration Object.

Dialog

Диалоговое API. См. Dialog API.

Engine

API движка. См. Engine API.

jQuery

Функция библиотеки jQuery.

l10nStrings

Добавлено в: v2.10.0

Строки локализации объекта. См. Localization.

LoadScreen

Добавлено в: v2.15.0

API экрана загрузки. См. LoadScreen API.

Macro

API макросов. См. Macro API.

Passage

API параграфа. См. Passage API.

postdisplay

Объект обратного вызова задачи после отображения параграфа, устанавливаемый автором/разработчиком. См. Task Objects.

postrender

Объект обратного вызова задачи после отрисовки параграфа, устанавливаемый автором/разработчиком.См. Task Objects.

predisplay

Pre-display task callback object, set up by the author/developer. См. Task Objects.

prehistory

Pre-history task callback object, set up by the author/developer. См. Task Objects.

prerender

Pre-render task callback object, set up by the author/developer. См. Task Objects

Save

API сохранений. См. Save API.

Setting

API настройки. См. Setting API.

settings

Объект настроек игрока, устанавливаемый автором/разработчиком. См. Setting API.

setup

Объект, который автор/разработчик может использовать для установки различной статичных данных – то есть, данных, которые не меняется и не должны храниться в переменных истории, которые сделают их частью истории.

State

API состояния. См. State API.

Story

API истории. См. Story API.

UI

API пользовательского интерфейса. См. UI API.

UIBar

Добавлено в: v2.17.0

API панели пользовательского интерфейса.

См. UIBar API.

Порядок выполнения

События параграфов и объекты задач позволяют исполнять код JavaScript в определённые моменты во время перемещения по параграфам.

В порядке исполнения (в список также включены Специальные параграфы для справки):

(«Рендер» означает преобразование кода в HTML в памяти, во время рендера выполняются макросы в тексте.)

  • Инициализация параграфа. Происходит перед изменением истории состояния.
  • Событие passageinit.
  • Задачи prehistory.
  • Начало параграфа. Идёт перед рендером входящего параграфа.
  • Задачи predisplay.
  • Особый параграф PassageReady
  • Событие :passagestart
  • Задачи prerender.
  • Особый параграф PassageHeader
  • Рендеринг параграфа. Идёт после рендера входящего параграфа.
  • Особый параграф PassageFooter
  • Событие :passagerender
  • Задачи postrender.
  • Вывод параграфа. Идёт после показа (т.е. вывода) входящего параграфа.
  • Особый параграф PassageDone
  • Событие :passagedisplay
  • Задачи postdisplay.
  • Обновляется интерфейс (панель UI), например, StoryCaption. Это происходит перед концом навигации параграфа.
  • Конец параграфа. Идёт после навигации параграфа.
  • Событие :passageend.
Источник — https://ifwiki.ru/index.php?title=Специальные_параграфы_Sugarcube&oldid=28006