Для работы со скриптами Nexus Вам понадобится 3 вещи:

• Текстовый редактор для работы со скриптами
  Я рекомендую использоовать Notepad++ (Официальный сайт[notepad-plus-plus.org]).
  
  
• Microsoft Exel для удобного редактирования параметров кораблей и устройств.
  Также можно использовать LibreOffice.Calc, если сможете адаптировать под него макрос (у меня, например, не получилось).
  
  
• Набор вспомагательных модов.
  Конечно, они не обязательны, и вы можете создать свою реализацию, но в данном руководстве я буду постоянно обращаться к ним, поэтому для лучшего понимания процесса лучше иметь эти моды под рукой.
  http://gtm.steamproxy.vip/sharedfiles/filedetails/?id=1139261112

Оригинальная статья[nexusthegame.net]

• Пространство "D."
  Оно представлено в руководстве, как пространство диалогов, но на самом деле не работает.
  
  
• Пространство "T."
  Представлено в руководстве, как пространоство тактических подпрограмм (Subroutines), и работает, но бесполезно, т.к. в подпрограммы передавать переменные лучше через пространство "E."

Оригинальная статья[nexusthegame.net]

Дополнительно, блок 'RULE' может принимать следующий синтаксис, в случае, если указано усолвие:

На самом деле описание тела ':else' присутсвует в официальном руководстве, но по какой-то причине отсутсвует в Wiki и не используется в исходной кампании

В случае если условие выполнется, будут выполнены команды в теле :action
Если нет, то в блоке :else

Также, Вы можете указать несколько тел :action в блоке RULE


В этом случае вначале будет проверено первое условие и выполненное выбранное тело, а потом второе.

Список айди типов, которые могут быть проверены через функцию uType()


* - Story depot
** - Небесные объекты типа комет
*** - врата Nexus
Пример: uSelect(0, uGetUniverse(), S:uType() = 207) вернет все навигационные точки

• uGetUniverse
  Возвращает основной объект игры
  
  
  Синтаксис

  uGetUniverse()

  Особенности

  Нет
  
  
• uCamera_Enter
  Запускает процедуру входа в тактический режим с анимацией.
  В отличии от uEnterMission не требует отдельного файла миссии.
  
  
  Синтаксис

  uCamera_Enter(uTypeObject)

  Поддерживаемые типы аргумента

  • system/*
    
  • nexus/*
    
  • celesital/*
    
  • fleet/*
    
  • navigationpoint/*
    
  • asteroidfield/*
    
  • station/*
    
  • location/*

  Особенности

  • Работает только в модификациях кампании
    
  • В моде должна быть определена миссия 99
    
  • Не требует вызова функции uSetNextMission
    
  • Не стабильна в тактическом режиме. Пользуйтесь с осторожностью.
  
  
• uCamera_PutInto
  Запускает процедуру входа в тактический режим без анимацией.
  В отличии от uEnterMissionQuick не требует отдельного файла миссии.
  
  
  Синтаксис

  uCamera_PutInto(uTypeObject)

  Поддерживаемые типы аргумента

  • system/*
    
  • nexus/*
    
  • celesital/*
    
  • fleet/*
    
  • navigationpoint/*
    
  • asteroidfield/*
    
  • station/*
    
  • location/*

  Особенности

  • Работает только в модификациях кампании
    
  • В моде должна быть определена миссия 99
    
  • Не требует вызова функции uSetNextMission
    
  • Не стабильна в тактическом режиме. Пользуйтесь с осторожностью.
  
  
• QuitMission
  Запускает процедуру выхода из тактического режима с анимацией.
  В отличии от uQuitMission не требует аргумента. При выходе из тактического режима не будет показан экран дебрифинга, а так-же не произойдет выход в главное меню, если функция uSetNextMission не была вызвана. Переменные U.ActMission и U.ActEpisode не будут инкрементированы.
  
  
  Синтаксис

  QuitMission()

  Особенности

  • Работает только в модификациях кампании
    
  • Стабильна только, если вход в тактический режим был осуществлен с помощью функций uCamera_Enter или uCamera_PutInto
    
  • Не требует вызова функции uSetNextMission
    
  • Требует ручного вызова функции GuiSelect(2)
    
  • Не вызывает событие MissionQuit, поэтому вызов не может быть перехвачен в скриптах истории
  
  
• isat
  Возвращает 1 в случае, если вызвавший функцию объект является дочерним. В противном случае 0.
  
  
  Синтаксис

  uTypeObject:isat(uTypeObject)

  Поддерживаемые типы аргумента

  Любой uTypeObject

  Особенности

  Нет
  
  
• uGetC
  Возвращает объект, если тот является дочерним к указанному.
  
  
  Синтаксис

  uTypeObject:uGetC(string)

  Особенности

  Нет
  
  
• get
  Псевдоним GetSceneObj
  
  
  Синтаксис

  get(string)

  Особенности

  Те же, что и для GetSceneObj
  
  
• makeMainShip
  Неизвестно
  
  
  Синтаксис

  MakeMainShip(Ship, string)

  Особенности

  Неизвестно

• Переход в тактический режим через меню карты (стратегический режим)
  Чтобы этот хак заработал нам нужно для всех требуеых объектов системы выставить DetectionLevel в 5 (#UDET_SPYCAM)
  
  Пример:
  
  RULE event EpisodeStart condition ActEpisode=1 :action sel := GetFreeSel(); uSelect(sel, uGet("sys_sol"), S:celestial()|S:colony()); ExecList(sel, S:uSetDetectionLevel(#UDET_SPYCAM)); :end END
  
  Теперь на панели описания объекта появится дополнительная кнопка.
  При ее нажатии будет вызвана функция uCamera_Enter и мы окажемся в тактическом режиме.
  
  
  
  
  
  
  
• Анимация прыжка через червоточину
  В мисси 16 оригинальной кампании мы видим анимацию прыжка Ангелады при входе в червоточину. Я думаю многие замечали, что эта анимация больше нигде не работает. Это не совсем так.
  
  У классов кораблей (файл Universe/tactics/tacticstypes.ini) есть параметр HPRegen (он указан только у класса Ангелады). Если этот параметр больше нуля, то при входе в червоточену будет показана анимация (при этом достаточно указать значение 0.001 или похожее, чтобы не разрушить баланс). Более того, после проигрывания анимации сцена будет выгружена и можно смело использовать функцию uCamera_Enter или uCamera_PutInto в событие MissionQuit для переключения сцены. Однако, к сожалению, это работает только с объектами типа nexusgate/* и мы должны проиграть некий bink ролик для завершения разрушения сцены (пустого ролика будет достаточно).

В больших комплексных модах возникает необходимость использовать объекты с одним и тем же набором функций и переменных, но с разными состояниями. К сожалению, в оригинальной игре не предоставлено подобного функционала, поэтому мной был написан модуль для расширения возможностей стандартной StateMachine и включен в состав мода uSL.

• Основные понятия
  • Класс - StateMachine, созданная через модуль Class библиотеки uSL
    
  • Ссылка - Номер листа инстанции класса
    
  • Инстанция - Экземпляр класса
    
  • Объект - Переменная, являющаяся непосредственно классом
  
  
• Определения
  Каждый класс может иметь одну или несколько инстанций со своим уникальным состоянием переменных. Доступ к инстанции можно получить через объект класса, или через метод __changeInstance.
  
  
• Макросы
  Макросы задаются через директиву #include.
  
  • uSL/class/declaration
    Данный макрос говорит игре, что данная StateMachine является классом.
    Он должен быть определен сразу после определения MACHINE.
    
    
  • uSL/class/instance
    Данный макрос определяет метод, как метод инстанции.
    Он должен быть указан сразу после определения RULE event.
    
    
  • uSL/class/end_instance
    Данный макрос определяет конец метода инстанции.
    Он должен быть указан сразу после определения :end.
    
    
  • uSL/class/end
    Данный макрос определяет конец класса.
    Он должен быть указан после всех методов.

Пример Класса

Пример использования

Работа библиотеки версии 2 будет описана ниже.

Точка входа эта рутина, вызов которой приведет к инициализации вашего мода. В Случае с Библиотекой скриптов, это будет главное меню (особенность скриптового движка Nexus Black Ruller заключается в том, что он сбрасывает в сохранение все нужные значение, а также точку останова скрипта, поэтому при загрузке игры мы получим сразу инициализированные скрипты).
Также, отдельно отмечу, что мод, обязан быть модификацией компании, чтобы Библиотека Скриптов могла полноценно загрузиться. Дополнительно ей понадобится указатель на основную стейт машину мода в определенном формате, поэтому дополнительно нужно будет написать небольшую функцию для его передачи.

ЧекЛист

• Модификация - это модификация компании

В директории мода необходимо создать директорию Universe (если ее нет) и в ней создать пустой файл с именем .campaign (точка campaign)

• На кнопку "Новая Игра" назначена точка входа Библиотеки Скриптов

В директории Universe вашего мода нужно создать файл main.ini, в котором будет указан следующий код:
, где
Title - название вашего мода
блок MAINMENU описывает все кнопки, которые появятся в нем.
Первый параметр текст кнопки, второй - событие, которое будет вызвано при нажатии на нее.
uCall(ModMain, 0) - Точка входа в Библиотеку Скриптов

• Присутствует правильно оформленная главная стейт машина мода

Главная стейт машина мода это стейт машина, которая производит управление всеми дальнейшими событиями мода. В ней вы должны указать всю необходимую вам логику, все необходимые переходы, итд. Подробнее о ней будет рассказано далее в руководстве.

Эта машина должны располагаться в рутинах стратегии. Поэтому, необходимо в вашем соде создать необходимые поддиректории в директории Universe вашего мода, а именно, Strategy\Subroutines\. В ней, вам нужно создать файл в формате Mod.ModName.ini, где ModName имя вашего мода.

В этот файл необходимо поместить код стейт машины и рутины, которая будет передать ее указатель в библиотеку скриптов.