Biker Quest Script

Biker Quest Script
bqs
Фрагмент кода на BQS
Языки программирования
Следующий язык SLThree
Разработка
Разработка с декабря 2021
Написан на C#
Платформы Windows
Язык программирования
Тип исполнения интерпретируемый
Типизация динамическая
Испытал влияние C#, Sunko
Повлиял на SLThree
Расширение .bqs
Статистика
Строк кода .cs: 21353

Biker Quest Script — C-подобный императивный скриптовый язык квестов (и не только) в Biker 3. Синтаксис очень близок к C#, что позволяет не учить целый ЯП.

  1. Навигация:
  2. Возможности и особенности
  3. Почему не Lua, Python и прочие
  4. Истоки разработки
  5. Возможности и фичи Biker Quest
  6. Спецификация
  7. Методы Biker 3
  8. Ссылки

Возможности и особенности

Ключевые:

Синтаксические:

Прочие:

Почему не Lua, Python и прочие

Ещё с Biker 2 у меня было желание разработать скриптовый язык, не порождая зависимости от уже существующих. Кроме того, собственный язык позволяет создавать свои абстракции и свой сахар. К тому же, BQS будучи привязанным к .NET, позволяет использовать методы Biker 3, которые можно писать непосредственно на C#, не плодя дополнительный код.

Истоки разработки

Имя подсветки этого языка — bqs2. Это неспроста так, ведь до этого существовал язык Biker Quest (.bikerquest), имевший расширенный синтаксис моего старого проекта под названием Sunko, который был очередной попыткой создать свой скриптовый язык. В определённой мере он справлялся со своей задачей, но был слаборасширяем.

  1. sunko
  2.     string x = {gettype {gettype {sunkoversion}}}
  3.     !write x
  4. end
Пример кода на Sunko

Biker Quest был похож на Sunko внутренним представлением и синтаксисом. Методы также, как и в Sunko, могли создаваться только вручную в коде и вызывались с помощью синтаксиса {MethodName arg1 arg2}. Это легко парсить. Но, понятное дело, писать на нём было крайне неудобно (лично я за два года существования этого языка так к нему и не привык).

  1. variant["0004", true] if ({money} >= QuestName.price)
  2.     setstage 2
  3.     setstage "QuestName" 2
  4.     REPUTATION = (REPUTATION + 1)
  5.     //declarations:
  6.     var x1: int64
  7.     var x2: int64 = start_date
  8.     var x3 = start_date
  9.     //assign:
  10.     x1 = 0
  11.     x2 += 1
  12.     x3 -= 1
  13.     if (true) then [setstage 1]
  14.     if (true) then [setstage 1] else [setstage 2]
  15.     if (true) then
  16.     begin
  17.     end
  18.     else
  19.     begin
  20.     end
  21.     while (true)
  22.     begin
  23.     end
  24.     begin
  25.     end
  26.     repeat until (true)
  27.     loop 100
  28.     end
  29. end. //Здесь end и end. это разные вещи
Код на Biker Quest
chooseОписания методов

Возможности и фичи Biker Quest (по сравнению с Sunko):

Паскалеподобный синтаксис смешанный с костылями для упрощения парсинга делал из этого языка этакого франкенштейна. Кроме того, синтаксис был захламлён кучей специальных ключевых слов вроде "setstage". Последней же каплей для меня стало то, что контекст pastetemplate было невозможно восстановить вообще и в конце декабря 2021 я решил полностью переписать Biker Quest. Так появился Biker Quest Script.

Спецификация

Подсветка сгенерирована с помощью рефлексии по BQS-конструкциям. Такой код подходит только для поверхностного ознакомления. Для подробного изучения скачайте RAW-версию кода.

  1. //Парсер языка однострочный. Одна строка - один оператор.
  2. //Комментарии только однострочные
  3. //У языка огромная схожесть с языком C#
  4. class ClassName
  5. {
  6.     //Классы условны. В языке нет ООП вообще. В языке даже структур нет!
  7.     //Но если очень хочется можно написать свою C#-библиотеку и подключить её
  8.     //Значение константы хранится в дереве.
  9.     const int maxprice = 300
  10.     //Значение переменной хранится в сохранении. При доступе к переменной вне контекста игры, она вернёт своё значение по умолчанию.
  11.     //переменные должны всегда быть сериализумого типа
  12.     //в качестве значения может использоваться вызов любых значений, для которых не нужен контекст игры
  13.     //в том числе вызов метода в том случае если для него не нужен контекст игры.
  14.     var int price = 200
  16.     //Список сериализуемых типов:
  17.     //sbyte, byte, short, ushort, int, uint, long, ulong, float, double, string, bool и byte[]
  18.     //Через последний тип можно представить что угодно
  20.     //Метод. Ключевое отличие от старого языка квестов. Строгости в обязательности возвращения значений нет.
  21.     //Возвращаемый тип может быть любой абсолютно. Внутренне void это object, имейте это ввиду.
  22.     void Method()
  23.     {
  24.         //Объявление переменной
  25.         //Точка с запятой в конце оператора не обязательна
  26.         var x = 0
  27.         //Также переменная объявляется при присваивании, если её не существует:
  28.         xx = 0
  29.         //Однако не стоит использовать эту возможность без необходимости.
  30.         {
  31.             //Объявленные переменные пропадают после конца области действия их объявления
  32.             //Если они заменили переменную, то она не вернётся назад!
  33.             var x = 0
  34.             var xx = 0
  35.         }
  36.         //Теперь обеих этих переменных не существует.
  38.         //Присваивание переменных:
  39.         x = 1
  40.         //Расширенное присваивание:
  41.         x += 1
  42.         x -= 1
  43.         x *= 1
  44.         x /= 1
  45.         x %= 1
  46.         x |= 1
  47.         x &= 1
  48.         x ^= 1
  49.         //Операций инкремента и декремента нет. Используйте += для ++x.
  50.         //Все операции являются утверждениеями, а значит их можно писать просто так:
  51.         1 + 2
  52.         //Каждая операция имеет свой приоритет (даже - над +). Имейте это ввиду.
  53.         //Порядок приоритета по возрастанию:
  54.         //"=", "+=", "-=", "*=", "/=", "%=", "&=", "|=", "^=", "&&", "||", "&", "|", "^",
  55.         //"is", "==", "!=", ">", ">=", "<", "<=", ">>", "<<", "+", "-", "*", "/", "%", "!", "~"
  56.         //Операции составляются из отдельных символов, так что a + = 1 страктуется как a += 1!
  57.         //Тернарная операция имеет минимальный приоритет
  59.         //Выражения имеют возвращаемый тип. Требуемы возвращаемый тип зависит от конструкции.
  60.         #Debug.Log(1)
  61.         var a1 = x + x
  62.         var b1 = 0.1 + a1
  63.         var c1 = (long )x
  65.         if (a1 is int )
  66.         {
  67.             var b = a is int a1
  68.             #Debug.Log(a is int )
  69.         }
  71.         //Старайтесь не переопределять существующие в контексте переменные. Если вы измените глубину их объявления, вы можете запутать самих себя.
  73.         //Операторы:
  74.         //Блок:
  75.         {
  76.         }
  77.         //Цикл while:
  78.         while (false)
  79.         {
  80.         }
  81.         //Или краткая версия:
  82.         while (false)null
  84.         //Цикл do-while:
  85.         do
  86.         {
  87.         }
  88.         while (false)
  89.         //Краткой версии не существует
  91.         //Цикл loop:
  92.         loop (1)
  93.         {
  94.         }
  95.         //Краткая версия:
  96.         loop (1)null
  98.         //Цикл for:
  99.         //for ([<Statement>]; [<Expression>]; [<Statement>]) [<Statement>];
  100.         for (var i = 0 ; i < 1 ; i += 1)
  101.         {
  102.             continue
  103.             break
  104.             for ( ; )null
  105.         }
  107.         //Условный оператор (краткие версии):
  108.         if (true)Log.Add(1)
  109.         //else if отдельная конструкция
  110.         else if (true)Log.Add(2)
  111.         else Log.Add(0)
  113.         //Несколько операторов на одной строке:
  114.         var a = 0 ; var b = 0
  115.         //Доступны во всех операторах (но недоступны как возвращающее значение краткого метода)
  116.         while (a + b < 4)a += 1 ; b += 1
  118.         //Интерполированные строки:
  119.         string s = "{a} {b}" ; #Debug.Log(s)
  121.         //Имена типа возвращают экземпляр System.Type
  122.         var t = string
  124.         //Обращаться к .NET-типам можно через имена, начинающиеся с ##
  125.         //Массивы и их инициализаторы
  126.         var a = new System.Type[1](string)
  128.         {
  129.             //Использование .NET-типов:
  130.             //#Type хранит полные имена типов в константах с которотким именем
  131.             //Ознакомьтесь со списком встроенных в Biker Quest Script методов
  132.             using #Type.ConsoleColor
  133.             //или: (первое будет быстрее)
  134.             using ##System.ConsoleColor
  135.             #Debug.Log(#ConsoleColor.Black)
  137.             //также можно
  138.             using ##System.Random as #R
  139.             //Вызов конструктора:
  140.             //Все конструкторы NET-типов именуются как #new
  141.             var r = #R.#new()
  142.             //Короткий вызов конструктора:
  143.             var r = #R.#new()
  145.             //Типы существуют до конца области действия, как и переменные.
  146.         }
  148.         //Чтобы можно было загружать типы из других сборок, необходимо загрузить эту .NET-сборку
  149.         #Script.LoadAssembly("KTXCore.dll")
  151.         var t = ""
  152.         //Цикл foreach:
  153.         foreach (var xin new object[](1, 2, 3, 4))t += "{x} "
  155.         //Лямбда-выражения и использование методов в качестве параметров
  156.         var m1 = => 1
  157.         var m2 = (x, y) => x() == y()
  158.         //Многострочная лямбда.
  159.         var m3 = =>
  160.         {
  161.             return m2(m1 , func_)
  162.         }
  163.         m3()
  165.         //Операция :: позволяет обратиться к экземплярному методу или свойству типа
  166.         m3 :: Invoke()
  168.         //Операция лямбды имеет самый низкий приоритет! Присвоение без var можно сделать только так:
  169.         m1 = ( => 1)
  171.         //(dynamize) для типов, отличных от object
  172.         var int_arr1 = (dynamize )new int[](1, 2, 3)
  173.         var t = int_arr1 :: Select(x => x * x) :: JoinIntoString(", ")
  175.         //Если у метода существуют перегрузки, то по имени нельзя получить его как метод.
  176.         //для этого есть специальный синтаксис
  177.         var lambda = (##method )#Math.Round(double , int )
  178.         var x = lambda(6.5 , 0)
  180.         //Захватывать контекст лямбды пока не умеют(
  182.         //Код можно выполнить здесь, но так чтобы он думал что он в другом дереве
  183.         //так он получит доступ ко всем именам другого дерева
  184.         #Script.Skill \ {var a = SportGroup.Level} \ {#Debug.Log(a)}
  186.          \ (##. )(s = 3) \ {#Linq.JoinIntoString(#Linq.Where(new object[](1, 2, 3, 4, 5) , x => x % s == 0) , " ")}
  187.     }
  189.     //Короткая запись метода:
  190.     //<TypeName> <FuncName>() => <Expression>;
  191.     //void <FuncName>() => <Statement>;
  192.     int func_() => 1
  194.     int property = 14
  195.     //Свойства
  196.     //Всего 2 вида свойств и 3 вида автосвойств
  197.     //Помните, что парсер однострочный, и точно следуйте синтаксису ниже
  198.     int Property1 => property
  199.     int Property2{
  200.         get => property
  201.         set => property = #value
  202.     }
  203.     int Property2_1{
  204.         get
  205.         {
  206.             return property
  207.         }
  208.         set
  209.         {
  210.             property = #value
  211.         }
  212.     }
  213.     //Автосвойства, как и переменные, могут быть только сериализуемых типов
  214.     int Property3{get ; set ; }
  215.     int Property4{get ; set ; } = 25
  216.     int Property5{get ; } = 30
  217. }
  219. quest QuestName
  220. {
  221.     //Возвращает строку типа (или группы) квестов для журнала заданий
  222.     const string #JournalGroup = "Второстепенные квесты"
  224.     //Доступ к словарю - Text(string key);
  225.     text
  226.     {
  227.         "desc1" = "Описание квеста в дневнике"
  228.         "desc2" = "Описание квеста появляющееся если выполнено условие"
  229.     }
  231.     //Краткая запись для небольших добавлений:
  232.     text "dddd" = ""
  234.     //Добавляет описание квесту в журнале
  235.     description
  236.     {
  237.         add "desc1"
  238.         add "desc2"if (true)
  239.     }
  242.     //Краткая запись для небольших добавлений:
  243.     description add "desc2"
  244.     description add "desc2"if (false)
  246.     //Возвращает true если в этом контексте можно начать печать квеста
  247.     //ui[<Place>] вернёт true только в случае совпадения с именем места. При любом другом значении вернёт false
  248.     //Удобно делать условия вроде a == 0 ? ui["All"] : ui["PlayerViewer"]
  249.     bool #UIStart(object ui) => ui["All"]
  251.     //Специальный метод. Вызывается при #Stage.NS (в состоянии неначатости квеста).
  252.     //Возвращает, можно ли начать выполнение квеста
  253.     bool #Available()
  254.     {
  255.         return true
  256.     }
  258.     //Специальный метод. Вызывается при первом запуске квеста если #Available вернуло true.
  259.     void #Start()
  260.     {
  261.         //Внутри каждого квеста на данный момент есть специальные локальные описания.
  263.         //Свойство (язык поддерживает .NET-свойства)
  264.         //свойство Stage возвращает стадию квеста из сохранения или задаёт эту стадию. Заданная стадия обязательно должна существовать
  265.         //иначе будет ошибка.
  266.         Stage = 1
  268.         //метод Text(string) возвращает значение по ключу словаря квеста
  269.         Text("desc1")
  270.     }
  272.     //Специальный метод. Определяет, будет ли пропускаться посимвольный вывод текста этого квеста.
  273.     bool #SkipCarriage() => false
  275.     //Специальный метод. Метод, который будет выполнен при пропуске квеста по кнопке Tab.
  276.     void #OnEscapeQuest() => null
  278.     //Специальный метод. Возвращает название квеста.
  279.     string #Title() => "Title name"
  281.     //Специальный метод. Возвращает описание квеста вдобавок к description
  282.     string #GetDescription() => ""
  284.     //Сокращённый способ определения названия квеста
  285.     title = "Title {(1+1)}"
  287.     stage [1]
  288.     {
  289.         //Специальные методы стадий и вариантов квестов недоступны для вызова!
  290.         //Возвращает доступность выполнения в этом месте UI
  291.         bool #UIStart(object ui) => ui["All"]
  293.         //
  294.         bool #Available() => true
  296.         //Специальный метод. Возвращает описание стадии квеста вдобавок к description
  297.         string #GetDescription() => ""
  299.         //Добавлять в словарь квеста можно и из стадий
  300.         text "1_d" = "Текст этой стадии"
  301.         text "1_d2" = "Текст этой стадии при выполнении условия"
  303.         description
  304.         {
  305.             add "1_d"
  306.             add "1_d2"if (true)
  307.         }
  309.         variant
  310.         {
  311.             //Специальный метод. Возвращающий текст варианта выбора
  312.             string #GetVariantText() => "Текст этого варианта"
  313.             //Специальный метод. Отвечает за действие при выборе этого варианта
  314.             void #Action() => return
  315.             //Специальный метод. Возвращает доступно ли выбрать этот вариант.
  316.             bool #Available() => false
  317.             //Специальный метод. Возвращает виден ли этот вариант в случае недоступности (будет показан серым)
  318.             bool #Visible() => false
  319.         }
  321.         //Сахарная сокращённая запись:
  322.         //variant => <Expression> => <Statement>[ => <Expression>[ => <Expression>]];
  323.         //порядок => #GetVariantText => #Action => #Available => #Visible
  324.         variant => "Текст этого варианта" => return => false => false
  325.     }
  326. }
RAW-версия спецификации

Хочу ещё добавить, что в спецификации описаны не все нюансы. К примеру, у перегрузки методов есть ограничения: будет выбран первый подходящий метод по порядку. То есть, если у нас есть, например, классы Item и BikeDetail : Item, и описать методы:

  1. void p(##Gameplay.Items.Item item) => return;
  2. void p(##Gameplay.Items.BikeDetails.BikeDetail bd) => return;
и попытаться вызвать p(bd) для BikeDetail, вызовется первый метод, так как он первее описан.

Ещё одно важное понятие — вызов экземплярных методов .NET-классов. В BQS нет объектов как таковых и все экземплярные методы могут быть вызваны только как статические с дополнительным первым аргументом. Например #Object.ToString(o); Если метод виртуальный и вы думаете какой конкретно класс использовать для вызова — используйте базовый.

Ссылки