Просмотр кода страницы Специальные параграфы Sugarcube

* Оригинал: [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]

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

'''Примечания'''

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

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

=== PassageDone ===

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

=== PassageFooter ===

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

=== PassageHeader ===

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

=== PassageReady ===

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

{|
!width="5%"| Поведение
!width="5%"| PassageDone
!width="5%"| PassageReady
!width="5%"| PassageFooter
!width="5%"| PassageHeader
|-
| Текст специальных параграфов
| Не отобразится в обычных параграфах.
| Не отобразится в обычных параграфах.
| Отобразится в обычных параграфах после их текста.
| Отобразится в обычных параграфах перед их текстом.
|-
| Код и макросы специальных параграфов
| Выполняются после отображения обычных параграфов и выполнения их кода и макросов. Макросы и код, выводящий значения (типа &lt;&lt;print&gt;&gt;) не отображаются в обычном параграфе.
| Выполняются перед отображением обычных параграфов и до выполнения их кода и макросов.Макросы и код, выводящий значения (типа &lt;&lt;print&gt;&gt;) не отображаются в обычном параграфе.
| Выполняются после отображения обычных параграфов и выполнения их кода и макросов.Макросы и код, выводящий значения(типа &lt;&lt;print&gt;&gt;) отображается после текста обычного параграфа.
| Выполняются перед отображением обычных параграфов и до выполнения их кода и макросов.Макросы и код, выводящий значения(типа &lt;&lt;print&gt;&gt;) отображается перед текстом обычного параграфа.
|-
| Похожее событие
| [[#PassageDisplay|passagedisplay]]
| [[#PassageStart|passagestart]]
| [[#PassageRender|passagerender]]
| [[#PassageStart|passagestart]]
|}

=== Start ===

'''Twine 1:''' Необходим. Начальный параграф, первый отображаемый параграф истории. Настраиваемый, см. [http://www.motoslave.net/sugarcube/2/docs/config-object.html#config-passages-start 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, который будет главным пространством отображаемой зоны и чьё содержимое будет заменяться каждый ход. Например:

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

=== StoryMenu ===

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

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

=== StorySettings ===

В Sugarcube '''не используется.''' [http://www.motoslave.net/sugarcube/2/docs/config-object.html Configuration Object] выполняет те же базовые функции.

=== StoryShare ===

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

=== StorySubtitle ===

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

=== StoryTitle ===

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

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

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

=== bookmark ===

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

=== nobr ===

Заменяет все переводы строк в параграфе (через 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], чтобы применить это свойство ко всем отображаемым параграфам истории.

=== script ===

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

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

=== stylesheet ===

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

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

=== widget ===

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

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

=== $ ===

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

=== $args ===

Массив параметров виджета (только внутри виджетов). См. [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].

=== Dialog ===

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

=== Engine ===

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

=== jQuery ===

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

=== l10nStrings ===

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

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

=== LoadScreen ===

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

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

=== Macro ===

API макросов. См. [http://www.motoslave.net/sugarcube/2/docs/api-macro.html Macro API].

=== Passage ===

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

=== postdisplay ===

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

=== postrender ===

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

=== predisplay ===

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].

=== prehistory ===

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].

=== prerender ===

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 ===

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

=== Setting ===

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

=== settings ===

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

=== setup ===

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

=== State ===

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

=== Story ===

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

=== UI ===

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

=== UIBar ===

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

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

См. [http://www.motoslave.net/sugarcube/2/docs/api-uibar.html UIBar API].

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

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

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

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

# Инициализация параграфа. Происходит перед изменением истории состояния.
# Событие <code>passageinit</code>.
# Задачи <code>prehistory</code>.
# Событие <code>start</code> параграфа. Идёт перед рендером входящего параграфа.
# Задачи <code>predisplay</code>.
# Особый параграф [#PassageReady|PassageReady]
# Событие <code>passagestart</code>
# Задачи <code>prerender</code>.
# Особый параграф [[#PassageHeader|PassageHeader]]
# Параграф <code>render</code>. Идёт после рендера входящего параграфа.
# Особый параграф [[#PassageFooter|PassageFooter]]
# Событие <code>passagerender</code>
# Задачи <code>postrender</code>.
# Параграф <code>display</code>. Идёт после вывод входящего параграфа.
# Особый параграф [[#PassageDone|PassageDone]]
# Событие <code>passagedisplay</code>
# Задачи <code>postdisplay</code>.
# Параграф <code>end</code>. Идёт в конце параграфа <code>navigation</code>.
# Событие <code>passageend</code>.

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