Специальные параграфы Sugarcube

Материал из IFВики
Перейти к навигации Перейти к поиску

Этот раздел посвящён специальным названиям параграфов, тегов и переменных, которые имеют особое значения для 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: Не является специальным параграфом. Любой параграф может быть выбран в качестве стартового, путём отметки (иконка ракеты) в контекстном меню параграфа

Twine 1: Required. The starting passage, the first passage displayed. Configurable, see Config.passages.start for more information.

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.

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

Sets the authorial byline in the UI bar (element ID: story-author).

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

Sets the story's banner in the UI bar (element ID: story-banner).

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

Sets the story's caption in the UI bar (element ID: story-caption).

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

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, который будет главным пространством отображаемой зоны и чьё содержимое будет заменяться каждый ход. Например:

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

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:

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

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

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

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.

StorySettings Не используется. Configuration Object выполняет те же базовые функции. Unused. The Configuration Object serves the same basic purpose.

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

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

Sets the story's subtitle in the UI bar (element ID: story-subtitle).

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 (Специальные теги)

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

nobr Заменяет все переводы строк в параграфе (через Enter) на единичные пробелы. Равнозначен макросу <<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 <<nobr>>. See Config.passages.nobr for a way to apply the same processing to all rendering passages.

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.

stylesheet Twine 1: Отмечает параграф как Каскадную таблицу стилей (CSS), которая загружается при запуске истории. Настоятельно рекомендуется использовать только один параграф таблицы стилей в истории. Дополнительно, смотрите 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 tagged stylesheet warning. Twine 2: Not special. Use the Edit Story Stylesheet story editor menu item for styles.

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

Registers the passage as <<widget>> definitions, which are loaded during startup.

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

$

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

Alias for jQuery, by default. NOTE: This should not be confused with story variables, which start with a $ (e.g. $foo).

$args

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

Widget arguments array (only inside widgets). See <<widget>> for more information.

Config

Объект настроек. См. Configuration Object для детальной информации.

Configuration object. See Configuration Object for more information.

Dialog

Диалоговое API. См. Dialog API для детальной информации.

Dialog API. See Dialog API for more information.

Engine

API движка. См. Engine API для детальной информации.

Engine API. See Engine API for more information.

jQuery

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

jQuery library function.

l10nStrings

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

Строки локализации объекта. См. Localization для детальной информации.

Strings localization object. See Localization for more information.

LoadScreen

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

API экрана загрузки. См. LoadScreen API для детальной информации.

LoadScreen API. See LoadScreen API for more information.

Macro

API макросов. См. Macro API для детальной информации.

Macro API. See Macro API for more information.

Passage

API параграфа. См. Passage API для детальной информации.

Passage API. See Passage API for more information.

postdisplay

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

Post-display task callback object, set up by the author/developer. See Task Objects for more information.

postrender

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

Post-render task callback object, set up by the author/developer. See Task Objects for more information.

predisplay

См. Task Objectsдля детальной информации.

Pre-display task callback object, set up by the author/developer. See Task Objects for more information.

prehistory

Pre-history task callback object, set up by the author/developer. See Task Objects for more information.

prerender

Pre-render task callback object, set up by the author/developer. See Task Objects for more information.

Save

API сохранений. См. Save API для детальной информации.

Save API. See Save API for more information.

Setting

API настройки. См. Setting API для детальной информации

Setting API. See Setting API for more information.

settings

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

Player settings object, set up by the author/developer. See Setting API for more information.

setup

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

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.

State

API состояния. См. State API для детальной информации.

State API. See State API for more information.

Story

API истории. См. Story API для детальной информации.

Story API. See Story API for more information.

UI

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

UI API. See UI API for more information.

UIBar

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

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

См. UIBar API для детальной информации.

UIBar API. See UIBar API for more information.

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

Passage events and task objects allow the execution of JavaScript code at specific points during passage navigation.

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

In order of processing (also includes the Passage… special passages for reference):

  1. Passage init. Happens before the modification of the state history.
  2. :passageinit event.
  3. prehistory tasks.
  4. Passage start. Happens before the rendering of the incoming passage.
  5. predisplay tasks.
  6. PassageReady [1] special passage.
  7. :passagestart event.
  8. prerender tasks.
  9. PassageHeader [2] special passage.
  10. Passage render. Happens after the rendering of the incoming passage.
  11. PassageFooter [3] special passage.
  12. :passagerender event.
  13. postrender tasks.
  14. Passage display. Happens after the display (i.e. output) of the incoming passage.
  15. PassageDone [4] special passage.
  16. :passagedisplay event.
  17. postdisplay tasks.
  18. Passage end. Happens at the end of passage navigation.
  19. :passageend event.
  1. конец фрагмента...
Источник — https://ifwiki.ru/index.php?title=Специальные_параграфы_Sugarcube&oldid=27994