IFВики - Вклад [ru]

AkURQ

2019-06-28T12:16:37Z

Ajenta: /* Особенности запуска игр под AkURQ */

{{product info
|название =
|тип = Интерпретаторы URQ, Инструменты
|разработчик = [[Разработчик::Севрюгин, Александр|Александр Севрюгин]] при участии [[Разработчик::SFeLi]]
|язык = Русский и Английский
|система = Windows
|онлайн =
|написано на = [[Visual Basic]]
|язык разработки = Собственный диалект [[URQL]]
|читаемый формат = [[.qst|Игры URQ (*.qst)]], [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]]
|создаваемый формат = [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]], [[.exe|Исполняемые файлы (*.exe)]]
|первый выпуск =
|последняя версия = 1.28 пре-релиз 6 (Квотерой (AkURQ2) 2.12 beta 8)
|дата последней версии = 06.08.2007
|состояние = Архивное
|лицензия = [[Freeware]]
|сайт =
}}

Один из наиболее популярных в своё время интерпретаторов [[URQ]], но в настоящий момент его разработка прекращена. Поддерживает все особенности [[RipURQ]] и [[URQ DOS]], а также имеет собственные расширения диалекта [[URQL]], в частности, поддерживает HTML-оформление квестов и математические функции. AkURQ также позволяет шифровать обычные игры в формате [[.qst]] в шифрованные и сжатые форматы [[.qs1]], [[.qs2]] и [[.qs3]] и запаковывать игры вместе с интерпретатором в единый [[.exe|исполняемый файл Windows]].

[[Изображение:Akurq.jpg|Интерпретатор AkURQ]]

Существовал проект AkURQ второго поколения под названием "Квотерой", но его наработки остались со статусом beta-версии.

Позже основным разработчиком AkURQ был создан принципиально новый интерпретатор [[UrqW]].

== Ссылки ==
Ссылку на скачивание последней версии AkURQ можно найти на [http://urq.plut.info/soft сайте разработчиков URQ-игр].

[[Медиа:AkURQ.rar|Документация по AkURQ от Корвина]]

== Особенности запуска игр под AkURQ ==
Существуют несколько версий интерпретатора, не совместимых друг с другом (самые популярные - AkURQ1.28pre1 и AkURQ1.28pre6). Запуск игры не под той версией, под которую она писалась, может привести к некорректной работе. Какая игра написана под какой интерпретатор, можно посмотреть [http://rilarhiv.ru/urq.htm здесь].

Также, для работы AkURQ может понадобиться файл RICHTX32.OCX. Скачать его можно на той же страничке.

'''Инструкция по установке'''<br/>
Файл RICHTX32.OCX следует положить в папку Windows\system32\<br/>
Далее, откройте командную строку от имени администратора.<br/>
Напишите в ней: <br/>
regsvr32 RICHTX32.OCX<br/>
Теперь можете открыть плеер AkURQ.<br/>

== См. также ==
* [[:Категория:Игры на AkURQ|Игры на AkURQ]]

AkURQ

2019-06-28T12:15:28Z

Ajenta: /* Особенности запуска игр под AkURQ */

{{product info
|название =
|тип = Интерпретаторы URQ, Инструменты
|разработчик = [[Разработчик::Севрюгин, Александр|Александр Севрюгин]] при участии [[Разработчик::SFeLi]]
|язык = Русский и Английский
|система = Windows
|онлайн =
|написано на = [[Visual Basic]]
|язык разработки = Собственный диалект [[URQL]]
|читаемый формат = [[.qst|Игры URQ (*.qst)]], [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]]
|создаваемый формат = [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]], [[.exe|Исполняемые файлы (*.exe)]]
|первый выпуск =
|последняя версия = 1.28 пре-релиз 6 (Квотерой (AkURQ2) 2.12 beta 8)
|дата последней версии = 06.08.2007
|состояние = Архивное
|лицензия = [[Freeware]]
|сайт =
}}

Один из наиболее популярных в своё время интерпретаторов [[URQ]], но в настоящий момент его разработка прекращена. Поддерживает все особенности [[RipURQ]] и [[URQ DOS]], а также имеет собственные расширения диалекта [[URQL]], в частности, поддерживает HTML-оформление квестов и математические функции. AkURQ также позволяет шифровать обычные игры в формате [[.qst]] в шифрованные и сжатые форматы [[.qs1]], [[.qs2]] и [[.qs3]] и запаковывать игры вместе с интерпретатором в единый [[.exe|исполняемый файл Windows]].

[[Изображение:Akurq.jpg|Интерпретатор AkURQ]]

Существовал проект AkURQ второго поколения под названием "Квотерой", но его наработки остались со статусом beta-версии.

Позже основным разработчиком AkURQ был создан принципиально новый интерпретатор [[UrqW]].

== Ссылки ==
Ссылку на скачивание последней версии AkURQ можно найти на [http://urq.plut.info/soft сайте разработчиков URQ-игр].

[[Медиа:AkURQ.rar|Документация по AkURQ от Корвина]]

== Особенности запуска игр под AkURQ ==
Существуют несколько версий интерпретатора, не совместимых друг с другом (самые популярные - AkURQ1.28pre1 и AkURQ1.28pre6). Запуск игры не под той версией, под которую она писалась, может привести к некорректной работе. Какая игра написана под какой интерпретатор, можно посмотреть [http://rilarhiv.ru/urq.htm здесь].

Также, для работы AkURQ может понадобиться файл RICHTX32.OCX. Скачать его можно на той же страничке.

'''Инструкция по установке'''<br/>
Файл RICHTX32.OCX следует положить в папку Windows\system32\<br/>
Далеле, откройте командную строку от имени администратора.<br/>
Напишите в ней: <br/>
regsvr32 RICHTX32.OCX<br/>
Теперь можете открыть плеер AkURQ.<br/>

== См. также ==
* [[:Категория:Игры на AkURQ|Игры на AkURQ]]

AkURQ

2019-06-28T12:15:10Z

Ajenta: /* Особенности запуска игр под AkURQ */

{{product info
|название =
|тип = Интерпретаторы URQ, Инструменты
|разработчик = [[Разработчик::Севрюгин, Александр|Александр Севрюгин]] при участии [[Разработчик::SFeLi]]
|язык = Русский и Английский
|система = Windows
|онлайн =
|написано на = [[Visual Basic]]
|язык разработки = Собственный диалект [[URQL]]
|читаемый формат = [[.qst|Игры URQ (*.qst)]], [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]]
|создаваемый формат = [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]], [[.exe|Исполняемые файлы (*.exe)]]
|первый выпуск =
|последняя версия = 1.28 пре-релиз 6 (Квотерой (AkURQ2) 2.12 beta 8)
|дата последней версии = 06.08.2007
|состояние = Архивное
|лицензия = [[Freeware]]
|сайт =
}}

Один из наиболее популярных в своё время интерпретаторов [[URQ]], но в настоящий момент его разработка прекращена. Поддерживает все особенности [[RipURQ]] и [[URQ DOS]], а также имеет собственные расширения диалекта [[URQL]], в частности, поддерживает HTML-оформление квестов и математические функции. AkURQ также позволяет шифровать обычные игры в формате [[.qst]] в шифрованные и сжатые форматы [[.qs1]], [[.qs2]] и [[.qs3]] и запаковывать игры вместе с интерпретатором в единый [[.exe|исполняемый файл Windows]].

[[Изображение:Akurq.jpg|Интерпретатор AkURQ]]

Существовал проект AkURQ второго поколения под названием "Квотерой", но его наработки остались со статусом beta-версии.

Позже основным разработчиком AkURQ был создан принципиально новый интерпретатор [[UrqW]].

== Ссылки ==
Ссылку на скачивание последней версии AkURQ можно найти на [http://urq.plut.info/soft сайте разработчиков URQ-игр].

[[Медиа:AkURQ.rar|Документация по AkURQ от Корвина]]

== Особенности запуска игр под AkURQ ==
Существуют несколько версий интерпретатора, не совместимых друг с другом (самые популярные - AkURQ1.28pre1 и AkURQ1.28pre6). Запуск игры не под той версией, под которую она писалась, может привести к некорректной работе. Какая игра написана под какой интерпретатор, можно посмотреть [http://rilarhiv.ru/urq.htm здесь].

Также, для работы AkURQ может понадобиться файл RICHTX32.OCX. Скачать его можно на той же страничке.

'''Инструкция по установке'''<br/>
Файл RICHTX32.OCX следует положить в папку Windows\system32\<br/>
Далеле, откройте командную строку от имени администратора.<br/>
Напишите в ней: <br/>
regsvr32 RICHTX32.OCX<br/>
Теперь можете открыть плеер AkURQ<br/>

== См. также ==
* [[:Категория:Игры на AkURQ|Игры на AkURQ]]

AkURQ

2019-06-28T12:14:00Z

Ajenta: /* Особенности запуска игр под AkURQ */

{{product info
|название =
|тип = Интерпретаторы URQ, Инструменты
|разработчик = [[Разработчик::Севрюгин, Александр|Александр Севрюгин]] при участии [[Разработчик::SFeLi]]
|язык = Русский и Английский
|система = Windows
|онлайн =
|написано на = [[Visual Basic]]
|язык разработки = Собственный диалект [[URQL]]
|читаемый формат = [[.qst|Игры URQ (*.qst)]], [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]]
|создаваемый формат = [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]], [[.exe|Исполняемые файлы (*.exe)]]
|первый выпуск =
|последняя версия = 1.28 пре-релиз 6 (Квотерой (AkURQ2) 2.12 beta 8)
|дата последней версии = 06.08.2007
|состояние = Архивное
|лицензия = [[Freeware]]
|сайт =
}}

Один из наиболее популярных в своё время интерпретаторов [[URQ]], но в настоящий момент его разработка прекращена. Поддерживает все особенности [[RipURQ]] и [[URQ DOS]], а также имеет собственные расширения диалекта [[URQL]], в частности, поддерживает HTML-оформление квестов и математические функции. AkURQ также позволяет шифровать обычные игры в формате [[.qst]] в шифрованные и сжатые форматы [[.qs1]], [[.qs2]] и [[.qs3]] и запаковывать игры вместе с интерпретатором в единый [[.exe|исполняемый файл Windows]].

[[Изображение:Akurq.jpg|Интерпретатор AkURQ]]

Существовал проект AkURQ второго поколения под названием "Квотерой", но его наработки остались со статусом beta-версии.

Позже основным разработчиком AkURQ был создан принципиально новый интерпретатор [[UrqW]].

== Ссылки ==
Ссылку на скачивание последней версии AkURQ можно найти на [http://urq.plut.info/soft сайте разработчиков URQ-игр].

[[Медиа:AkURQ.rar|Документация по AkURQ от Корвина]]

== Особенности запуска игр под AkURQ ==
Существуют несколько версий интерпретатора, не совместимых друг с другом (самые популярные - AkURQ1.28pre1 и AkURQ1.28pre6). Запуск игры не под той версией, под которую она писалась, может привести к некорректной работе. Какая игра написана под какой интерпретатор, можно посмотреть [http://rilarhiv.ru/urq.htm здесь].

Также, для работы AkURQ может понадобиться файл RICHTX32.OCX. Скачать его можно на той же страничке.

'''Инструкция по установке'''<br/>
''Файл RICHTX32.OCX следует положить в папку Windows\system32\''<br/>
''Далеле, откройте командную строку от имени администратора.''<br/>
''Напишите в ней: regsvr32 RICHTX32.OCX''<br/>
''Теперь можете открыть плеер AkURQ''<br/>

== См. также ==
* [[:Категория:Игры на AkURQ|Игры на AkURQ]]

AkURQ

2019-06-28T12:13:20Z

Ajenta: /* Особенности запуска игр под AkURQ */

{{product info
|название =
|тип = Интерпретаторы URQ, Инструменты
|разработчик = [[Разработчик::Севрюгин, Александр|Александр Севрюгин]] при участии [[Разработчик::SFeLi]]
|язык = Русский и Английский
|система = Windows
|онлайн =
|написано на = [[Visual Basic]]
|язык разработки = Собственный диалект [[URQL]]
|читаемый формат = [[.qst|Игры URQ (*.qst)]], [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]]
|создаваемый формат = [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]], [[.exe|Исполняемые файлы (*.exe)]]
|первый выпуск =
|последняя версия = 1.28 пре-релиз 6 (Квотерой (AkURQ2) 2.12 beta 8)
|дата последней версии = 06.08.2007
|состояние = Архивное
|лицензия = [[Freeware]]
|сайт =
}}

Один из наиболее популярных в своё время интерпретаторов [[URQ]], но в настоящий момент его разработка прекращена. Поддерживает все особенности [[RipURQ]] и [[URQ DOS]], а также имеет собственные расширения диалекта [[URQL]], в частности, поддерживает HTML-оформление квестов и математические функции. AkURQ также позволяет шифровать обычные игры в формате [[.qst]] в шифрованные и сжатые форматы [[.qs1]], [[.qs2]] и [[.qs3]] и запаковывать игры вместе с интерпретатором в единый [[.exe|исполняемый файл Windows]].

[[Изображение:Akurq.jpg|Интерпретатор AkURQ]]

Существовал проект AkURQ второго поколения под названием "Квотерой", но его наработки остались со статусом beta-версии.

Позже основным разработчиком AkURQ был создан принципиально новый интерпретатор [[UrqW]].

== Ссылки ==
Ссылку на скачивание последней версии AkURQ можно найти на [http://urq.plut.info/soft сайте разработчиков URQ-игр].

[[Медиа:AkURQ.rar|Документация по AkURQ от Корвина]]

== Особенности запуска игр под AkURQ ==
Существуют несколько версий интерпретатора, не совместимых друг с другом (самые популярные - AkURQ1.28pre1 и AkURQ1.28pre6). Запуск игры не под той версией, под которую она писалась, может привести к некорректной работе. Какая игра написана под какой интерпретатор, можно посмотреть [http://rilarhiv.ru/urq.htm здесь].

Также, для работы AkURQ может понадобиться файл RICHTX32.OCX. Скачать его можно на той же страничке.

'''Инструкция по установке'''
''Файл RICHTX32.OCX следует положить в папку Windows\system32\''
''Далеле, откройте командную строку от имени администратора.''
''Напишите в ней: regsvr32 RICHTX32.OCX''
''Теперь можете открыть плеер AkURQ''

== См. также ==
* [[:Категория:Игры на AkURQ|Игры на AkURQ]]

AkURQ

2019-06-28T12:12:52Z

Ajenta: /* Особенности запуска игр под AkURQ */

{{product info
|название =
|тип = Интерпретаторы URQ, Инструменты
|разработчик = [[Разработчик::Севрюгин, Александр|Александр Севрюгин]] при участии [[Разработчик::SFeLi]]
|язык = Русский и Английский
|система = Windows
|онлайн =
|написано на = [[Visual Basic]]
|язык разработки = Собственный диалект [[URQL]]
|читаемый формат = [[.qst|Игры URQ (*.qst)]], [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]]
|создаваемый формат = [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]], [[.exe|Исполняемые файлы (*.exe)]]
|первый выпуск =
|последняя версия = 1.28 пре-релиз 6 (Квотерой (AkURQ2) 2.12 beta 8)
|дата последней версии = 06.08.2007
|состояние = Архивное
|лицензия = [[Freeware]]
|сайт =
}}

Один из наиболее популярных в своё время интерпретаторов [[URQ]], но в настоящий момент его разработка прекращена. Поддерживает все особенности [[RipURQ]] и [[URQ DOS]], а также имеет собственные расширения диалекта [[URQL]], в частности, поддерживает HTML-оформление квестов и математические функции. AkURQ также позволяет шифровать обычные игры в формате [[.qst]] в шифрованные и сжатые форматы [[.qs1]], [[.qs2]] и [[.qs3]] и запаковывать игры вместе с интерпретатором в единый [[.exe|исполняемый файл Windows]].

[[Изображение:Akurq.jpg|Интерпретатор AkURQ]]

Существовал проект AkURQ второго поколения под названием "Квотерой", но его наработки остались со статусом beta-версии.

Позже основным разработчиком AkURQ был создан принципиально новый интерпретатор [[UrqW]].

== Ссылки ==
Ссылку на скачивание последней версии AkURQ можно найти на [http://urq.plut.info/soft сайте разработчиков URQ-игр].

[[Медиа:AkURQ.rar|Документация по AkURQ от Корвина]]

== Особенности запуска игр под AkURQ ==
Существуют несколько версий интерпретатора, не совместимых друг с другом (самые популярные - AkURQ1.28pre1 и AkURQ1.28pre6). Запуск игры не под той версией, под которую она писалась, может привести к некорректной работе. Какая игра написана под какой интерпретатор, можно посмотреть [http://rilarhiv.ru/urq.htm здесь].

Также, для работы AkURQ может понадобиться файл RICHTX32.OCX. Скачать его можно на той же страничке.

'''Инструкция по установке'''
Файл RICHTX32.OCX следует положить в папку Windows\system32\
Далеле, откройте командную строку от имени администратора.
Напишите в ней: regsvr32 RICHTX32.OCX
Теперь можете открыть плеер AkURQ

== См. также ==
* [[:Категория:Игры на AkURQ|Игры на AkURQ]]

AkURQ

2019-06-28T12:12:32Z

Ajenta: /* Особенности запуска игр под AkURQ */

{{product info
|название =
|тип = Интерпретаторы URQ, Инструменты
|разработчик = [[Разработчик::Севрюгин, Александр|Александр Севрюгин]] при участии [[Разработчик::SFeLi]]
|язык = Русский и Английский
|система = Windows
|онлайн =
|написано на = [[Visual Basic]]
|язык разработки = Собственный диалект [[URQL]]
|читаемый формат = [[.qst|Игры URQ (*.qst)]], [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]]
|создаваемый формат = [[.qs1|Шифрованные игры URQ (*.qs1)]], [[.qs2|Шифрованные игры URQ (*.qs2)]], [[.qs3|Сжатые игры URQ (*.qs3)]], [[.exe|Исполняемые файлы (*.exe)]]
|первый выпуск =
|последняя версия = 1.28 пре-релиз 6 (Квотерой (AkURQ2) 2.12 beta 8)
|дата последней версии = 06.08.2007
|состояние = Архивное
|лицензия = [[Freeware]]
|сайт =
}}

Один из наиболее популярных в своё время интерпретаторов [[URQ]], но в настоящий момент его разработка прекращена. Поддерживает все особенности [[RipURQ]] и [[URQ DOS]], а также имеет собственные расширения диалекта [[URQL]], в частности, поддерживает HTML-оформление квестов и математические функции. AkURQ также позволяет шифровать обычные игры в формате [[.qst]] в шифрованные и сжатые форматы [[.qs1]], [[.qs2]] и [[.qs3]] и запаковывать игры вместе с интерпретатором в единый [[.exe|исполняемый файл Windows]].

[[Изображение:Akurq.jpg|Интерпретатор AkURQ]]

Существовал проект AkURQ второго поколения под названием "Квотерой", но его наработки остались со статусом beta-версии.

Позже основным разработчиком AkURQ был создан принципиально новый интерпретатор [[UrqW]].

== Ссылки ==
Ссылку на скачивание последней версии AkURQ можно найти на [http://urq.plut.info/soft сайте разработчиков URQ-игр].

[[Медиа:AkURQ.rar|Документация по AkURQ от Корвина]]

== Особенности запуска игр под AkURQ ==
Существуют несколько версий интерпретатора, не совместимых друг с другом (самые популярные - AkURQ1.28pre1 и AkURQ1.28pre6). Запуск игры не под той версией, под которую она писалась, может привести к некорректной работе. Какая игра написана под какой интерпретатор, можно посмотреть [http://rilarhiv.ru/urq.htm здесь].

Также, для работы AkURQ может понадобиться файл RICHTX32.OCX. Скачать его можно на той же страничке.

***Инструкция по установке***
Файл RICHTX32.OCX следует положить в папку Windows\system32\
Далеле, откройте командную строку от имени администратора.
Напишите в ней: regsvr32 RICHTX32.OCX
Теперь можете открыть плеер AkURQ

== См. также ==
* [[:Категория:Игры на AkURQ|Игры на AkURQ]]

FireURQ:Особенности реализации URQL

2019-03-06T13:53:32Z

Ajenta: /* Музыка */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости, при этом мелодии пересекаются. Если же поставить знак минуса перед временем затухания, то мелодии перекрываться не будут.

Пример:
'''music some.ogg, -1500'''

Переменная '''is_music''' равна '''1''', если в игре играет музыка, и '''0''' — если нет.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.png''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1. Для декоратора типа TEXTBUTTON данная переменная выровняет название кнопки согласно установленному значению.
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль. Для декоратора типа TEXTBUTTON данная переменная установит ширину кнопки независимо от ширины текста в ней (по умолчанию ширина кнопки равна ширине текста).
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно. Только для декораторов типа IMAGE.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительных команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, в старых версиях '''FireURQ''' (до версии 2.0) существовала возможность конвертации квеста в формате QSZ в исполняемый файл с помощью утилиты '''QSZ2EXE''', входившей в комплект поставки.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная '''save_success''' устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

Так же с версии 2.2 в FireURQ появилась возможность менять базовое имя файла сейва.
Переменная '''savenamebase''' хранит это имя. По умолчанию переменная содержит название файла игры.
Если значение поменять на '''«profile1»''', то файлы сохранений будут называться '''profile1.s01''', '''profile1.s02''' и т.д.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.

C версии '''FireURQ 2.2''' появилась возможность загружать сохранения непосредственно из слотов, не вызывая меню "Загрузить сохранение".

Если написать '''LOAD 1''', то будет загружено сохранение из первого слота. '''LOAD 0''' загрузит игру из слота автосохранения.

==Перманентное хранилище данных==

Начиная с версии 2.2 FireURQ обзавелась перманентным хранилищем данных.
Это переменные, которые не удаляются при '''perkill''' или перезапуске игры, автоматически подгружаются и, при их изменении, так же автоматически сохраняются в специальном файле.

Любая переменная, начинающаяся на '''gss_''' будет считаться перманентной.

Это позволит хранить глобальные настройки, которые не должны изменяться при перезапуске игры, а так же делать достижения и даже переносить параметры из игры в игру.

Команда '''gsskill''' полностью очищает хранилище.

== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логи прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.
* Переменная '''altenter_disable''' (по умолчанию '''0''') отвечает за то, что по комбинации клавишь '''Alt + Enter''' окно игры будет открываться на весь экран или становиться снова окном. Для отключения реакции на эту комбинацию клавишь, следует установить переменную в '''1'''.
* Переменная '''escape_disable''' (по умолчанию '''0''') отвечает за показ системного меню по нажатию клавиши '''Esc'''. Для отключения реакции на эту клавижшу клавишу, следует установить переменную в '''1'''.

FireURQ:Особенности реализации URQL

2019-03-06T13:50:44Z

Ajenta: /* Музыка */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости, при этом мелодии пересекаются. Если же поставить знак минуса перед временем затухания, то мелодии перекрываться не будут.

Пример:
'''music some.ogg, -1500'''

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.png''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1. Для декоратора типа TEXTBUTTON данная переменная выровняет название кнопки согласно установленному значению.
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль. Для декоратора типа TEXTBUTTON данная переменная установит ширину кнопки независимо от ширины текста в ней (по умолчанию ширина кнопки равна ширине текста).
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно. Только для декораторов типа IMAGE.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительных команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, в старых версиях '''FireURQ''' (до версии 2.0) существовала возможность конвертации квеста в формате QSZ в исполняемый файл с помощью утилиты '''QSZ2EXE''', входившей в комплект поставки.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная '''save_success''' устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

Так же с версии 2.2 в FireURQ появилась возможность менять базовое имя файла сейва.
Переменная '''savenamebase''' хранит это имя. По умолчанию переменная содержит название файла игры.
Если значение поменять на '''«profile1»''', то файлы сохранений будут называться '''profile1.s01''', '''profile1.s02''' и т.д.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.

C версии '''FireURQ 2.2''' появилась возможность загружать сохранения непосредственно из слотов, не вызывая меню "Загрузить сохранение".

Если написать '''LOAD 1''', то будет загружено сохранение из первого слота. '''LOAD 0''' загрузит игру из слота автосохранения.

==Перманентное хранилище данных==

Начиная с версии 2.2 FireURQ обзавелась перманентным хранилищем данных.
Это переменные, которые не удаляются при '''perkill''' или перезапуске игры, автоматически подгружаются и, при их изменении, так же автоматически сохраняются в специальном файле.

Любая переменная, начинающаяся на '''gss_''' будет считаться перманентной.

Это позволит хранить глобальные настройки, которые не должны изменяться при перезапуске игры, а так же делать достижения и даже переносить параметры из игры в игру.

Команда '''gsskill''' полностью очищает хранилище.

== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логи прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.
* Переменная '''altenter_disable''' (по умолчанию '''0''') отвечает за то, что по комбинации клавишь '''Alt + Enter''' окно игры будет открываться на весь экран или становиться снова окном. Для отключения реакции на эту комбинацию клавишь, следует установить переменную в '''1'''.
* Переменная '''escape_disable''' (по умолчанию '''0''') отвечает за показ системного меню по нажатию клавиши '''Esc'''. Для отключения реакции на эту клавижшу клавишу, следует установить переменную в '''1'''.

FireURQ:Особенности реализации URQL

2019-03-06T13:45:44Z

Ajenta: /* Другое */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.png''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1. Для декоратора типа TEXTBUTTON данная переменная выровняет название кнопки согласно установленному значению.
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль. Для декоратора типа TEXTBUTTON данная переменная установит ширину кнопки независимо от ширины текста в ней (по умолчанию ширина кнопки равна ширине текста).
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно. Только для декораторов типа IMAGE.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительных команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, в старых версиях '''FireURQ''' (до версии 2.0) существовала возможность конвертации квеста в формате QSZ в исполняемый файл с помощью утилиты '''QSZ2EXE''', входившей в комплект поставки.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная '''save_success''' устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

Так же с версии 2.2 в FireURQ появилась возможность менять базовое имя файла сейва.
Переменная '''savenamebase''' хранит это имя. По умолчанию переменная содержит название файла игры.
Если значение поменять на '''«profile1»''', то файлы сохранений будут называться '''profile1.s01''', '''profile1.s02''' и т.д.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.

C версии '''FireURQ 2.2''' появилась возможность загружать сохранения непосредственно из слотов, не вызывая меню "Загрузить сохранение".

Если написать '''LOAD 1''', то будет загружено сохранение из первого слота. '''LOAD 0''' загрузит игру из слота автосохранения.

==Перманентное хранилище данных==

Начиная с версии 2.2 FireURQ обзавелась перманентным хранилищем данных.
Это переменные, которые не удаляются при '''perkill''' или перезапуске игры, автоматически подгружаются и, при их изменении, так же автоматически сохраняются в специальном файле.

Любая переменная, начинающаяся на '''gss_''' будет считаться перманентной.

Это позволит хранить глобальные настройки, которые не должны изменяться при перезапуске игры, а так же делать достижения и даже переносить параметры из игры в игру.

Команда '''gsskill''' полностью очищает хранилище.

== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логи прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.
* Переменная '''altenter_disable''' (по умолчанию '''0''') отвечает за то, что по комбинации клавишь '''Alt + Enter''' окно игры будет открываться на весь экран или становиться снова окном. Для отключения реакции на эту комбинацию клавишь, следует установить переменную в '''1'''.
* Переменная '''escape_disable''' (по умолчанию '''0''') отвечает за показ системного меню по нажатию клавиши '''Esc'''. Для отключения реакции на эту клавижшу клавишу, следует установить переменную в '''1'''.

FireURQ:Особенности реализации URQL

2018-07-26T13:41:48Z

Ajenta: добавлено уточнение

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1. Для декоратора типа TEXTBUTTON данная переменная выровняет название кнопки согласно установленному значению.
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль. Для декоратора типа TEXTBUTTON данная переменная установит ширину кнопки независимо от ширины текста в ней (по умолчанию ширина кнопки равна ширине текста).
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно. Только для декораторов типа IMAGE.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительных команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, в старых версиях '''FireURQ''' (до версии 2.0) существовала возможность конвертации квеста в формате QSZ в исполняемый файл с помощью утилиты '''QSZ2EXE''', входившей в комплект поставки.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная '''save_success''' устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

Так же с версии 2.2 в FireURQ появилась возможность менять базовое имя файла сейва.
Переменная '''savenamebase''' хранит это имя. По умолчанию переменная содержит название файла игры.
Если значение поменять на '''«profile1»''', то файлы сохранений будут называться '''profile1.s01''', '''profile1.s02''' и т.д.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.

C версии '''FireURQ 2.2''' появилась возможность загружать сохранения непосредственно из слотов, не вызывая меню "Загрузить сохранение".

Если написать '''LOAD 1''', то будет загружено сохранение из первого слота. '''LOAD 0''' загрузит игру из слота автосохранения.

==Перманентное хранилище данных==

Начиная с версии 2.2 FireURQ обзавелась перманентным хранилищем данных.
Это переменные, которые не удаляются при '''perkill''' или перезапуске игры, автоматически подгружаются и, при их изменении, так же автоматически сохраняются в специальном файле.

Любая переменная, начинающаяся на '''gss_''' будет считаться перманентной.

Это позволит хранить глобальные настройки, которые не должны изменяться при перезапуске игры, а так же делать достижения и даже переносить параметры из игры в игру.

Команда '''gsskill''' полностью очищает хранилище.

== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логи прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

Паровозик 3

2018-03-12T12:25:19Z

Ajenta: /* Вагончики */

Третье в истории РИЛ интерактивное развлечение, где желающие участвовать выбирают себе неделю для написания игры. Таким образом, из вагонов-игр составляется сборник-"паровоз". Начался 27 марта 2017 года. Продолжается, пока не закончатся желающие.
== Вагончики ==
# 27 марта - 2 апреля - [[Ajenta Arrow]] - [[Лабиринт чудовищ]] ([[FireURQ]])
# 3 апреля - 9 апреля - [[Saint]] - [[Кольцо]] (FireURQ)
# 10 апреля - 16 апреля - [[Fireton]] - [[Подземелье сокровищ]] ([[FireURQ]])
# 17 апреля - 23 апреля - [[Korwin]] - [[Любовь и чёрная пантера]] ([[FireURQ]])
# 24 апреля - 30 апреля - [[cHameleon]] - [[Обычный выходной]] ([[FireURQ]])
# 1 мая - 7 мая - [[Антон Ласточкин]] - [[Антиквест]] ([[RTADS]])
# 8 мая - 14 мая - [[tregor]] - [[История 2-й ударной армии]] ([[QSP]])
# 15 мая - 21 мая - [[alkor]] - [[Ученик мага]] ([[RTADS]])
# 22 мая - 28 мая - <strike>Ajenta Arrow </strike> [[Zlobot]] - [[Relicta]] ([[INSTEAD]])
# 29 мая - 4 июня - [[Михаил Никифоров]] - [[Потомок оружейника]] ([[Apero]])
# 5 июня - 11 июня - [[Edelveiss]] - [[Интервью]] ([[QSP]])
# 12 июня - 18 июня - [[Enola]] - [[Emoji game]] ([[Twine]])
# 19 июня - 25 июня - [[SneakBug8]] - [[Homeland and Democracy]] ([[Unity]])
# 26 июня - 2 июля - <strike>Alcohol</strike> [[Saint]] - [[Ночь, казино, фонарь, аптека...]] ([[FireURQ]])
# 3 июля - 9 июля - [[Виталий Блинов]] и Co - [[Тестирование движка для текстовой игры]] ([[AXMA Story Maker]])
# 10 июля - 16 июля - [[Вета]] - [[Записки младшего властелина]] ([[FireURQ]])
# 17 июля - 23 июля - [[Nafanin]] - [вагон не докатился]
# 24 июля - 30 июля - [[Korwin]] - [[Star Hammer или Победитель платит за всё]] ([[FireURQ]])
# 31 июля - 6 августа - [[Поросёнок_Фунтик]] - [[Коробка]] ([[FireURQ]])
# 7 августа - 13 августа - [[Серый Волк]] - [вагон не докатился]
# 14 августа - 20 августа - [[Antokolos]] - [[Красная шапочка: в поисках начинки]] ([[INSTEAD]])
# 21 августа - 27 августа - [[techniX]] - [[Капсула]] ([[INSTEAD]])
# 28 августа - 3 сентября - [[Larson]] - [[Волшебный экзамен]] ([[QSP]])
# 4 сентября - 10 сетября - <strike>[[Oreolek]]</strike> [[Ajenta Arrow]] - [[Лабиринт чудовищ: спасение принцессы]] ([[FireURQ]])
# 11 сентября - 17 сентября - [[Enola]] - [вагон не докатился]
# 18 сентября - 24 сентября - [[Вереск]] - [[Ночные улицы и дождь...]] ([[UrqW]])
# 25 сентября - 1 октября - <strike>[[Korwin]]</strike> [[Серый Волк]] - [вагон не докатился]
# 2 октября - 8 октября - [[Никита Цейковец]] - [[Проклятье вервольфа]] ([[RTADS]])
# 9 октября - 15 октября - [[Korwin]] - [[Звезда Рэйвена]] ([[FireURQ]]) в рамках [[Неадекватная дуэль в поезде (Korwin - Enola)|Неадекватной дуэли Korwin vs Enola]]
# 16 октября - 22 октября - [[МАлышка]] - [[Вокзальные портреты]] ([[INSTEAD]])
# 23 октября - 29 октября - [[Freid]] - [вагон не докатился]
# 30 октября - 5 ноября - [[Spline]] - [[Библиотека]] ([[INSTEAD]])
# 6 ноября - 12 ноября - [[Вiтана Нирко|Витана Нiрко]] - [[На зерО]] ([[FireURQ]])
# 13 ноября - 19 ноября - [[Wol4ik]] - [[Долина кукол]] ([[INSTEAD]])
# 20 ноября - 26 ноября - [[МАлышка]] - [[Ледяное похищение]] ([[FireURQ]])

Первые три игры, неожидано для их авторов и организатора "Паровозика", приняли участие во внезапном конкурсе, что привело к небольшому скандалу. Подробности в соответствующей записи блога организатора данного спонтанного конкурса [[Трофимчук, Владимир|Владимира Трофимчука]] - [http://vtrollstory.blogspot.ru/2017/04/blog-post_23.html "Техосмотр в Паровозном Депо Трёх Вагонов"] (разборка в комментариях).

В последний момент своей недели(22-28 мая) Аджента уступила свою очередь Zlobot. Подробнее о скандале [http://if.zhuchkovs.com/2017/05/pro-pravila-pisanye-i-nepisanye/ тут].

Испугавшись [[Неадекватная дуэль в поезде (Korwin - Enola)|дуэли с Энолой]], Корвин поспешил отписаться от своей очереди на паровозике и уступить её Серому Волку, <strike>позорно зафейлившему</strike> не успевшему в свою прошлую неделю. Однако Серый Волк и в этот раз <strike>позорно зафейлил</strike> не успел. В то время, как Корвин выиграл у Энолы дуэль, которая <strike>позорно зафейлила</strike> не написала свой вагон, уже второй по счёту.

== Ссылки ==
* [http://urq.borda.ru/?1-0-0-00000522-000-0-0 Тема на форуме (там же можно записаться в участники)]
[[Категория:Паровоз]] [[Категория:2017]]
[[Дата начала::27.03.2017| ]]

FireURQ:Скины

2017-07-05T13:32:34Z

Ajenta: /* Украшения */

Скин игры - это такой файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста.
<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Изменение внешнего вида интерпретатора - это тема повышенной сложности. Поэтому, если вы сомневаетесь, нужны ли вам скины в вашей игре - они вам не нужны.
</div>

Кроме того, чтобы понимать, о чём будет идти речь в данном разделе, нужно хорошо представлять себе, что такое язык разметки XML.

==Общие сведения==

Файл описания скина представляет собой файл в формате XML с именем '''skin.xml''', лежащий в папке с игрой. Если ваша игра упакована в файл с расширением QSZ, то скин и все его ресурсы должны помещаться внутри архива.

Вот, для примера, как выглядит скин FireURQ по умолчанию (который загружается тогда, когда скин игры не определён):

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="800" height="600" />
'''<resources>
'''<texture name="res" file="furq_texture.png" />
'''</resources>
'''<main>
'''<textpane left="20" top="55" width="760" height="525" />
'''<menus>
'''<sysbutton tex="res" tx="0" ty="0" width="106" height="46" posx="0" posy="0"/>
'''<sysmenu posx="20" posy="42" datum="lt"/>
'''<invbutton tex="res" tx="424" ty="0" width="130" height="46" posx="671" posy="0"/>
'''<invmenu posx="780" posy="42" datum="rt"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="47" width="566" height="17" posx="105" posy="29"/>
'''</decorations>
'''</main>
'''</skin>

А это скин из демо для FireURQ 1.3:

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="1024" height="768" />
'''<resources>
'''<texture name="res" file="demo_tex.png" />
'''<font name="btnfont" file="buttons_font.fnt" />
'''<font name="mnufont" file="menu_font.fnt" />
'''<buttonframe name="tbuttons" tex="res" font="btnfont" texx="0" texy="210" width="109" height="55" leftw="31" midw="10" cnormal="FF94cddb" cfocused="FFFFFFFF" />
'''</resources>
'''<splash bgcolor="FF00042c">
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />
'''</splash>
'''<main bgcolor="FF00042c">
'''<textpane bframe="tbuttons" top="55" left="255" width="555" height="615" btnalign="3"/>
'''<menus font="mnufont" bgcolor="c01c79ae" bordercolor="ff60c5ff" vindent="1" textcolor="FFFFFFFF" disabledcolor="FF818181" selectioncolor="E0003f95">
'''<invbutton tex="res" tx="341" ty="10" width="55" height="55" posx="959" posy="703"/>
'''<sysbutton tex="res" tx="342" ty="80" width="60" height="60" posx="0" posy="708"/>
'''<sysmenu posx="60" posy="720" datum="lb"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="285" width="1024" height="257" posx="0" posy="511"/>
'''</decorations>
'''</main>
'''</skin>

Как видно, первой должна идти строчка, определяющая формат XML-документа:
'''<?xml version="1.0" encoding="window-1251"?>

А все данные собственно скина размещаются в тегах внутри корневого тега skin:
'''<skin>
'''...
'''</skin>

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font>
*Названия тегов и параметров чувствительны к регистру.
*Стоит принять во внимание, что интерфейс игры без скина и с пустым скином (в котором есть только тег '''skin''', но внутри него ничего нет) будут отличаться. В первом случае будет загружен скин по умолчанию. Во втором - никакого скина загружено не будет и FireURQ сама создаст минимально возможный для игры интерфейс, используя значения по умолчанию, зашитые в программу.</div>

==Настройки экрана==

Можно задать размер окна FireURQ с помощью тега '''screen'''.

'''''Параметры:'''''
*'''width''' - ширина окна (по умолчанию 800)
*'''height''' - высота окна (по умолчанию 600)
*'''fullscreen''' - если равна 1, то FireURQ запустится сразу в полноэкранном режиме (по умолчанию 0)

'''''Пример:'''''
'''<screen width="1024" height="768" fullscreen="1" />
FireURQ установит размер окна в 1024х768 и запустится в полноэкранном режиме.

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

Учтите, что хотя размер окна можно задать хоть 628х315, но если вы установите размер, не поддерживаемый видеокартой и монитором, то FireURQ не сможет запуститься в полноэкранном режиме!

==Ресурсы==

Ресурсы - это текстуры, шрифты и заранее определённые рамки для кнопок, которые используются при оформлении скина. Каждому ресурсу присваивается имя, на которое потом ссылаются другие структуры данных, описывающие скин. Все ресурсы помещаются внутри тега '''resources'''.

===Текстуры===

Ресурс текстуры описывается тегом texture.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''file''' - файл текстуры (изображение JPEG, TGA или PNG).

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

Учтите, что многие из элементов управления (кнопки, например) должны иметь прозрачные элементы для того, чтобы смотреться хорошо. Прозрачность поддерживается только для 24-битных PNG и TGA.

===Шрифты===

Ресурс шрифта описывается тегом '''font'''.

Параметры:
*'''name''' - имя ресурса
*'''file''' - файл шрифта, подготовленного программой fonted из поставки FireURQ, или шрифт TrueType

===Рамки кнопок===

Рамка кнопок описывает оформление кнопки с текстом внутри. В настоящий момент данный ресурс используется только для оформления кнопок перехода между локациями, но не исключено, что в будущем он будет использоваться для чего-то ещё (например, кастомных кнопок внутри квеста). Ресурс рамки кнопок описывается тегом '''buttonframe'''.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''tex''' - имя ресурса текстуры, на которой нарисован глиф кнопки
*'''font''' - имя ресурса шрифта, который будет использован для подписи кнопки
*'''texx''' и '''texy''' - координаты глифа кнопки на текстуре
*'''width''' и '''height''' - ширина и высота глифа кнопки
*'''leftw''' - ширина левой "крышечки" кнопки
*'''midw''' - ширина средней части кнопки
*'''cnormal''' - цвет (в шестнадцатиричном формате) надписи в нормальном состоянии (по умолчанию - FFA0A0A0 )
*'''cdisabled''' - цвет надписи в неактивном состоянии (по умолчанию - FF606060 )
*'''cfocused''' - цвет надписи при наведении мыши/перемещении фокуса (по умолчанию - FFA0A0FF )

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

На текстуре должны быть расположены справа налево три глифа - для каждого из состояний кнопки (обычное, неактивное и сфокусированное). Разные параметры этого ресурса легче всего проиллюстрировать на картинке (это то, как определена рамка кнопок на текстуре по умолчанию, изображение увеличено):

[[Изображение:Btn schema.png]]

==Интерфейс сохранения/загрузки. ==

Описывается тегом '''saveload''' и располагается в главном элементе '''skin'''

'''''Параметры:'''''
*'''bgcolor''' - цвет фона в шестнадцатеричном формате
*'''captioncolor''' - цвет заголовка в шестнадцатеричном формате
*'''captionfont''' - шрифт заголовка

'''''Пример:'''''
'''<saveload bgcolor="C0000000" captioncolor="FFFFBB4F" captionfont="myfont">'''
'''<buttons frame="myframe" />'''
'''</saveload>'''

Если '''myframe''' не определена, то берётся системная кнопка, которая используется обычно в игре. Если '''myfont''' не определён, берётся системный шрифт. Цвета указаны те, которые берутся по умолчанию. Для кнопок, использующихся на экране сохранения/загрузки, необходимо четыре состояния: нормальное, дизабленое, выбранное и нажатое.

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

'''''Пример:'''''
'''<saveload>'''
'''...'''
'''<backbutton tex="res" tx="565" ty="106" width="50" height="50" posx="35" posy="60"/>'''
'''...'''
'''</saveload>'''

==Заставка==

Заставка (сплеш-скрин) показывается при запуске игры. Настройки заставки помещатся в теге '''splash'''. Если тег '''splash''' отсутствует в скине, то проигрывается стандартная заставка.

'''''Параметры тега''''' ''splash'':
*'''bgcolor''' - цвет фона в шеснадцатеричном формате (по умолчанию - 0)
*'''vcolor''' - цвет надписи о версии FireURQ (по умолчанию - FFEE9A00)

Внутри тега '''splash''' может помещаться тег '''logo''', с помощью которого можно заменить логотип FireURQ на изображение чего-нибудь другого.

'''''Параметры тега''''' ''logo'':
*'''tex''' - имя ресурса текстуры, на которой нарисован логотип
*'''tx''' и '''ty''' - координаты верхнего левого угла логотипа на текстуре
*'''width''' и '''height''' - ширина и высота изображения логотипа

'''''Пример:'''''
'''<splash bgcolor="FF000000" vcolor="FFEE9A00">'''
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />'''
'''</splash>'''

==Основной раздел==

Основной раздел скина, описывающий интерфейс собственно проигрывателя, располагается внутри тега '''main'''. Если в скине отсутствует тег '''main''', то создаётся интерфейс по умолчанию - чёрный фон, текстовое поле занимает почти всё окно (с небольшими отступами), кнопки меню и инвентаря отсутствуют (меню и инвентарь можно вызвать только с клавиатуры), загружаются стандартные шрифты и стандартная рамка кнопок, никаких украшений.

'''''Параметры тега''''' ''main'':
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - 0)

===Текстовое поле===

Настройки текстового поля определяются с помощью тега '''textpane''' внутри тега '''main'''.

'''''Параметры:'''''
*'''font''' - имя ресурса шрифта текстового поля (по умолчанию - как в стандартном скине)
*'''bframe''' - имя ресурса рамки (стиля) кнопок, которая будет использована для оформления кнопок действий (по умолчанию - как в стандартном скине)
*'''left''' и '''top''' - координаты левого верхнего угла текстового поля в окне FireURQ (по умолчанию - 20, 10)
*'''width''' и '''height''' - ширина и высота текстового поля (по умолчанию выбираются так, чтобы правый край отставал на 20 пикселей от края окна, а нижний край - на 10 пикселов от нижнего края окна)
*'''btnalign''' - выравнивание кнопок (1 - по левому краю, 2 - по правому, 3 - по центру)
*'''btntxtalign''' - выравнивание текста на кнопках (так же, 1 - по левому краю, 2 - по правому, 3 - по центру)

'''''Пример:'''''
'''<textpane font="georgia[24]" bframe="tbuttons" top="30" left="30" width="400" height="500" btnalign="3" btntxtalign="3"/>'''
создаст текстовое поле с шрифтом 24 размера типа georgia и определёнными вами кнопками, с координатами левого верхнего угла (30, 30),
с шириной 400 пикселов и высотой 500 пикселов, и с выравнивание текста внутри поля по центру.
Внутри кнопок текст так же будет выровнен по центру.

===Меню и инвентарь===

Параметры меню описываются внутри тега '''menus'''. И системное меню, и меню инвентаря имеют единый стиль, т.е. цвета и шрифт для них одинаковые.

'''''Параметры тега''''' ''menus'':
*'''font''' - имя ресурса шрифта меню (по умолчанию - как в стандартном скине)
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - FFFFFFFF)
*'''bordercolor''' - цвет рамки (по умолчанию - FFA0A0A0)
*'''textcolor''' - цвет текста пунктов меню (по умолчанию - FF000000)
*'''selectioncolor''' - цвет фона выделенного пункта меню (по умолчанию - FF0000A0)
*'''selectedcolor''' - цвет текста выделенного пункта меню (по умолчанию - FFFFFFFF)
*'''disabledcolor''' - цвет текста неактивного пункта меню (по умолчанию - FFC0C0C0)
*'''hindent''' - отступ в пикселях слева и справа от текста до рамки (по умолчанию - 2)
*'''vindent''' - отступ сверху и снизу от текста до следующего пункта меню в пикселях (по умолчанию - 2)

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

Лучше всего понять, к чему относятся те или иные параметры можно, взглянув на рисунок:

[[Изображение:Menu schema.png]]

'''''Пример:'''''
'''<menus font="myfont" bgcolor="FFFFFFFF" bordercolor="FFA0A0A0" textcolor="FF000000" selectioncolor="FF0000A0" selectedcolor="FFFFFFFF" disabledcolor="FFC0C0C0"'''
'''hindent="2" vindent="2">'''
'''</menus>'''

====Кнопки системного меню и инвентаря====

Внутри тега '''menus''' могут располагаться теги '''sysbutton''' и '''invbutton''', определяющие кнопки вызова системного меню и инвентаря соответственно. Если этих тегов нет в скине, то соответствующие кнопки созданы не будут и соответствующие меню можно будет вызвать только с клавиатуры.

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисованы глифы кнопки (всего их должно быть четыре - нормальная, неактивная, выделенная и нажатая)
*'''tx''' и '''ty''' - координаты верхнего левого угла первого глифа на текстуре
*'''width''' и '''height''' - ширина и высота кнопки
*'''posx''' и '''posy''' - координаты кнопки в окне FireURQ

'''''Пример:'''''
'''<invbutton tex="res" tx="300" ty="10" width="50" height="50" posx="500" posy="0"/>'''
'''<sysbutton tex="res" tx="400" ty="80" width="60" height="60" posx="0" posy="0"/>'''

====Позиция меню на экране====

Если определены кнопки для системного меню и инвентаря, то FireURQ использует специальный алгоритм, чтобы определить как и в каком месте должны раскрываться соответствующие меню. Например, если кнопка системного меню сделана в правом нижнем углу окна, то системное меню будет раскрываться над этой кнопкой с привязкой за правый нижний угол.

Если кнопки не определены, то системное меню будет открываться в левом верхнем углу окна, а инвентарь - в правом верхнем.

Однако, есть возможность жёстко задать координаты, где будет открываться то или иное меню. Так сделано, например, в стандартном скине. Это возможно с помощью тегов '''sysmenu''' и '''invmenu'''.

'''''Параметры:'''''
*'''posx''' и '''posy''' - координаты одного из углов меню в окне FireURQ
*'''datum''' - указание на то, за какой, собственно, угол меню осуществляется привязка. Возможны четыре значения - '''lt''' (по умолчанию), '''lb''', '''rt''' и '''rb'''. Левый верхний, левый нижний, правый верхний и правый нижний. Привязка влияет на то, как будет открываться меню. Например, если для меню указал параметр '''lb''', то оно будет открываться "вверх" и "вправо".

'''''Пример:'''''
'''<sysmenu posx="0" posy="0" datum="lt"/>''' Системное меню будет открываться в левом верхнем углу экрана
'''<invmenu posx="800" posy="0" datum="rt"/>''' Инвентарь будет открываться в правом верхнем углу экрана,
если ширина окна игры равна 800 пикселей (по умолчанию).

===Иконки состояний===

Иконки состояний - это мигающие изображения, появляющиеся в особые моменты игры. Все описания иконок состояний размещаются внутри тега '''icons''', который в свою очередь размещается внутри тега '''main'''. При этом существуют три типа этих иконок, описывамых в тегах '''timer''' (иконка ожидания, появляется при команде ''pause''), '''anykey''' (когда игра ждёт нажатия клавиши) и '''scroll''' (когда текст локации не помещается целиком и игра ждёт нажатия клавиши, чтобы продолжить вывод текста). Каждый из этих тегов имеет следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисована иконка
*'''tx''' и '''ty''' - координаты верхнего левого угла иконки на текстуре
*'''width''' и '''height''' - ширина и высота изображения иконки

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

Все иконки всегда появляются на экране на одном месте - в правом нижнем углу текстового поля.

'''''Пример:'''''
'''<icons>'''
'''<scroll tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<timer tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<anykey tex="res" tx="0" ty="0" width="9" height="14" />'''
'''</icons>'''
Этот код будет выводить одну и ту же иконку из ресурса '''res''' для всех состояний.

===Украшения===

Существует возможность задать в скине изображения, которые являются частью оформления скина и всегда находятся на экране. Все элементы оформления помещаются внутри тега '''decorations''' и определяются тегом '''image''', имеющим следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисовано изображение
*'''tx''' и '''ty''' - координаты верхнего левого угла изображения на текстуре
*'''width''' и '''height''' - ширина и высота изображения
*'''posx''' и '''posy''' - координаты изображения в окне FireURQ
*'''flipx''' - если равна 1, то изображение будет перевёрнуто по вертикальной оси (по умолчанию 0)
*'''flipy''' - если равна 1, то изображение будет перевёрнуто по горизонтальной оси (по умолчанию 0)

С версии 2.2 появилась возможность установить '''posz''' - слой отрисовки декоратора. По умолчанию для отрисовки используется слой чуть выше текста.

'''''Примечания:'''''
Параметры '''flipx''' и '''flipy''' удобно использовать, когда элементы оформления являются зеркальным отражением друг друга. В этом случае можно создать на текстуре одно изображение и разместить его в окне FireURQ, переворачивая по-всякому, чтобы добиться симметричного рисунка.

'''''Пример:'''''
'''<decorations>'''
'''<image tex="res" tx="0" ty="0" width="800" height="600" posx="0" posy="0"/>'''
'''</decorations>'''
Данный код выведет картинку из ресурсного файла на весь экран игры (размеры окна игры взяты по умолчанию).

'''''Примечание:'''''
Данные декораторы невозможно стереть командой '''decordel'''. Они всегда будут находиться на экране игры.
Так же с версиии 2.2 появилась возможность не указывать ширину и высоту декоратора - по умолчанию будут браться полные размеры текстуры.

== См. также ==
* [[FireURQ:Скинование Дат-Навирэ]]
* Собственно для чего эта документация [[FireURQ]]

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

FireURQ:Скины

2017-07-05T13:31:54Z

Ajenta: /* Украшения */

Скин игры - это такой файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста.
<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Изменение внешнего вида интерпретатора - это тема повышенной сложности. Поэтому, если вы сомневаетесь, нужны ли вам скины в вашей игре - они вам не нужны.
</div>

Кроме того, чтобы понимать, о чём будет идти речь в данном разделе, нужно хорошо представлять себе, что такое язык разметки XML.

==Общие сведения==

Файл описания скина представляет собой файл в формате XML с именем '''skin.xml''', лежащий в папке с игрой. Если ваша игра упакована в файл с расширением QSZ, то скин и все его ресурсы должны помещаться внутри архива.

Вот, для примера, как выглядит скин FireURQ по умолчанию (который загружается тогда, когда скин игры не определён):

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="800" height="600" />
'''<resources>
'''<texture name="res" file="furq_texture.png" />
'''</resources>
'''<main>
'''<textpane left="20" top="55" width="760" height="525" />
'''<menus>
'''<sysbutton tex="res" tx="0" ty="0" width="106" height="46" posx="0" posy="0"/>
'''<sysmenu posx="20" posy="42" datum="lt"/>
'''<invbutton tex="res" tx="424" ty="0" width="130" height="46" posx="671" posy="0"/>
'''<invmenu posx="780" posy="42" datum="rt"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="47" width="566" height="17" posx="105" posy="29"/>
'''</decorations>
'''</main>
'''</skin>

А это скин из демо для FireURQ 1.3:

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="1024" height="768" />
'''<resources>
'''<texture name="res" file="demo_tex.png" />
'''<font name="btnfont" file="buttons_font.fnt" />
'''<font name="mnufont" file="menu_font.fnt" />
'''<buttonframe name="tbuttons" tex="res" font="btnfont" texx="0" texy="210" width="109" height="55" leftw="31" midw="10" cnormal="FF94cddb" cfocused="FFFFFFFF" />
'''</resources>
'''<splash bgcolor="FF00042c">
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />
'''</splash>
'''<main bgcolor="FF00042c">
'''<textpane bframe="tbuttons" top="55" left="255" width="555" height="615" btnalign="3"/>
'''<menus font="mnufont" bgcolor="c01c79ae" bordercolor="ff60c5ff" vindent="1" textcolor="FFFFFFFF" disabledcolor="FF818181" selectioncolor="E0003f95">
'''<invbutton tex="res" tx="341" ty="10" width="55" height="55" posx="959" posy="703"/>
'''<sysbutton tex="res" tx="342" ty="80" width="60" height="60" posx="0" posy="708"/>
'''<sysmenu posx="60" posy="720" datum="lb"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="285" width="1024" height="257" posx="0" posy="511"/>
'''</decorations>
'''</main>
'''</skin>

Как видно, первой должна идти строчка, определяющая формат XML-документа:
'''<?xml version="1.0" encoding="window-1251"?>

А все данные собственно скина размещаются в тегах внутри корневого тега skin:
'''<skin>
'''...
'''</skin>

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font>
*Названия тегов и параметров чувствительны к регистру.
*Стоит принять во внимание, что интерфейс игры без скина и с пустым скином (в котором есть только тег '''skin''', но внутри него ничего нет) будут отличаться. В первом случае будет загружен скин по умолчанию. Во втором - никакого скина загружено не будет и FireURQ сама создаст минимально возможный для игры интерфейс, используя значения по умолчанию, зашитые в программу.</div>

==Настройки экрана==

Можно задать размер окна FireURQ с помощью тега '''screen'''.

'''''Параметры:'''''
*'''width''' - ширина окна (по умолчанию 800)
*'''height''' - высота окна (по умолчанию 600)
*'''fullscreen''' - если равна 1, то FireURQ запустится сразу в полноэкранном режиме (по умолчанию 0)

'''''Пример:'''''
'''<screen width="1024" height="768" fullscreen="1" />
FireURQ установит размер окна в 1024х768 и запустится в полноэкранном режиме.

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

Учтите, что хотя размер окна можно задать хоть 628х315, но если вы установите размер, не поддерживаемый видеокартой и монитором, то FireURQ не сможет запуститься в полноэкранном режиме!

==Ресурсы==

Ресурсы - это текстуры, шрифты и заранее определённые рамки для кнопок, которые используются при оформлении скина. Каждому ресурсу присваивается имя, на которое потом ссылаются другие структуры данных, описывающие скин. Все ресурсы помещаются внутри тега '''resources'''.

===Текстуры===

Ресурс текстуры описывается тегом texture.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''file''' - файл текстуры (изображение JPEG, TGA или PNG).

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

Учтите, что многие из элементов управления (кнопки, например) должны иметь прозрачные элементы для того, чтобы смотреться хорошо. Прозрачность поддерживается только для 24-битных PNG и TGA.

===Шрифты===

Ресурс шрифта описывается тегом '''font'''.

Параметры:
*'''name''' - имя ресурса
*'''file''' - файл шрифта, подготовленного программой fonted из поставки FireURQ, или шрифт TrueType

===Рамки кнопок===

Рамка кнопок описывает оформление кнопки с текстом внутри. В настоящий момент данный ресурс используется только для оформления кнопок перехода между локациями, но не исключено, что в будущем он будет использоваться для чего-то ещё (например, кастомных кнопок внутри квеста). Ресурс рамки кнопок описывается тегом '''buttonframe'''.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''tex''' - имя ресурса текстуры, на которой нарисован глиф кнопки
*'''font''' - имя ресурса шрифта, который будет использован для подписи кнопки
*'''texx''' и '''texy''' - координаты глифа кнопки на текстуре
*'''width''' и '''height''' - ширина и высота глифа кнопки
*'''leftw''' - ширина левой "крышечки" кнопки
*'''midw''' - ширина средней части кнопки
*'''cnormal''' - цвет (в шестнадцатиричном формате) надписи в нормальном состоянии (по умолчанию - FFA0A0A0 )
*'''cdisabled''' - цвет надписи в неактивном состоянии (по умолчанию - FF606060 )
*'''cfocused''' - цвет надписи при наведении мыши/перемещении фокуса (по умолчанию - FFA0A0FF )

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

На текстуре должны быть расположены справа налево три глифа - для каждого из состояний кнопки (обычное, неактивное и сфокусированное). Разные параметры этого ресурса легче всего проиллюстрировать на картинке (это то, как определена рамка кнопок на текстуре по умолчанию, изображение увеличено):

[[Изображение:Btn schema.png]]

==Интерфейс сохранения/загрузки. ==

Описывается тегом '''saveload''' и располагается в главном элементе '''skin'''

'''''Параметры:'''''
*'''bgcolor''' - цвет фона в шестнадцатеричном формате
*'''captioncolor''' - цвет заголовка в шестнадцатеричном формате
*'''captionfont''' - шрифт заголовка

'''''Пример:'''''
'''<saveload bgcolor="C0000000" captioncolor="FFFFBB4F" captionfont="myfont">'''
'''<buttons frame="myframe" />'''
'''</saveload>'''

Если '''myframe''' не определена, то берётся системная кнопка, которая используется обычно в игре. Если '''myfont''' не определён, берётся системный шрифт. Цвета указаны те, которые берутся по умолчанию. Для кнопок, использующихся на экране сохранения/загрузки, необходимо четыре состояния: нормальное, дизабленое, выбранное и нажатое.

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

'''''Пример:'''''
'''<saveload>'''
'''...'''
'''<backbutton tex="res" tx="565" ty="106" width="50" height="50" posx="35" posy="60"/>'''
'''...'''
'''</saveload>'''

==Заставка==

Заставка (сплеш-скрин) показывается при запуске игры. Настройки заставки помещатся в теге '''splash'''. Если тег '''splash''' отсутствует в скине, то проигрывается стандартная заставка.

'''''Параметры тега''''' ''splash'':
*'''bgcolor''' - цвет фона в шеснадцатеричном формате (по умолчанию - 0)
*'''vcolor''' - цвет надписи о версии FireURQ (по умолчанию - FFEE9A00)

Внутри тега '''splash''' может помещаться тег '''logo''', с помощью которого можно заменить логотип FireURQ на изображение чего-нибудь другого.

'''''Параметры тега''''' ''logo'':
*'''tex''' - имя ресурса текстуры, на которой нарисован логотип
*'''tx''' и '''ty''' - координаты верхнего левого угла логотипа на текстуре
*'''width''' и '''height''' - ширина и высота изображения логотипа

'''''Пример:'''''
'''<splash bgcolor="FF000000" vcolor="FFEE9A00">'''
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />'''
'''</splash>'''

==Основной раздел==

Основной раздел скина, описывающий интерфейс собственно проигрывателя, располагается внутри тега '''main'''. Если в скине отсутствует тег '''main''', то создаётся интерфейс по умолчанию - чёрный фон, текстовое поле занимает почти всё окно (с небольшими отступами), кнопки меню и инвентаря отсутствуют (меню и инвентарь можно вызвать только с клавиатуры), загружаются стандартные шрифты и стандартная рамка кнопок, никаких украшений.

'''''Параметры тега''''' ''main'':
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - 0)

===Текстовое поле===

Настройки текстового поля определяются с помощью тега '''textpane''' внутри тега '''main'''.

'''''Параметры:'''''
*'''font''' - имя ресурса шрифта текстового поля (по умолчанию - как в стандартном скине)
*'''bframe''' - имя ресурса рамки (стиля) кнопок, которая будет использована для оформления кнопок действий (по умолчанию - как в стандартном скине)
*'''left''' и '''top''' - координаты левого верхнего угла текстового поля в окне FireURQ (по умолчанию - 20, 10)
*'''width''' и '''height''' - ширина и высота текстового поля (по умолчанию выбираются так, чтобы правый край отставал на 20 пикселей от края окна, а нижний край - на 10 пикселов от нижнего края окна)
*'''btnalign''' - выравнивание кнопок (1 - по левому краю, 2 - по правому, 3 - по центру)
*'''btntxtalign''' - выравнивание текста на кнопках (так же, 1 - по левому краю, 2 - по правому, 3 - по центру)

'''''Пример:'''''
'''<textpane font="georgia[24]" bframe="tbuttons" top="30" left="30" width="400" height="500" btnalign="3" btntxtalign="3"/>'''
создаст текстовое поле с шрифтом 24 размера типа georgia и определёнными вами кнопками, с координатами левого верхнего угла (30, 30),
с шириной 400 пикселов и высотой 500 пикселов, и с выравнивание текста внутри поля по центру.
Внутри кнопок текст так же будет выровнен по центру.

===Меню и инвентарь===

Параметры меню описываются внутри тега '''menus'''. И системное меню, и меню инвентаря имеют единый стиль, т.е. цвета и шрифт для них одинаковые.

'''''Параметры тега''''' ''menus'':
*'''font''' - имя ресурса шрифта меню (по умолчанию - как в стандартном скине)
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - FFFFFFFF)
*'''bordercolor''' - цвет рамки (по умолчанию - FFA0A0A0)
*'''textcolor''' - цвет текста пунктов меню (по умолчанию - FF000000)
*'''selectioncolor''' - цвет фона выделенного пункта меню (по умолчанию - FF0000A0)
*'''selectedcolor''' - цвет текста выделенного пункта меню (по умолчанию - FFFFFFFF)
*'''disabledcolor''' - цвет текста неактивного пункта меню (по умолчанию - FFC0C0C0)
*'''hindent''' - отступ в пикселях слева и справа от текста до рамки (по умолчанию - 2)
*'''vindent''' - отступ сверху и снизу от текста до следующего пункта меню в пикселях (по умолчанию - 2)

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

Лучше всего понять, к чему относятся те или иные параметры можно, взглянув на рисунок:

[[Изображение:Menu schema.png]]

'''''Пример:'''''
'''<menus font="myfont" bgcolor="FFFFFFFF" bordercolor="FFA0A0A0" textcolor="FF000000" selectioncolor="FF0000A0" selectedcolor="FFFFFFFF" disabledcolor="FFC0C0C0"'''
'''hindent="2" vindent="2">'''
'''</menus>'''

====Кнопки системного меню и инвентаря====

Внутри тега '''menus''' могут располагаться теги '''sysbutton''' и '''invbutton''', определяющие кнопки вызова системного меню и инвентаря соответственно. Если этих тегов нет в скине, то соответствующие кнопки созданы не будут и соответствующие меню можно будет вызвать только с клавиатуры.

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисованы глифы кнопки (всего их должно быть четыре - нормальная, неактивная, выделенная и нажатая)
*'''tx''' и '''ty''' - координаты верхнего левого угла первого глифа на текстуре
*'''width''' и '''height''' - ширина и высота кнопки
*'''posx''' и '''posy''' - координаты кнопки в окне FireURQ

'''''Пример:'''''
'''<invbutton tex="res" tx="300" ty="10" width="50" height="50" posx="500" posy="0"/>'''
'''<sysbutton tex="res" tx="400" ty="80" width="60" height="60" posx="0" posy="0"/>'''

====Позиция меню на экране====

Если определены кнопки для системного меню и инвентаря, то FireURQ использует специальный алгоритм, чтобы определить как и в каком месте должны раскрываться соответствующие меню. Например, если кнопка системного меню сделана в правом нижнем углу окна, то системное меню будет раскрываться над этой кнопкой с привязкой за правый нижний угол.

Если кнопки не определены, то системное меню будет открываться в левом верхнем углу окна, а инвентарь - в правом верхнем.

Однако, есть возможность жёстко задать координаты, где будет открываться то или иное меню. Так сделано, например, в стандартном скине. Это возможно с помощью тегов '''sysmenu''' и '''invmenu'''.

'''''Параметры:'''''
*'''posx''' и '''posy''' - координаты одного из углов меню в окне FireURQ
*'''datum''' - указание на то, за какой, собственно, угол меню осуществляется привязка. Возможны четыре значения - '''lt''' (по умолчанию), '''lb''', '''rt''' и '''rb'''. Левый верхний, левый нижний, правый верхний и правый нижний. Привязка влияет на то, как будет открываться меню. Например, если для меню указал параметр '''lb''', то оно будет открываться "вверх" и "вправо".

'''''Пример:'''''
'''<sysmenu posx="0" posy="0" datum="lt"/>''' Системное меню будет открываться в левом верхнем углу экрана
'''<invmenu posx="800" posy="0" datum="rt"/>''' Инвентарь будет открываться в правом верхнем углу экрана,
если ширина окна игры равна 800 пикселей (по умолчанию).

===Иконки состояний===

Иконки состояний - это мигающие изображения, появляющиеся в особые моменты игры. Все описания иконок состояний размещаются внутри тега '''icons''', который в свою очередь размещается внутри тега '''main'''. При этом существуют три типа этих иконок, описывамых в тегах '''timer''' (иконка ожидания, появляется при команде ''pause''), '''anykey''' (когда игра ждёт нажатия клавиши) и '''scroll''' (когда текст локации не помещается целиком и игра ждёт нажатия клавиши, чтобы продолжить вывод текста). Каждый из этих тегов имеет следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисована иконка
*'''tx''' и '''ty''' - координаты верхнего левого угла иконки на текстуре
*'''width''' и '''height''' - ширина и высота изображения иконки

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

Все иконки всегда появляются на экране на одном месте - в правом нижнем углу текстового поля.

'''''Пример:'''''
'''<icons>'''
'''<scroll tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<timer tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<anykey tex="res" tx="0" ty="0" width="9" height="14" />'''
'''</icons>'''
Этот код будет выводить одну и ту же иконку из ресурса '''res''' для всех состояний.

===Украшения===

Существует возможность задать в скине изображения, которые являются частью оформления скина и всегда находятся на экране. Все элементы оформления помещаются внутри тега '''decorations''' и определяются тегом '''image''', имеющим следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисовано изображение
*'''tx''' и '''ty''' - координаты верхнего левого угла изображения на текстуре
*'''width''' и '''height''' - ширина и высота изображения
*'''posx''' и '''posy''' - координаты изображения в окне FireURQ
*'''flipx''' - если равна 1, то изображение будет перевёрнуто по вертикальной оси (по умолчанию 0)
*'''flipy''' - если равна 1, то изображение будет перевёрнуто по горизонтальной оси (по умолчанию 0)

С версии 2.2 появилась возможность установить '''posz''' - слой отрисовки декоратора. По умолчанию для отрисовки используется слой чуть выше текста.

'''''Примечания:'''''
Параметры '''flipx''' и '''flipy''' удобно использовать, когда элементы оформления являются зеркальным отражением друг друга. В этом случае можно создать на текстуре одно изображение и разместить его в окне FireURQ, переворачивая по-всякому, чтобы добиться симметричного рисунка.

'''''Пример:'''''
'''<decorations>'''
'''<image tex="res" tx="0" ty="0" width="800" height="600" posx="0" posy="0"/>'''
'''</decorations>'''
Данный код выведет картинку из ресурсного файла на весь экран игры (размеры окна игры взяты по умолчанию).

'''''Примечание:'''''
Данные декораторы невозможно стереть командой '''decordel'''. Они всегда будут находиться на экране игры.
Так же с версиии 2.2 появилась возможность не указывать ширину и высоту декоратора - они будут браться автоматически.

== См. также ==
* [[FireURQ:Скинование Дат-Навирэ]]
* Собственно для чего эта документация [[FireURQ]]

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

FireURQ:Скины

2017-07-05T13:30:12Z

Ajenta: /* Украшения */

Скин игры - это такой файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста.
<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Изменение внешнего вида интерпретатора - это тема повышенной сложности. Поэтому, если вы сомневаетесь, нужны ли вам скины в вашей игре - они вам не нужны.
</div>

Кроме того, чтобы понимать, о чём будет идти речь в данном разделе, нужно хорошо представлять себе, что такое язык разметки XML.

==Общие сведения==

Файл описания скина представляет собой файл в формате XML с именем '''skin.xml''', лежащий в папке с игрой. Если ваша игра упакована в файл с расширением QSZ, то скин и все его ресурсы должны помещаться внутри архива.

Вот, для примера, как выглядит скин FireURQ по умолчанию (который загружается тогда, когда скин игры не определён):

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="800" height="600" />
'''<resources>
'''<texture name="res" file="furq_texture.png" />
'''</resources>
'''<main>
'''<textpane left="20" top="55" width="760" height="525" />
'''<menus>
'''<sysbutton tex="res" tx="0" ty="0" width="106" height="46" posx="0" posy="0"/>
'''<sysmenu posx="20" posy="42" datum="lt"/>
'''<invbutton tex="res" tx="424" ty="0" width="130" height="46" posx="671" posy="0"/>
'''<invmenu posx="780" posy="42" datum="rt"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="47" width="566" height="17" posx="105" posy="29"/>
'''</decorations>
'''</main>
'''</skin>

А это скин из демо для FireURQ 1.3:

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="1024" height="768" />
'''<resources>
'''<texture name="res" file="demo_tex.png" />
'''<font name="btnfont" file="buttons_font.fnt" />
'''<font name="mnufont" file="menu_font.fnt" />
'''<buttonframe name="tbuttons" tex="res" font="btnfont" texx="0" texy="210" width="109" height="55" leftw="31" midw="10" cnormal="FF94cddb" cfocused="FFFFFFFF" />
'''</resources>
'''<splash bgcolor="FF00042c">
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />
'''</splash>
'''<main bgcolor="FF00042c">
'''<textpane bframe="tbuttons" top="55" left="255" width="555" height="615" btnalign="3"/>
'''<menus font="mnufont" bgcolor="c01c79ae" bordercolor="ff60c5ff" vindent="1" textcolor="FFFFFFFF" disabledcolor="FF818181" selectioncolor="E0003f95">
'''<invbutton tex="res" tx="341" ty="10" width="55" height="55" posx="959" posy="703"/>
'''<sysbutton tex="res" tx="342" ty="80" width="60" height="60" posx="0" posy="708"/>
'''<sysmenu posx="60" posy="720" datum="lb"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="285" width="1024" height="257" posx="0" posy="511"/>
'''</decorations>
'''</main>
'''</skin>

Как видно, первой должна идти строчка, определяющая формат XML-документа:
'''<?xml version="1.0" encoding="window-1251"?>

А все данные собственно скина размещаются в тегах внутри корневого тега skin:
'''<skin>
'''...
'''</skin>

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font>
*Названия тегов и параметров чувствительны к регистру.
*Стоит принять во внимание, что интерфейс игры без скина и с пустым скином (в котором есть только тег '''skin''', но внутри него ничего нет) будут отличаться. В первом случае будет загружен скин по умолчанию. Во втором - никакого скина загружено не будет и FireURQ сама создаст минимально возможный для игры интерфейс, используя значения по умолчанию, зашитые в программу.</div>

==Настройки экрана==

Можно задать размер окна FireURQ с помощью тега '''screen'''.

'''''Параметры:'''''
*'''width''' - ширина окна (по умолчанию 800)
*'''height''' - высота окна (по умолчанию 600)
*'''fullscreen''' - если равна 1, то FireURQ запустится сразу в полноэкранном режиме (по умолчанию 0)

'''''Пример:'''''
'''<screen width="1024" height="768" fullscreen="1" />
FireURQ установит размер окна в 1024х768 и запустится в полноэкранном режиме.

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

Учтите, что хотя размер окна можно задать хоть 628х315, но если вы установите размер, не поддерживаемый видеокартой и монитором, то FireURQ не сможет запуститься в полноэкранном режиме!

==Ресурсы==

Ресурсы - это текстуры, шрифты и заранее определённые рамки для кнопок, которые используются при оформлении скина. Каждому ресурсу присваивается имя, на которое потом ссылаются другие структуры данных, описывающие скин. Все ресурсы помещаются внутри тега '''resources'''.

===Текстуры===

Ресурс текстуры описывается тегом texture.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''file''' - файл текстуры (изображение JPEG, TGA или PNG).

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

Учтите, что многие из элементов управления (кнопки, например) должны иметь прозрачные элементы для того, чтобы смотреться хорошо. Прозрачность поддерживается только для 24-битных PNG и TGA.

===Шрифты===

Ресурс шрифта описывается тегом '''font'''.

Параметры:
*'''name''' - имя ресурса
*'''file''' - файл шрифта, подготовленного программой fonted из поставки FireURQ, или шрифт TrueType

===Рамки кнопок===

Рамка кнопок описывает оформление кнопки с текстом внутри. В настоящий момент данный ресурс используется только для оформления кнопок перехода между локациями, но не исключено, что в будущем он будет использоваться для чего-то ещё (например, кастомных кнопок внутри квеста). Ресурс рамки кнопок описывается тегом '''buttonframe'''.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''tex''' - имя ресурса текстуры, на которой нарисован глиф кнопки
*'''font''' - имя ресурса шрифта, который будет использован для подписи кнопки
*'''texx''' и '''texy''' - координаты глифа кнопки на текстуре
*'''width''' и '''height''' - ширина и высота глифа кнопки
*'''leftw''' - ширина левой "крышечки" кнопки
*'''midw''' - ширина средней части кнопки
*'''cnormal''' - цвет (в шестнадцатиричном формате) надписи в нормальном состоянии (по умолчанию - FFA0A0A0 )
*'''cdisabled''' - цвет надписи в неактивном состоянии (по умолчанию - FF606060 )
*'''cfocused''' - цвет надписи при наведении мыши/перемещении фокуса (по умолчанию - FFA0A0FF )

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

На текстуре должны быть расположены справа налево три глифа - для каждого из состояний кнопки (обычное, неактивное и сфокусированное). Разные параметры этого ресурса легче всего проиллюстрировать на картинке (это то, как определена рамка кнопок на текстуре по умолчанию, изображение увеличено):

[[Изображение:Btn schema.png]]

==Интерфейс сохранения/загрузки. ==

Описывается тегом '''saveload''' и располагается в главном элементе '''skin'''

'''''Параметры:'''''
*'''bgcolor''' - цвет фона в шестнадцатеричном формате
*'''captioncolor''' - цвет заголовка в шестнадцатеричном формате
*'''captionfont''' - шрифт заголовка

'''''Пример:'''''
'''<saveload bgcolor="C0000000" captioncolor="FFFFBB4F" captionfont="myfont">'''
'''<buttons frame="myframe" />'''
'''</saveload>'''

Если '''myframe''' не определена, то берётся системная кнопка, которая используется обычно в игре. Если '''myfont''' не определён, берётся системный шрифт. Цвета указаны те, которые берутся по умолчанию. Для кнопок, использующихся на экране сохранения/загрузки, необходимо четыре состояния: нормальное, дизабленое, выбранное и нажатое.

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

'''''Пример:'''''
'''<saveload>'''
'''...'''
'''<backbutton tex="res" tx="565" ty="106" width="50" height="50" posx="35" posy="60"/>'''
'''...'''
'''</saveload>'''

==Заставка==

Заставка (сплеш-скрин) показывается при запуске игры. Настройки заставки помещатся в теге '''splash'''. Если тег '''splash''' отсутствует в скине, то проигрывается стандартная заставка.

'''''Параметры тега''''' ''splash'':
*'''bgcolor''' - цвет фона в шеснадцатеричном формате (по умолчанию - 0)
*'''vcolor''' - цвет надписи о версии FireURQ (по умолчанию - FFEE9A00)

Внутри тега '''splash''' может помещаться тег '''logo''', с помощью которого можно заменить логотип FireURQ на изображение чего-нибудь другого.

'''''Параметры тега''''' ''logo'':
*'''tex''' - имя ресурса текстуры, на которой нарисован логотип
*'''tx''' и '''ty''' - координаты верхнего левого угла логотипа на текстуре
*'''width''' и '''height''' - ширина и высота изображения логотипа

'''''Пример:'''''
'''<splash bgcolor="FF000000" vcolor="FFEE9A00">'''
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />'''
'''</splash>'''

==Основной раздел==

Основной раздел скина, описывающий интерфейс собственно проигрывателя, располагается внутри тега '''main'''. Если в скине отсутствует тег '''main''', то создаётся интерфейс по умолчанию - чёрный фон, текстовое поле занимает почти всё окно (с небольшими отступами), кнопки меню и инвентаря отсутствуют (меню и инвентарь можно вызвать только с клавиатуры), загружаются стандартные шрифты и стандартная рамка кнопок, никаких украшений.

'''''Параметры тега''''' ''main'':
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - 0)

===Текстовое поле===

Настройки текстового поля определяются с помощью тега '''textpane''' внутри тега '''main'''.

'''''Параметры:'''''
*'''font''' - имя ресурса шрифта текстового поля (по умолчанию - как в стандартном скине)
*'''bframe''' - имя ресурса рамки (стиля) кнопок, которая будет использована для оформления кнопок действий (по умолчанию - как в стандартном скине)
*'''left''' и '''top''' - координаты левого верхнего угла текстового поля в окне FireURQ (по умолчанию - 20, 10)
*'''width''' и '''height''' - ширина и высота текстового поля (по умолчанию выбираются так, чтобы правый край отставал на 20 пикселей от края окна, а нижний край - на 10 пикселов от нижнего края окна)
*'''btnalign''' - выравнивание кнопок (1 - по левому краю, 2 - по правому, 3 - по центру)
*'''btntxtalign''' - выравнивание текста на кнопках (так же, 1 - по левому краю, 2 - по правому, 3 - по центру)

'''''Пример:'''''
'''<textpane font="georgia[24]" bframe="tbuttons" top="30" left="30" width="400" height="500" btnalign="3" btntxtalign="3"/>'''
создаст текстовое поле с шрифтом 24 размера типа georgia и определёнными вами кнопками, с координатами левого верхнего угла (30, 30),
с шириной 400 пикселов и высотой 500 пикселов, и с выравнивание текста внутри поля по центру.
Внутри кнопок текст так же будет выровнен по центру.

===Меню и инвентарь===

Параметры меню описываются внутри тега '''menus'''. И системное меню, и меню инвентаря имеют единый стиль, т.е. цвета и шрифт для них одинаковые.

'''''Параметры тега''''' ''menus'':
*'''font''' - имя ресурса шрифта меню (по умолчанию - как в стандартном скине)
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - FFFFFFFF)
*'''bordercolor''' - цвет рамки (по умолчанию - FFA0A0A0)
*'''textcolor''' - цвет текста пунктов меню (по умолчанию - FF000000)
*'''selectioncolor''' - цвет фона выделенного пункта меню (по умолчанию - FF0000A0)
*'''selectedcolor''' - цвет текста выделенного пункта меню (по умолчанию - FFFFFFFF)
*'''disabledcolor''' - цвет текста неактивного пункта меню (по умолчанию - FFC0C0C0)
*'''hindent''' - отступ в пикселях слева и справа от текста до рамки (по умолчанию - 2)
*'''vindent''' - отступ сверху и снизу от текста до следующего пункта меню в пикселях (по умолчанию - 2)

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

Лучше всего понять, к чему относятся те или иные параметры можно, взглянув на рисунок:

[[Изображение:Menu schema.png]]

'''''Пример:'''''
'''<menus font="myfont" bgcolor="FFFFFFFF" bordercolor="FFA0A0A0" textcolor="FF000000" selectioncolor="FF0000A0" selectedcolor="FFFFFFFF" disabledcolor="FFC0C0C0"'''
'''hindent="2" vindent="2">'''
'''</menus>'''

====Кнопки системного меню и инвентаря====

Внутри тега '''menus''' могут располагаться теги '''sysbutton''' и '''invbutton''', определяющие кнопки вызова системного меню и инвентаря соответственно. Если этих тегов нет в скине, то соответствующие кнопки созданы не будут и соответствующие меню можно будет вызвать только с клавиатуры.

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисованы глифы кнопки (всего их должно быть четыре - нормальная, неактивная, выделенная и нажатая)
*'''tx''' и '''ty''' - координаты верхнего левого угла первого глифа на текстуре
*'''width''' и '''height''' - ширина и высота кнопки
*'''posx''' и '''posy''' - координаты кнопки в окне FireURQ

'''''Пример:'''''
'''<invbutton tex="res" tx="300" ty="10" width="50" height="50" posx="500" posy="0"/>'''
'''<sysbutton tex="res" tx="400" ty="80" width="60" height="60" posx="0" posy="0"/>'''

====Позиция меню на экране====

Если определены кнопки для системного меню и инвентаря, то FireURQ использует специальный алгоритм, чтобы определить как и в каком месте должны раскрываться соответствующие меню. Например, если кнопка системного меню сделана в правом нижнем углу окна, то системное меню будет раскрываться над этой кнопкой с привязкой за правый нижний угол.

Если кнопки не определены, то системное меню будет открываться в левом верхнем углу окна, а инвентарь - в правом верхнем.

Однако, есть возможность жёстко задать координаты, где будет открываться то или иное меню. Так сделано, например, в стандартном скине. Это возможно с помощью тегов '''sysmenu''' и '''invmenu'''.

'''''Параметры:'''''
*'''posx''' и '''posy''' - координаты одного из углов меню в окне FireURQ
*'''datum''' - указание на то, за какой, собственно, угол меню осуществляется привязка. Возможны четыре значения - '''lt''' (по умолчанию), '''lb''', '''rt''' и '''rb'''. Левый верхний, левый нижний, правый верхний и правый нижний. Привязка влияет на то, как будет открываться меню. Например, если для меню указал параметр '''lb''', то оно будет открываться "вверх" и "вправо".

'''''Пример:'''''
'''<sysmenu posx="0" posy="0" datum="lt"/>''' Системное меню будет открываться в левом верхнем углу экрана
'''<invmenu posx="800" posy="0" datum="rt"/>''' Инвентарь будет открываться в правом верхнем углу экрана,
если ширина окна игры равна 800 пикселей (по умолчанию).

===Иконки состояний===

Иконки состояний - это мигающие изображения, появляющиеся в особые моменты игры. Все описания иконок состояний размещаются внутри тега '''icons''', который в свою очередь размещается внутри тега '''main'''. При этом существуют три типа этих иконок, описывамых в тегах '''timer''' (иконка ожидания, появляется при команде ''pause''), '''anykey''' (когда игра ждёт нажатия клавиши) и '''scroll''' (когда текст локации не помещается целиком и игра ждёт нажатия клавиши, чтобы продолжить вывод текста). Каждый из этих тегов имеет следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисована иконка
*'''tx''' и '''ty''' - координаты верхнего левого угла иконки на текстуре
*'''width''' и '''height''' - ширина и высота изображения иконки

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

Все иконки всегда появляются на экране на одном месте - в правом нижнем углу текстового поля.

'''''Пример:'''''
'''<icons>'''
'''<scroll tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<timer tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<anykey tex="res" tx="0" ty="0" width="9" height="14" />'''
'''</icons>'''
Этот код будет выводить одну и ту же иконку из ресурса '''res''' для всех состояний.

===Украшения===

Существует возможность задать в скине изображения, которые являются частью оформления скина и всегда находятся на экране. Все элементы оформления помещаются внутри тега '''decorations''' и определяются тегом '''image''', имеющим следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисовано изображение
*'''tx''' и '''ty''' - координаты верхнего левого угла изображения на текстуре
*'''width''' и '''height''' - ширина и высота изображения
*'''posx''' и '''posy''' - координаты изображения в окне FireURQ
*'''flipx''' - если равна 1, то изображение будет перевёрнуто по вертикальной оси (по умолчанию 0)
*'''flipy''' - если равна 1, то изображение будет перевёрнуто по горизонтальной оси (по умолчанию 0)

С версии 2.2 появилась возможность установить '''posz''' - слой отрисовки декоратора. По умолчанию для отрисовки используется слой чуть выше текста.

'''''Примечания:'''''
Параметры '''flipx''' и '''flipy''' удобно использовать, когда элементы оформления являются зеркальным отражением друг друга. В этом случае можно создать на текстуре одно изображение и разместить его в окне FireURQ, переворачивая по-всякому, чтобы добиться симметричного рисунка.

'''''Пример:'''''
'''<decorations>'''
'''<image tex="res" tx="0" ty="0" width="800" height="600" posx="0" posy="0"/>'''
'''</decorations>'''
Данный код выведет картинку из ресурсного файла на весь экран игры (размеры окна игры взяты по умолчанию).

'''''Примечание:'''''
Данные декораторы невозможно стереть командой '''decordel'''. Они всегда будут находиться на экране игры.

== См. также ==
* [[FireURQ:Скинование Дат-Навирэ]]
* Собственно для чего эта документация [[FireURQ]]

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

FireURQ:Скины

2017-07-05T13:26:43Z

Ajenta: /* Украшения */

Скин игры - это такой файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста.
<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Изменение внешнего вида интерпретатора - это тема повышенной сложности. Поэтому, если вы сомневаетесь, нужны ли вам скины в вашей игре - они вам не нужны.
</div>

Кроме того, чтобы понимать, о чём будет идти речь в данном разделе, нужно хорошо представлять себе, что такое язык разметки XML.

==Общие сведения==

Файл описания скина представляет собой файл в формате XML с именем '''skin.xml''', лежащий в папке с игрой. Если ваша игра упакована в файл с расширением QSZ, то скин и все его ресурсы должны помещаться внутри архива.

Вот, для примера, как выглядит скин FireURQ по умолчанию (который загружается тогда, когда скин игры не определён):

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="800" height="600" />
'''<resources>
'''<texture name="res" file="furq_texture.png" />
'''</resources>
'''<main>
'''<textpane left="20" top="55" width="760" height="525" />
'''<menus>
'''<sysbutton tex="res" tx="0" ty="0" width="106" height="46" posx="0" posy="0"/>
'''<sysmenu posx="20" posy="42" datum="lt"/>
'''<invbutton tex="res" tx="424" ty="0" width="130" height="46" posx="671" posy="0"/>
'''<invmenu posx="780" posy="42" datum="rt"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="47" width="566" height="17" posx="105" posy="29"/>
'''</decorations>
'''</main>
'''</skin>

А это скин из демо для FireURQ 1.3:

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="1024" height="768" />
'''<resources>
'''<texture name="res" file="demo_tex.png" />
'''<font name="btnfont" file="buttons_font.fnt" />
'''<font name="mnufont" file="menu_font.fnt" />
'''<buttonframe name="tbuttons" tex="res" font="btnfont" texx="0" texy="210" width="109" height="55" leftw="31" midw="10" cnormal="FF94cddb" cfocused="FFFFFFFF" />
'''</resources>
'''<splash bgcolor="FF00042c">
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />
'''</splash>
'''<main bgcolor="FF00042c">
'''<textpane bframe="tbuttons" top="55" left="255" width="555" height="615" btnalign="3"/>
'''<menus font="mnufont" bgcolor="c01c79ae" bordercolor="ff60c5ff" vindent="1" textcolor="FFFFFFFF" disabledcolor="FF818181" selectioncolor="E0003f95">
'''<invbutton tex="res" tx="341" ty="10" width="55" height="55" posx="959" posy="703"/>
'''<sysbutton tex="res" tx="342" ty="80" width="60" height="60" posx="0" posy="708"/>
'''<sysmenu posx="60" posy="720" datum="lb"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="285" width="1024" height="257" posx="0" posy="511"/>
'''</decorations>
'''</main>
'''</skin>

Как видно, первой должна идти строчка, определяющая формат XML-документа:
'''<?xml version="1.0" encoding="window-1251"?>

А все данные собственно скина размещаются в тегах внутри корневого тега skin:
'''<skin>
'''...
'''</skin>

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font>
*Названия тегов и параметров чувствительны к регистру.
*Стоит принять во внимание, что интерфейс игры без скина и с пустым скином (в котором есть только тег '''skin''', но внутри него ничего нет) будут отличаться. В первом случае будет загружен скин по умолчанию. Во втором - никакого скина загружено не будет и FireURQ сама создаст минимально возможный для игры интерфейс, используя значения по умолчанию, зашитые в программу.</div>

==Настройки экрана==

Можно задать размер окна FireURQ с помощью тега '''screen'''.

'''''Параметры:'''''
*'''width''' - ширина окна (по умолчанию 800)
*'''height''' - высота окна (по умолчанию 600)
*'''fullscreen''' - если равна 1, то FireURQ запустится сразу в полноэкранном режиме (по умолчанию 0)

'''''Пример:'''''
'''<screen width="1024" height="768" fullscreen="1" />
FireURQ установит размер окна в 1024х768 и запустится в полноэкранном режиме.

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

Учтите, что хотя размер окна можно задать хоть 628х315, но если вы установите размер, не поддерживаемый видеокартой и монитором, то FireURQ не сможет запуститься в полноэкранном режиме!

==Ресурсы==

Ресурсы - это текстуры, шрифты и заранее определённые рамки для кнопок, которые используются при оформлении скина. Каждому ресурсу присваивается имя, на которое потом ссылаются другие структуры данных, описывающие скин. Все ресурсы помещаются внутри тега '''resources'''.

===Текстуры===

Ресурс текстуры описывается тегом texture.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''file''' - файл текстуры (изображение JPEG, TGA или PNG).

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

Учтите, что многие из элементов управления (кнопки, например) должны иметь прозрачные элементы для того, чтобы смотреться хорошо. Прозрачность поддерживается только для 24-битных PNG и TGA.

===Шрифты===

Ресурс шрифта описывается тегом '''font'''.

Параметры:
*'''name''' - имя ресурса
*'''file''' - файл шрифта, подготовленного программой fonted из поставки FireURQ, или шрифт TrueType

===Рамки кнопок===

Рамка кнопок описывает оформление кнопки с текстом внутри. В настоящий момент данный ресурс используется только для оформления кнопок перехода между локациями, но не исключено, что в будущем он будет использоваться для чего-то ещё (например, кастомных кнопок внутри квеста). Ресурс рамки кнопок описывается тегом '''buttonframe'''.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''tex''' - имя ресурса текстуры, на которой нарисован глиф кнопки
*'''font''' - имя ресурса шрифта, который будет использован для подписи кнопки
*'''texx''' и '''texy''' - координаты глифа кнопки на текстуре
*'''width''' и '''height''' - ширина и высота глифа кнопки
*'''leftw''' - ширина левой "крышечки" кнопки
*'''midw''' - ширина средней части кнопки
*'''cnormal''' - цвет (в шестнадцатиричном формате) надписи в нормальном состоянии (по умолчанию - FFA0A0A0 )
*'''cdisabled''' - цвет надписи в неактивном состоянии (по умолчанию - FF606060 )
*'''cfocused''' - цвет надписи при наведении мыши/перемещении фокуса (по умолчанию - FFA0A0FF )

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

На текстуре должны быть расположены справа налево три глифа - для каждого из состояний кнопки (обычное, неактивное и сфокусированное). Разные параметры этого ресурса легче всего проиллюстрировать на картинке (это то, как определена рамка кнопок на текстуре по умолчанию, изображение увеличено):

[[Изображение:Btn schema.png]]

==Интерфейс сохранения/загрузки. ==

Описывается тегом '''saveload''' и располагается в главном элементе '''skin'''

'''''Параметры:'''''
*'''bgcolor''' - цвет фона в шестнадцатеричном формате
*'''captioncolor''' - цвет заголовка в шестнадцатеричном формате
*'''captionfont''' - шрифт заголовка

'''''Пример:'''''
'''<saveload bgcolor="C0000000" captioncolor="FFFFBB4F" captionfont="myfont">'''
'''<buttons frame="myframe" />'''
'''</saveload>'''

Если '''myframe''' не определена, то берётся системная кнопка, которая используется обычно в игре. Если '''myfont''' не определён, берётся системный шрифт. Цвета указаны те, которые берутся по умолчанию. Для кнопок, использующихся на экране сохранения/загрузки, необходимо четыре состояния: нормальное, дизабленое, выбранное и нажатое.

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

'''''Пример:'''''
'''<saveload>'''
'''...'''
'''<backbutton tex="res" tx="565" ty="106" width="50" height="50" posx="35" posy="60"/>'''
'''...'''
'''</saveload>'''

==Заставка==

Заставка (сплеш-скрин) показывается при запуске игры. Настройки заставки помещатся в теге '''splash'''. Если тег '''splash''' отсутствует в скине, то проигрывается стандартная заставка.

'''''Параметры тега''''' ''splash'':
*'''bgcolor''' - цвет фона в шеснадцатеричном формате (по умолчанию - 0)
*'''vcolor''' - цвет надписи о версии FireURQ (по умолчанию - FFEE9A00)

Внутри тега '''splash''' может помещаться тег '''logo''', с помощью которого можно заменить логотип FireURQ на изображение чего-нибудь другого.

'''''Параметры тега''''' ''logo'':
*'''tex''' - имя ресурса текстуры, на которой нарисован логотип
*'''tx''' и '''ty''' - координаты верхнего левого угла логотипа на текстуре
*'''width''' и '''height''' - ширина и высота изображения логотипа

'''''Пример:'''''
'''<splash bgcolor="FF000000" vcolor="FFEE9A00">'''
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />'''
'''</splash>'''

==Основной раздел==

Основной раздел скина, описывающий интерфейс собственно проигрывателя, располагается внутри тега '''main'''. Если в скине отсутствует тег '''main''', то создаётся интерфейс по умолчанию - чёрный фон, текстовое поле занимает почти всё окно (с небольшими отступами), кнопки меню и инвентаря отсутствуют (меню и инвентарь можно вызвать только с клавиатуры), загружаются стандартные шрифты и стандартная рамка кнопок, никаких украшений.

'''''Параметры тега''''' ''main'':
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - 0)

===Текстовое поле===

Настройки текстового поля определяются с помощью тега '''textpane''' внутри тега '''main'''.

'''''Параметры:'''''
*'''font''' - имя ресурса шрифта текстового поля (по умолчанию - как в стандартном скине)
*'''bframe''' - имя ресурса рамки (стиля) кнопок, которая будет использована для оформления кнопок действий (по умолчанию - как в стандартном скине)
*'''left''' и '''top''' - координаты левого верхнего угла текстового поля в окне FireURQ (по умолчанию - 20, 10)
*'''width''' и '''height''' - ширина и высота текстового поля (по умолчанию выбираются так, чтобы правый край отставал на 20 пикселей от края окна, а нижний край - на 10 пикселов от нижнего края окна)
*'''btnalign''' - выравнивание кнопок (1 - по левому краю, 2 - по правому, 3 - по центру)
*'''btntxtalign''' - выравнивание текста на кнопках (так же, 1 - по левому краю, 2 - по правому, 3 - по центру)

'''''Пример:'''''
'''<textpane font="georgia[24]" bframe="tbuttons" top="30" left="30" width="400" height="500" btnalign="3" btntxtalign="3"/>'''
создаст текстовое поле с шрифтом 24 размера типа georgia и определёнными вами кнопками, с координатами левого верхнего угла (30, 30),
с шириной 400 пикселов и высотой 500 пикселов, и с выравнивание текста внутри поля по центру.
Внутри кнопок текст так же будет выровнен по центру.

===Меню и инвентарь===

Параметры меню описываются внутри тега '''menus'''. И системное меню, и меню инвентаря имеют единый стиль, т.е. цвета и шрифт для них одинаковые.

'''''Параметры тега''''' ''menus'':
*'''font''' - имя ресурса шрифта меню (по умолчанию - как в стандартном скине)
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - FFFFFFFF)
*'''bordercolor''' - цвет рамки (по умолчанию - FFA0A0A0)
*'''textcolor''' - цвет текста пунктов меню (по умолчанию - FF000000)
*'''selectioncolor''' - цвет фона выделенного пункта меню (по умолчанию - FF0000A0)
*'''selectedcolor''' - цвет текста выделенного пункта меню (по умолчанию - FFFFFFFF)
*'''disabledcolor''' - цвет текста неактивного пункта меню (по умолчанию - FFC0C0C0)
*'''hindent''' - отступ в пикселях слева и справа от текста до рамки (по умолчанию - 2)
*'''vindent''' - отступ сверху и снизу от текста до следующего пункта меню в пикселях (по умолчанию - 2)

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

Лучше всего понять, к чему относятся те или иные параметры можно, взглянув на рисунок:

[[Изображение:Menu schema.png]]

'''''Пример:'''''
'''<menus font="myfont" bgcolor="FFFFFFFF" bordercolor="FFA0A0A0" textcolor="FF000000" selectioncolor="FF0000A0" selectedcolor="FFFFFFFF" disabledcolor="FFC0C0C0"'''
'''hindent="2" vindent="2">'''
'''</menus>'''

====Кнопки системного меню и инвентаря====

Внутри тега '''menus''' могут располагаться теги '''sysbutton''' и '''invbutton''', определяющие кнопки вызова системного меню и инвентаря соответственно. Если этих тегов нет в скине, то соответствующие кнопки созданы не будут и соответствующие меню можно будет вызвать только с клавиатуры.

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисованы глифы кнопки (всего их должно быть четыре - нормальная, неактивная, выделенная и нажатая)
*'''tx''' и '''ty''' - координаты верхнего левого угла первого глифа на текстуре
*'''width''' и '''height''' - ширина и высота кнопки
*'''posx''' и '''posy''' - координаты кнопки в окне FireURQ

'''''Пример:'''''
'''<invbutton tex="res" tx="300" ty="10" width="50" height="50" posx="500" posy="0"/>'''
'''<sysbutton tex="res" tx="400" ty="80" width="60" height="60" posx="0" posy="0"/>'''

====Позиция меню на экране====

Если определены кнопки для системного меню и инвентаря, то FireURQ использует специальный алгоритм, чтобы определить как и в каком месте должны раскрываться соответствующие меню. Например, если кнопка системного меню сделана в правом нижнем углу окна, то системное меню будет раскрываться над этой кнопкой с привязкой за правый нижний угол.

Если кнопки не определены, то системное меню будет открываться в левом верхнем углу окна, а инвентарь - в правом верхнем.

Однако, есть возможность жёстко задать координаты, где будет открываться то или иное меню. Так сделано, например, в стандартном скине. Это возможно с помощью тегов '''sysmenu''' и '''invmenu'''.

'''''Параметры:'''''
*'''posx''' и '''posy''' - координаты одного из углов меню в окне FireURQ
*'''datum''' - указание на то, за какой, собственно, угол меню осуществляется привязка. Возможны четыре значения - '''lt''' (по умолчанию), '''lb''', '''rt''' и '''rb'''. Левый верхний, левый нижний, правый верхний и правый нижний. Привязка влияет на то, как будет открываться меню. Например, если для меню указал параметр '''lb''', то оно будет открываться "вверх" и "вправо".

'''''Пример:'''''
'''<sysmenu posx="0" posy="0" datum="lt"/>''' Системное меню будет открываться в левом верхнем углу экрана
'''<invmenu posx="800" posy="0" datum="rt"/>''' Инвентарь будет открываться в правом верхнем углу экрана,
если ширина окна игры равна 800 пикселей (по умолчанию).

===Иконки состояний===

Иконки состояний - это мигающие изображения, появляющиеся в особые моменты игры. Все описания иконок состояний размещаются внутри тега '''icons''', который в свою очередь размещается внутри тега '''main'''. При этом существуют три типа этих иконок, описывамых в тегах '''timer''' (иконка ожидания, появляется при команде ''pause''), '''anykey''' (когда игра ждёт нажатия клавиши) и '''scroll''' (когда текст локации не помещается целиком и игра ждёт нажатия клавиши, чтобы продолжить вывод текста). Каждый из этих тегов имеет следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисована иконка
*'''tx''' и '''ty''' - координаты верхнего левого угла иконки на текстуре
*'''width''' и '''height''' - ширина и высота изображения иконки

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

Все иконки всегда появляются на экране на одном месте - в правом нижнем углу текстового поля.

'''''Пример:'''''
'''<icons>'''
'''<scroll tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<timer tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<anykey tex="res" tx="0" ty="0" width="9" height="14" />'''
'''</icons>'''
Этот код будет выводить одну и ту же иконку из ресурса '''res''' для всех состояний.

===Украшения===

Существует возможность задать в скине изображения, которые являются частью оформления скина и всегда находятся на экране. Все элементы оформления помещаются внутри тега '''decorations''' и определяются тегом '''image''', имеющим следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисовано изображение
*'''tx''' и '''ty''' - координаты верхнего левого угла изображения на текстуре
*'''width''' и '''height''' - ширина и высота изображения
*'''posx''' и '''posy''' - координаты изображения в окне FireURQ
*'''flipx''' - если равна 1, то изображение будет перевёрнуто по вертикальной оси (по умолчанию 0)
*'''flipy''' - если равна 1, то изображение будет перевёрнуто по горизонтальной оси (по умолчанию 0)

С версии 2.2 появилась возможность установить '''posz''' - слой отрисовки декоратора.

'''''Примечания:'''''
Параметры '''flipx''' и '''flipy''' удобно использовать, когда элементы оформления являются зеркальным отражением друг друга. В этом случае можно создать на текстуре одно изображение и разместить его в окне FireURQ, переворачивая по-всякому, чтобы добиться симметричного рисунка.

'''''Пример:'''''
'''<decorations>'''
'''<image tex="res" tx="0" ty="0" width="800" height="600" posx="0" posy="0"/>'''
'''</decorations>'''
Данный код выведет картинку из ресурсного файла на весь экран игры (размеры окна игры взяты по умолчанию).

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

== См. также ==
* [[FireURQ:Скинование Дат-Навирэ]]
* Собственно для чего эта документация [[FireURQ]]

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

FireURQ:Скины

2017-07-05T13:24:51Z

Ajenta: /* Общие сведения */

Скин игры - это такой файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста.
<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Изменение внешнего вида интерпретатора - это тема повышенной сложности. Поэтому, если вы сомневаетесь, нужны ли вам скины в вашей игре - они вам не нужны.
</div>

Кроме того, чтобы понимать, о чём будет идти речь в данном разделе, нужно хорошо представлять себе, что такое язык разметки XML.

==Общие сведения==

Файл описания скина представляет собой файл в формате XML с именем '''skin.xml''', лежащий в папке с игрой. Если ваша игра упакована в файл с расширением QSZ, то скин и все его ресурсы должны помещаться внутри архива.

Вот, для примера, как выглядит скин FireURQ по умолчанию (который загружается тогда, когда скин игры не определён):

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="800" height="600" />
'''<resources>
'''<texture name="res" file="furq_texture.png" />
'''</resources>
'''<main>
'''<textpane left="20" top="55" width="760" height="525" />
'''<menus>
'''<sysbutton tex="res" tx="0" ty="0" width="106" height="46" posx="0" posy="0"/>
'''<sysmenu posx="20" posy="42" datum="lt"/>
'''<invbutton tex="res" tx="424" ty="0" width="130" height="46" posx="671" posy="0"/>
'''<invmenu posx="780" posy="42" datum="rt"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="47" width="566" height="17" posx="105" posy="29"/>
'''</decorations>
'''</main>
'''</skin>

А это скин из демо для FireURQ 1.3:

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="1024" height="768" />
'''<resources>
'''<texture name="res" file="demo_tex.png" />
'''<font name="btnfont" file="buttons_font.fnt" />
'''<font name="mnufont" file="menu_font.fnt" />
'''<buttonframe name="tbuttons" tex="res" font="btnfont" texx="0" texy="210" width="109" height="55" leftw="31" midw="10" cnormal="FF94cddb" cfocused="FFFFFFFF" />
'''</resources>
'''<splash bgcolor="FF00042c">
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />
'''</splash>
'''<main bgcolor="FF00042c">
'''<textpane bframe="tbuttons" top="55" left="255" width="555" height="615" btnalign="3"/>
'''<menus font="mnufont" bgcolor="c01c79ae" bordercolor="ff60c5ff" vindent="1" textcolor="FFFFFFFF" disabledcolor="FF818181" selectioncolor="E0003f95">
'''<invbutton tex="res" tx="341" ty="10" width="55" height="55" posx="959" posy="703"/>
'''<sysbutton tex="res" tx="342" ty="80" width="60" height="60" posx="0" posy="708"/>
'''<sysmenu posx="60" posy="720" datum="lb"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="285" width="1024" height="257" posx="0" posy="511"/>
'''</decorations>
'''</main>
'''</skin>

Как видно, первой должна идти строчка, определяющая формат XML-документа:
'''<?xml version="1.0" encoding="window-1251"?>

А все данные собственно скина размещаются в тегах внутри корневого тега skin:
'''<skin>
'''...
'''</skin>

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font>
*Названия тегов и параметров чувствительны к регистру.
*Стоит принять во внимание, что интерфейс игры без скина и с пустым скином (в котором есть только тег '''skin''', но внутри него ничего нет) будут отличаться. В первом случае будет загружен скин по умолчанию. Во втором - никакого скина загружено не будет и FireURQ сама создаст минимально возможный для игры интерфейс, используя значения по умолчанию, зашитые в программу.</div>

==Настройки экрана==

Можно задать размер окна FireURQ с помощью тега '''screen'''.

'''''Параметры:'''''
*'''width''' - ширина окна (по умолчанию 800)
*'''height''' - высота окна (по умолчанию 600)
*'''fullscreen''' - если равна 1, то FireURQ запустится сразу в полноэкранном режиме (по умолчанию 0)

'''''Пример:'''''
'''<screen width="1024" height="768" fullscreen="1" />
FireURQ установит размер окна в 1024х768 и запустится в полноэкранном режиме.

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

Учтите, что хотя размер окна можно задать хоть 628х315, но если вы установите размер, не поддерживаемый видеокартой и монитором, то FireURQ не сможет запуститься в полноэкранном режиме!

==Ресурсы==

Ресурсы - это текстуры, шрифты и заранее определённые рамки для кнопок, которые используются при оформлении скина. Каждому ресурсу присваивается имя, на которое потом ссылаются другие структуры данных, описывающие скин. Все ресурсы помещаются внутри тега '''resources'''.

===Текстуры===

Ресурс текстуры описывается тегом texture.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''file''' - файл текстуры (изображение JPEG, TGA или PNG).

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

Учтите, что многие из элементов управления (кнопки, например) должны иметь прозрачные элементы для того, чтобы смотреться хорошо. Прозрачность поддерживается только для 24-битных PNG и TGA.

===Шрифты===

Ресурс шрифта описывается тегом '''font'''.

Параметры:
*'''name''' - имя ресурса
*'''file''' - файл шрифта, подготовленного программой fonted из поставки FireURQ, или шрифт TrueType

===Рамки кнопок===

Рамка кнопок описывает оформление кнопки с текстом внутри. В настоящий момент данный ресурс используется только для оформления кнопок перехода между локациями, но не исключено, что в будущем он будет использоваться для чего-то ещё (например, кастомных кнопок внутри квеста). Ресурс рамки кнопок описывается тегом '''buttonframe'''.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''tex''' - имя ресурса текстуры, на которой нарисован глиф кнопки
*'''font''' - имя ресурса шрифта, который будет использован для подписи кнопки
*'''texx''' и '''texy''' - координаты глифа кнопки на текстуре
*'''width''' и '''height''' - ширина и высота глифа кнопки
*'''leftw''' - ширина левой "крышечки" кнопки
*'''midw''' - ширина средней части кнопки
*'''cnormal''' - цвет (в шестнадцатиричном формате) надписи в нормальном состоянии (по умолчанию - FFA0A0A0 )
*'''cdisabled''' - цвет надписи в неактивном состоянии (по умолчанию - FF606060 )
*'''cfocused''' - цвет надписи при наведении мыши/перемещении фокуса (по умолчанию - FFA0A0FF )

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

На текстуре должны быть расположены справа налево три глифа - для каждого из состояний кнопки (обычное, неактивное и сфокусированное). Разные параметры этого ресурса легче всего проиллюстрировать на картинке (это то, как определена рамка кнопок на текстуре по умолчанию, изображение увеличено):

[[Изображение:Btn schema.png]]

==Интерфейс сохранения/загрузки. ==

Описывается тегом '''saveload''' и располагается в главном элементе '''skin'''

'''''Параметры:'''''
*'''bgcolor''' - цвет фона в шестнадцатеричном формате
*'''captioncolor''' - цвет заголовка в шестнадцатеричном формате
*'''captionfont''' - шрифт заголовка

'''''Пример:'''''
'''<saveload bgcolor="C0000000" captioncolor="FFFFBB4F" captionfont="myfont">'''
'''<buttons frame="myframe" />'''
'''</saveload>'''

Если '''myframe''' не определена, то берётся системная кнопка, которая используется обычно в игре. Если '''myfont''' не определён, берётся системный шрифт. Цвета указаны те, которые берутся по умолчанию. Для кнопок, использующихся на экране сохранения/загрузки, необходимо четыре состояния: нормальное, дизабленое, выбранное и нажатое.

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

'''''Пример:'''''
'''<saveload>'''
'''...'''
'''<backbutton tex="res" tx="565" ty="106" width="50" height="50" posx="35" posy="60"/>'''
'''...'''
'''</saveload>'''

==Заставка==

Заставка (сплеш-скрин) показывается при запуске игры. Настройки заставки помещатся в теге '''splash'''. Если тег '''splash''' отсутствует в скине, то проигрывается стандартная заставка.

'''''Параметры тега''''' ''splash'':
*'''bgcolor''' - цвет фона в шеснадцатеричном формате (по умолчанию - 0)
*'''vcolor''' - цвет надписи о версии FireURQ (по умолчанию - FFEE9A00)

Внутри тега '''splash''' может помещаться тег '''logo''', с помощью которого можно заменить логотип FireURQ на изображение чего-нибудь другого.

'''''Параметры тега''''' ''logo'':
*'''tex''' - имя ресурса текстуры, на которой нарисован логотип
*'''tx''' и '''ty''' - координаты верхнего левого угла логотипа на текстуре
*'''width''' и '''height''' - ширина и высота изображения логотипа

'''''Пример:'''''
'''<splash bgcolor="FF000000" vcolor="FFEE9A00">'''
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />'''
'''</splash>'''

==Основной раздел==

Основной раздел скина, описывающий интерфейс собственно проигрывателя, располагается внутри тега '''main'''. Если в скине отсутствует тег '''main''', то создаётся интерфейс по умолчанию - чёрный фон, текстовое поле занимает почти всё окно (с небольшими отступами), кнопки меню и инвентаря отсутствуют (меню и инвентарь можно вызвать только с клавиатуры), загружаются стандартные шрифты и стандартная рамка кнопок, никаких украшений.

'''''Параметры тега''''' ''main'':
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - 0)

===Текстовое поле===

Настройки текстового поля определяются с помощью тега '''textpane''' внутри тега '''main'''.

'''''Параметры:'''''
*'''font''' - имя ресурса шрифта текстового поля (по умолчанию - как в стандартном скине)
*'''bframe''' - имя ресурса рамки (стиля) кнопок, которая будет использована для оформления кнопок действий (по умолчанию - как в стандартном скине)
*'''left''' и '''top''' - координаты левого верхнего угла текстового поля в окне FireURQ (по умолчанию - 20, 10)
*'''width''' и '''height''' - ширина и высота текстового поля (по умолчанию выбираются так, чтобы правый край отставал на 20 пикселей от края окна, а нижний край - на 10 пикселов от нижнего края окна)
*'''btnalign''' - выравнивание кнопок (1 - по левому краю, 2 - по правому, 3 - по центру)
*'''btntxtalign''' - выравнивание текста на кнопках (так же, 1 - по левому краю, 2 - по правому, 3 - по центру)

'''''Пример:'''''
'''<textpane font="georgia[24]" bframe="tbuttons" top="30" left="30" width="400" height="500" btnalign="3" btntxtalign="3"/>'''
создаст текстовое поле с шрифтом 24 размера типа georgia и определёнными вами кнопками, с координатами левого верхнего угла (30, 30),
с шириной 400 пикселов и высотой 500 пикселов, и с выравнивание текста внутри поля по центру.
Внутри кнопок текст так же будет выровнен по центру.

===Меню и инвентарь===

Параметры меню описываются внутри тега '''menus'''. И системное меню, и меню инвентаря имеют единый стиль, т.е. цвета и шрифт для них одинаковые.

'''''Параметры тега''''' ''menus'':
*'''font''' - имя ресурса шрифта меню (по умолчанию - как в стандартном скине)
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - FFFFFFFF)
*'''bordercolor''' - цвет рамки (по умолчанию - FFA0A0A0)
*'''textcolor''' - цвет текста пунктов меню (по умолчанию - FF000000)
*'''selectioncolor''' - цвет фона выделенного пункта меню (по умолчанию - FF0000A0)
*'''selectedcolor''' - цвет текста выделенного пункта меню (по умолчанию - FFFFFFFF)
*'''disabledcolor''' - цвет текста неактивного пункта меню (по умолчанию - FFC0C0C0)
*'''hindent''' - отступ в пикселях слева и справа от текста до рамки (по умолчанию - 2)
*'''vindent''' - отступ сверху и снизу от текста до следующего пункта меню в пикселях (по умолчанию - 2)

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

Лучше всего понять, к чему относятся те или иные параметры можно, взглянув на рисунок:

[[Изображение:Menu schema.png]]

'''''Пример:'''''
'''<menus font="myfont" bgcolor="FFFFFFFF" bordercolor="FFA0A0A0" textcolor="FF000000" selectioncolor="FF0000A0" selectedcolor="FFFFFFFF" disabledcolor="FFC0C0C0"'''
'''hindent="2" vindent="2">'''
'''</menus>'''

====Кнопки системного меню и инвентаря====

Внутри тега '''menus''' могут располагаться теги '''sysbutton''' и '''invbutton''', определяющие кнопки вызова системного меню и инвентаря соответственно. Если этих тегов нет в скине, то соответствующие кнопки созданы не будут и соответствующие меню можно будет вызвать только с клавиатуры.

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисованы глифы кнопки (всего их должно быть четыре - нормальная, неактивная, выделенная и нажатая)
*'''tx''' и '''ty''' - координаты верхнего левого угла первого глифа на текстуре
*'''width''' и '''height''' - ширина и высота кнопки
*'''posx''' и '''posy''' - координаты кнопки в окне FireURQ

'''''Пример:'''''
'''<invbutton tex="res" tx="300" ty="10" width="50" height="50" posx="500" posy="0"/>'''
'''<sysbutton tex="res" tx="400" ty="80" width="60" height="60" posx="0" posy="0"/>'''

====Позиция меню на экране====

Если определены кнопки для системного меню и инвентаря, то FireURQ использует специальный алгоритм, чтобы определить как и в каком месте должны раскрываться соответствующие меню. Например, если кнопка системного меню сделана в правом нижнем углу окна, то системное меню будет раскрываться над этой кнопкой с привязкой за правый нижний угол.

Если кнопки не определены, то системное меню будет открываться в левом верхнем углу окна, а инвентарь - в правом верхнем.

Однако, есть возможность жёстко задать координаты, где будет открываться то или иное меню. Так сделано, например, в стандартном скине. Это возможно с помощью тегов '''sysmenu''' и '''invmenu'''.

'''''Параметры:'''''
*'''posx''' и '''posy''' - координаты одного из углов меню в окне FireURQ
*'''datum''' - указание на то, за какой, собственно, угол меню осуществляется привязка. Возможны четыре значения - '''lt''' (по умолчанию), '''lb''', '''rt''' и '''rb'''. Левый верхний, левый нижний, правый верхний и правый нижний. Привязка влияет на то, как будет открываться меню. Например, если для меню указал параметр '''lb''', то оно будет открываться "вверх" и "вправо".

'''''Пример:'''''
'''<sysmenu posx="0" posy="0" datum="lt"/>''' Системное меню будет открываться в левом верхнем углу экрана
'''<invmenu posx="800" posy="0" datum="rt"/>''' Инвентарь будет открываться в правом верхнем углу экрана,
если ширина окна игры равна 800 пикселей (по умолчанию).

===Иконки состояний===

Иконки состояний - это мигающие изображения, появляющиеся в особые моменты игры. Все описания иконок состояний размещаются внутри тега '''icons''', который в свою очередь размещается внутри тега '''main'''. При этом существуют три типа этих иконок, описывамых в тегах '''timer''' (иконка ожидания, появляется при команде ''pause''), '''anykey''' (когда игра ждёт нажатия клавиши) и '''scroll''' (когда текст локации не помещается целиком и игра ждёт нажатия клавиши, чтобы продолжить вывод текста). Каждый из этих тегов имеет следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисована иконка
*'''tx''' и '''ty''' - координаты верхнего левого угла иконки на текстуре
*'''width''' и '''height''' - ширина и высота изображения иконки

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

Все иконки всегда появляются на экране на одном месте - в правом нижнем углу текстового поля.

'''''Пример:'''''
'''<icons>'''
'''<scroll tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<timer tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<anykey tex="res" tx="0" ty="0" width="9" height="14" />'''
'''</icons>'''
Этот код будет выводить одну и ту же иконку из ресурса '''res''' для всех состояний.

===Украшения===

Существует возможность задать в скине изображения, которые являются частью оформления скина и всегда находятся на экране. Все элементы оформления помещаются внутри тега '''decorations''' и определяются тегом '''image''', имеющим следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисовано изображение
*'''tx''' и '''ty''' - координаты верхнего левого угла изображения на текстуре
*'''width''' и '''height''' - ширина и высота изображения
*'''posx''' и '''posy''' - координаты изображения в окне FireURQ
*'''flipx''' - если равна 1, то изображение будет перевёрнуто по вертикальной оси (по умолчанию 0)
*'''flipy''' - если равна 1, то изображение будет перевёрнуто по горизонтальной оси (по умолчанию 0)

'''''Примечания:'''''
Параметры '''flipx''' и '''flipy''' удобно использовать, когда элементы оформления являются зеркальным отражением друг друга. В этом случае можно создать на текстуре одно изображение и разместить его в окне FireURQ, переворачивая по-всякому, чтобы добиться симметричного рисунка.

'''''Пример:'''''
'''<decorations>'''
'''<image tex="res" tx="0" ty="0" width="800" height="600" posx="0" posy="0"/>'''
'''</decorations>'''
Данный код выведет картинку из ресурсного файла на весь экран игры (размеры окна игры взяты по умолчанию).

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

== См. также ==
* [[FireURQ:Скинование Дат-Навирэ]]
* Собственно для чего эта документация [[FireURQ]]

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

FireURQ:Скины

2017-07-05T13:24:10Z

Ajenta: /* Общие сведения */

Скин игры - это такой файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста.
<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Изменение внешнего вида интерпретатора - это тема повышенной сложности. Поэтому, если вы сомневаетесь, нужны ли вам скины в вашей игре - они вам не нужны.
</div>

Кроме того, чтобы понимать, о чём будет идти речь в данном разделе, нужно хорошо представлять себе, что такое язык разметки XML.

==Общие сведения==

Файл описания скина представляет собой файл в формате XML с именем '''skin.xml''', лежащий в папке с игрой. Если ваша игра упакована в файл с расширением QSZ, то скин и все его ресурсы должны помещаться внутри архива.

Вот, для примера, как выглядит скин FireURQ по умолчанию (который загружается тогда, когда скин игры не определён):

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="800" height="600" />
'''<resources>
'''<texture name="res" file="furq_texture.png" />
'''</resources>
'''<main>
'''<textpane left="20" top="55" width="760" height="525" />
'''<menus>
'''<sysbutton tex="res" tx="0" ty="0" width="106" height="46" posx="0" posy="0"/>
'''<sysmenu posx="20" posy="42" datum="lt"/>
'''<invbutton tex="res" tx="424" ty="0" width="130" height="46" posx="671" posy="0"/>
'''<invmenu posx="780" posy="42" datum="rt"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="47" width="566" height="17" posx="105" posy="29"/>
'''</decorations>
'''</main>
'''</skin>

А это скин из демо для FireURQ 1.3:

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="1024" height="768" />
'''<resources>
'''<texture name="res" file="demo_tex.png" />
'''<font name="btnfont" file="buttons_font.fnt" />
'''<font name="mnufont" file="menu_font.fnt" />
'''<buttonframe name="tbuttons" tex="res" font="btnfont" texx="0" texy="210" width="109" height="55" leftw="31" midw="10" cnormal="FF94cddb" cfocused="FFFFFFFF" />
'''</resources>
'''<splash bgcolor="FF00042c">
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />
'''</splash>
'''<main bgcolor="FF00042c">
'''<textpane bframe="tbuttons" top="55" left="255" width="555" height="615" btnalign="3"/>
'''<menus font="mnufont" bgcolor="c01c79ae" bordercolor="ff60c5ff" vindent="1" textcolor="FFFFFFFF" disabledcolor="FF818181" selectioncolor="E0003f95">
'''<invbutton tex="res" tx="341" ty="10" width="55" height="55" posx="959" posy="703"/>
'''<sysbutton tex="res" tx="342" ty="80" width="60" height="60" posx="0" posy="708"/>
'''<sysmenu posx="60" posy="720" datum="lb"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="285" width="1024" height="257" posx="0" posy="511" posz="-10"/>
'''</decorations>
'''</main>
'''</skin>

Как видно, первой должна идти строчка, определяющая формат XML-документа:
'''<?xml version="1.0" encoding="window-1251"?>

А все данные собственно скина размещаются в тегах внутри корневого тега skin:
'''<skin>
'''...
'''</skin>

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font>
*Названия тегов и параметров чувствительны к регистру.
*Стоит принять во внимание, что интерфейс игры без скина и с пустым скином (в котором есть только тег '''skin''', но внутри него ничего нет) будут отличаться. В первом случае будет загружен скин по умолчанию. Во втором - никакого скина загружено не будет и FireURQ сама создаст минимально возможный для игры интерфейс, используя значения по умолчанию, зашитые в программу.</div>

==Настройки экрана==

Можно задать размер окна FireURQ с помощью тега '''screen'''.

'''''Параметры:'''''
*'''width''' - ширина окна (по умолчанию 800)
*'''height''' - высота окна (по умолчанию 600)
*'''fullscreen''' - если равна 1, то FireURQ запустится сразу в полноэкранном режиме (по умолчанию 0)

'''''Пример:'''''
'''<screen width="1024" height="768" fullscreen="1" />
FireURQ установит размер окна в 1024х768 и запустится в полноэкранном режиме.

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

Учтите, что хотя размер окна можно задать хоть 628х315, но если вы установите размер, не поддерживаемый видеокартой и монитором, то FireURQ не сможет запуститься в полноэкранном режиме!

==Ресурсы==

Ресурсы - это текстуры, шрифты и заранее определённые рамки для кнопок, которые используются при оформлении скина. Каждому ресурсу присваивается имя, на которое потом ссылаются другие структуры данных, описывающие скин. Все ресурсы помещаются внутри тега '''resources'''.

===Текстуры===

Ресурс текстуры описывается тегом texture.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''file''' - файл текстуры (изображение JPEG, TGA или PNG).

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

Учтите, что многие из элементов управления (кнопки, например) должны иметь прозрачные элементы для того, чтобы смотреться хорошо. Прозрачность поддерживается только для 24-битных PNG и TGA.

===Шрифты===

Ресурс шрифта описывается тегом '''font'''.

Параметры:
*'''name''' - имя ресурса
*'''file''' - файл шрифта, подготовленного программой fonted из поставки FireURQ, или шрифт TrueType

===Рамки кнопок===

Рамка кнопок описывает оформление кнопки с текстом внутри. В настоящий момент данный ресурс используется только для оформления кнопок перехода между локациями, но не исключено, что в будущем он будет использоваться для чего-то ещё (например, кастомных кнопок внутри квеста). Ресурс рамки кнопок описывается тегом '''buttonframe'''.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''tex''' - имя ресурса текстуры, на которой нарисован глиф кнопки
*'''font''' - имя ресурса шрифта, который будет использован для подписи кнопки
*'''texx''' и '''texy''' - координаты глифа кнопки на текстуре
*'''width''' и '''height''' - ширина и высота глифа кнопки
*'''leftw''' - ширина левой "крышечки" кнопки
*'''midw''' - ширина средней части кнопки
*'''cnormal''' - цвет (в шестнадцатиричном формате) надписи в нормальном состоянии (по умолчанию - FFA0A0A0 )
*'''cdisabled''' - цвет надписи в неактивном состоянии (по умолчанию - FF606060 )
*'''cfocused''' - цвет надписи при наведении мыши/перемещении фокуса (по умолчанию - FFA0A0FF )

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

На текстуре должны быть расположены справа налево три глифа - для каждого из состояний кнопки (обычное, неактивное и сфокусированное). Разные параметры этого ресурса легче всего проиллюстрировать на картинке (это то, как определена рамка кнопок на текстуре по умолчанию, изображение увеличено):

[[Изображение:Btn schema.png]]

==Интерфейс сохранения/загрузки. ==

Описывается тегом '''saveload''' и располагается в главном элементе '''skin'''

'''''Параметры:'''''
*'''bgcolor''' - цвет фона в шестнадцатеричном формате
*'''captioncolor''' - цвет заголовка в шестнадцатеричном формате
*'''captionfont''' - шрифт заголовка

'''''Пример:'''''
'''<saveload bgcolor="C0000000" captioncolor="FFFFBB4F" captionfont="myfont">'''
'''<buttons frame="myframe" />'''
'''</saveload>'''

Если '''myframe''' не определена, то берётся системная кнопка, которая используется обычно в игре. Если '''myfont''' не определён, берётся системный шрифт. Цвета указаны те, которые берутся по умолчанию. Для кнопок, использующихся на экране сохранения/загрузки, необходимо четыре состояния: нормальное, дизабленое, выбранное и нажатое.

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

'''''Пример:'''''
'''<saveload>'''
'''...'''
'''<backbutton tex="res" tx="565" ty="106" width="50" height="50" posx="35" posy="60"/>'''
'''...'''
'''</saveload>'''

==Заставка==

Заставка (сплеш-скрин) показывается при запуске игры. Настройки заставки помещатся в теге '''splash'''. Если тег '''splash''' отсутствует в скине, то проигрывается стандартная заставка.

'''''Параметры тега''''' ''splash'':
*'''bgcolor''' - цвет фона в шеснадцатеричном формате (по умолчанию - 0)
*'''vcolor''' - цвет надписи о версии FireURQ (по умолчанию - FFEE9A00)

Внутри тега '''splash''' может помещаться тег '''logo''', с помощью которого можно заменить логотип FireURQ на изображение чего-нибудь другого.

'''''Параметры тега''''' ''logo'':
*'''tex''' - имя ресурса текстуры, на которой нарисован логотип
*'''tx''' и '''ty''' - координаты верхнего левого угла логотипа на текстуре
*'''width''' и '''height''' - ширина и высота изображения логотипа

'''''Пример:'''''
'''<splash bgcolor="FF000000" vcolor="FFEE9A00">'''
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />'''
'''</splash>'''

==Основной раздел==

Основной раздел скина, описывающий интерфейс собственно проигрывателя, располагается внутри тега '''main'''. Если в скине отсутствует тег '''main''', то создаётся интерфейс по умолчанию - чёрный фон, текстовое поле занимает почти всё окно (с небольшими отступами), кнопки меню и инвентаря отсутствуют (меню и инвентарь можно вызвать только с клавиатуры), загружаются стандартные шрифты и стандартная рамка кнопок, никаких украшений.

'''''Параметры тега''''' ''main'':
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - 0)

===Текстовое поле===

Настройки текстового поля определяются с помощью тега '''textpane''' внутри тега '''main'''.

'''''Параметры:'''''
*'''font''' - имя ресурса шрифта текстового поля (по умолчанию - как в стандартном скине)
*'''bframe''' - имя ресурса рамки (стиля) кнопок, которая будет использована для оформления кнопок действий (по умолчанию - как в стандартном скине)
*'''left''' и '''top''' - координаты левого верхнего угла текстового поля в окне FireURQ (по умолчанию - 20, 10)
*'''width''' и '''height''' - ширина и высота текстового поля (по умолчанию выбираются так, чтобы правый край отставал на 20 пикселей от края окна, а нижний край - на 10 пикселов от нижнего края окна)
*'''btnalign''' - выравнивание кнопок (1 - по левому краю, 2 - по правому, 3 - по центру)
*'''btntxtalign''' - выравнивание текста на кнопках (так же, 1 - по левому краю, 2 - по правому, 3 - по центру)

'''''Пример:'''''
'''<textpane font="georgia[24]" bframe="tbuttons" top="30" left="30" width="400" height="500" btnalign="3" btntxtalign="3"/>'''
создаст текстовое поле с шрифтом 24 размера типа georgia и определёнными вами кнопками, с координатами левого верхнего угла (30, 30),
с шириной 400 пикселов и высотой 500 пикселов, и с выравнивание текста внутри поля по центру.
Внутри кнопок текст так же будет выровнен по центру.

===Меню и инвентарь===

Параметры меню описываются внутри тега '''menus'''. И системное меню, и меню инвентаря имеют единый стиль, т.е. цвета и шрифт для них одинаковые.

'''''Параметры тега''''' ''menus'':
*'''font''' - имя ресурса шрифта меню (по умолчанию - как в стандартном скине)
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - FFFFFFFF)
*'''bordercolor''' - цвет рамки (по умолчанию - FFA0A0A0)
*'''textcolor''' - цвет текста пунктов меню (по умолчанию - FF000000)
*'''selectioncolor''' - цвет фона выделенного пункта меню (по умолчанию - FF0000A0)
*'''selectedcolor''' - цвет текста выделенного пункта меню (по умолчанию - FFFFFFFF)
*'''disabledcolor''' - цвет текста неактивного пункта меню (по умолчанию - FFC0C0C0)
*'''hindent''' - отступ в пикселях слева и справа от текста до рамки (по умолчанию - 2)
*'''vindent''' - отступ сверху и снизу от текста до следующего пункта меню в пикселях (по умолчанию - 2)

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

Лучше всего понять, к чему относятся те или иные параметры можно, взглянув на рисунок:

[[Изображение:Menu schema.png]]

'''''Пример:'''''
'''<menus font="myfont" bgcolor="FFFFFFFF" bordercolor="FFA0A0A0" textcolor="FF000000" selectioncolor="FF0000A0" selectedcolor="FFFFFFFF" disabledcolor="FFC0C0C0"'''
'''hindent="2" vindent="2">'''
'''</menus>'''

====Кнопки системного меню и инвентаря====

Внутри тега '''menus''' могут располагаться теги '''sysbutton''' и '''invbutton''', определяющие кнопки вызова системного меню и инвентаря соответственно. Если этих тегов нет в скине, то соответствующие кнопки созданы не будут и соответствующие меню можно будет вызвать только с клавиатуры.

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисованы глифы кнопки (всего их должно быть четыре - нормальная, неактивная, выделенная и нажатая)
*'''tx''' и '''ty''' - координаты верхнего левого угла первого глифа на текстуре
*'''width''' и '''height''' - ширина и высота кнопки
*'''posx''' и '''posy''' - координаты кнопки в окне FireURQ

'''''Пример:'''''
'''<invbutton tex="res" tx="300" ty="10" width="50" height="50" posx="500" posy="0"/>'''
'''<sysbutton tex="res" tx="400" ty="80" width="60" height="60" posx="0" posy="0"/>'''

====Позиция меню на экране====

Если определены кнопки для системного меню и инвентаря, то FireURQ использует специальный алгоритм, чтобы определить как и в каком месте должны раскрываться соответствующие меню. Например, если кнопка системного меню сделана в правом нижнем углу окна, то системное меню будет раскрываться над этой кнопкой с привязкой за правый нижний угол.

Если кнопки не определены, то системное меню будет открываться в левом верхнем углу окна, а инвентарь - в правом верхнем.

Однако, есть возможность жёстко задать координаты, где будет открываться то или иное меню. Так сделано, например, в стандартном скине. Это возможно с помощью тегов '''sysmenu''' и '''invmenu'''.

'''''Параметры:'''''
*'''posx''' и '''posy''' - координаты одного из углов меню в окне FireURQ
*'''datum''' - указание на то, за какой, собственно, угол меню осуществляется привязка. Возможны четыре значения - '''lt''' (по умолчанию), '''lb''', '''rt''' и '''rb'''. Левый верхний, левый нижний, правый верхний и правый нижний. Привязка влияет на то, как будет открываться меню. Например, если для меню указал параметр '''lb''', то оно будет открываться "вверх" и "вправо".

'''''Пример:'''''
'''<sysmenu posx="0" posy="0" datum="lt"/>''' Системное меню будет открываться в левом верхнем углу экрана
'''<invmenu posx="800" posy="0" datum="rt"/>''' Инвентарь будет открываться в правом верхнем углу экрана,
если ширина окна игры равна 800 пикселей (по умолчанию).

===Иконки состояний===

Иконки состояний - это мигающие изображения, появляющиеся в особые моменты игры. Все описания иконок состояний размещаются внутри тега '''icons''', который в свою очередь размещается внутри тега '''main'''. При этом существуют три типа этих иконок, описывамых в тегах '''timer''' (иконка ожидания, появляется при команде ''pause''), '''anykey''' (когда игра ждёт нажатия клавиши) и '''scroll''' (когда текст локации не помещается целиком и игра ждёт нажатия клавиши, чтобы продолжить вывод текста). Каждый из этих тегов имеет следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисована иконка
*'''tx''' и '''ty''' - координаты верхнего левого угла иконки на текстуре
*'''width''' и '''height''' - ширина и высота изображения иконки

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

Все иконки всегда появляются на экране на одном месте - в правом нижнем углу текстового поля.

'''''Пример:'''''
'''<icons>'''
'''<scroll tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<timer tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<anykey tex="res" tx="0" ty="0" width="9" height="14" />'''
'''</icons>'''
Этот код будет выводить одну и ту же иконку из ресурса '''res''' для всех состояний.

===Украшения===

Существует возможность задать в скине изображения, которые являются частью оформления скина и всегда находятся на экране. Все элементы оформления помещаются внутри тега '''decorations''' и определяются тегом '''image''', имеющим следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисовано изображение
*'''tx''' и '''ty''' - координаты верхнего левого угла изображения на текстуре
*'''width''' и '''height''' - ширина и высота изображения
*'''posx''' и '''posy''' - координаты изображения в окне FireURQ
*'''flipx''' - если равна 1, то изображение будет перевёрнуто по вертикальной оси (по умолчанию 0)
*'''flipy''' - если равна 1, то изображение будет перевёрнуто по горизонтальной оси (по умолчанию 0)

'''''Примечания:'''''
Параметры '''flipx''' и '''flipy''' удобно использовать, когда элементы оформления являются зеркальным отражением друг друга. В этом случае можно создать на текстуре одно изображение и разместить его в окне FireURQ, переворачивая по-всякому, чтобы добиться симметричного рисунка.

'''''Пример:'''''
'''<decorations>'''
'''<image tex="res" tx="0" ty="0" width="800" height="600" posx="0" posy="0"/>'''
'''</decorations>'''
Данный код выведет картинку из ресурсного файла на весь экран игры (размеры окна игры взяты по умолчанию).

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

== См. также ==
* [[FireURQ:Скинование Дат-Навирэ]]
* Собственно для чего эта документация [[FireURQ]]

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

FireURQ:Особенности реализации URQL

2017-07-05T13:22:08Z

Ajenta: /* Переменные декораторов */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1. Для декоратора типа TEXTBUTTON данная переменная выровняет название кнопки согласно установленному значению.
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль. Для декоратора типа TEXTBUTTON данная переменная установит ширину кнопки независимо от ширины текста в ней (по умолчанию ширина кнопки равна ширине текста).
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительного команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, существует возможность конвертации квеста в формате QSZ в исполняемый файл. Для этого следует использовать утилиту '''QSZ2EXE''', которая входит в комплект поставки. Эта консольная утилита находится в папке на диске, которую вы выбрали при инсталляции '''FireURQ'''.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная '''save_success''' устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

Так же с версии 2.2 в FireURQ появилась возможность менять базовое имя файла сейва.
Переменная '''savebasename''' хранит это имя. По умолчанию переменная содержит название файла игры.
Если значение поменять на '''«profile1»''', то файлы сохранений будут называться '''profile1.s01''', '''profile1.s02''' и т.д.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.

C версии '''FireURQ 2.2''' появилась возможность загружать сохранения непосредственно из слотов, не вызывая меню "Загрузить сохранение".

Если написать '''LOAD 1''', то будет загружено сохранение из первого слота. '''LOAD 0''' загрузит игру из слота автосохранения.

==Перманентное хранилище данных==

Начиная с версии 2.2 FireURQ обзавелась перманентным хранилищем данных.
Это переменные, которые не удаляются при '''perkill''' или перезапуске игры, автоматически подгружаются и, при их изменении, так же автоматически сохраняются в специальном файле.

Любая переменная, начинающаяся на '''gss_''' будет считаться перманентной.

Это позволит хранить глобальные настройки, которые не должны изменяться при перезапуске игры, а так же делать достижения и даже переносить параметры из игры в игру.

Команда '''gsskill''' полностью очищает хранилище.

== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логии прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

FireURQ:Особенности реализации URQL

2017-07-05T13:18:02Z

Ajenta: /* Сохранение игры и оператор SAVE */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль.
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительного команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, существует возможность конвертации квеста в формате QSZ в исполняемый файл. Для этого следует использовать утилиту '''QSZ2EXE''', которая входит в комплект поставки. Эта консольная утилита находится в папке на диске, которую вы выбрали при инсталляции '''FireURQ'''.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная '''save_success''' устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

Так же с версии 2.2 в FireURQ появилась возможность менять базовое имя файла сейва.
Переменная '''savebasename''' хранит это имя. По умолчанию переменная содержит название файла игры.
Если значение поменять на '''«profile1»''', то файлы сохранений будут называться '''profile1.s01''', '''profile1.s02''' и т.д.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.

C версии '''FireURQ 2.2''' появилась возможность загружать сохранения непосредственно из слотов, не вызывая меню "Загрузить сохранение".

Если написать '''LOAD 1''', то будет загружено сохранение из первого слота. '''LOAD 0''' загрузит игру из слота автосохранения.

==Перманентное хранилище данных==

Начиная с версии 2.2 FireURQ обзавелась перманентным хранилищем данных.
Это переменные, которые не удаляются при '''perkill''' или перезапуске игры, автоматически подгружаются и, при их изменении, так же автоматически сохраняются в специальном файле.

Любая переменная, начинающаяся на '''gss_''' будет считаться перманентной.

Это позволит хранить глобальные настройки, которые не должны изменяться при перезапуске игры, а так же делать достижения и даже переносить параметры из игры в игру.

Команда '''gsskill''' полностью очищает хранилище.

== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логии прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

FireURQ:Особенности реализации URQL

2017-07-05T13:14:06Z

Ajenta: /* Перманентное хранилище данных */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль.
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительного команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, существует возможность конвертации квеста в формате QSZ в исполняемый файл. Для этого следует использовать утилиту '''QSZ2EXE''', которая входит в комплект поставки. Эта консольная утилита находится в папке на диске, которую вы выбрали при инсталляции '''FireURQ'''.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная '''save_success''' устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.

C версии '''FireURQ 2.2''' появилась возможность загружать сохранения непосредственно из слотов, не вызывая меню "Загрузить сохранение".

Если написать '''LOAD 1''', то будет загружено сохранение из первого слота. '''LOAD 0''' загрузит игру из слота автосохранения.

==Перманентное хранилище данных==

Начиная с версии 2.2 FireURQ обзавелась перманентным хранилищем данных.
Это переменные, которые не удаляются при '''perkill''' или перезапуске игры, автоматически подгружаются и, при их изменении, так же автоматически сохраняются в специальном файле.

Любая переменная, начинающаяся на '''gss_''' будет считаться перманентной.

Это позволит хранить глобальные настройки, которые не должны изменяться при перезапуске игры, а так же делать достижения и даже переносить параметры из игры в игру.

Команда '''gsskill''' полностью очищает хранилище.

== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логии прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

FireURQ:Особенности реализации URQL

2017-07-05T13:13:05Z

Ajenta:

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль.
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительного команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, существует возможность конвертации квеста в формате QSZ в исполняемый файл. Для этого следует использовать утилиту '''QSZ2EXE''', которая входит в комплект поставки. Эта консольная утилита находится в папке на диске, которую вы выбрали при инсталляции '''FireURQ'''.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная '''save_success''' устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.

C версии '''FireURQ 2.2''' появилась возможность загружать сохранения непосредственно из слотов, не вызывая меню "Загрузить сохранение".

Если написать '''LOAD 1''', то будет загружено сохранение из первого слота. '''LOAD 0''' загрузит игру из слота автосохранения.

==Перманентное хранилище данных==

Начиная с версии 2.2 FireURQ обзавелась перманентным хранилищем данных.
Это переменные, которые не удаляются при '''perkill''' или перезапуске игры, автоматически подгружаются и, при их изменении, так же автоматически сохраняются в специальном файле.

Любая переменная, начинающаяся на '''gss_''' будет считаться перманентной.

Это позволит хранить глобальные настройки, которые не должны изменяться при перезапуске игры, а так же делать достижения и даже переносить параметры из игры в игру.

Команда '''gsskill''' полностью очистит хранилище.

== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логии прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

FireURQ:Руководство пользователя

2017-07-05T12:58:29Z

Ajenta: /* Команда forget_procs */

=Метки=

Метка - одно из важнейших понятий URQL. Она служит для выделения места в квесте, куда затем предстоит перейти. Любые перемещения в квесте могут быть либо на следующий оператор, либо на метку. Все метки имеют имена, чтобы потом можно было указывать, куда вы хотите перейти.
Определяется метка при помощи двоеточия. Все, что правее этого символа, до разделителя, которым является символ конец абзаца (Enter) или '&' - имя метки:

''':Имя_метки'''

Метка и следующий за ней оператор end являются принятой единицей измерения игры - локацией. Между ними обычно пишется описание локации и переходы из неё в другие локации.

''':начало'''
'''end'''

Например, допустимыми именами меток являются:

''':1'''
''':01'''
''':а'''
''':кот1'''
''':@(a)%^Очень_Длинная_и_Запутанная_метка_какими-лучше-не-пользоваться!!!!!_horror_так_как_сами_потом_забудете_как_она_называется!Или_сделаете_ошибку!'''
'''Вы_же_можете_сделать_маленькую_ошибку_в таком_длинном_названии?'''
''':house_flat1'''

'''''Примечание:''''' метка должна начинаться с начала строки и отделяться от других операторов (Enter) или '&', регистр имени метки не важен.

:BIG
:bIG
:Big
:big
- все эти метки для интерпретатора совершенно одинаковы. Но лучше, в целях собственного удобства, придерживаться единого стиля.

В метке лучше не делать пробелов. Длина метки не ограничена, но для удобства автора квеста лучше не делать меток длиннее строки. В метке допускаются символы, обозначающие буквы русского и латинского алфавита, цифры, знак подчеркивания и знаки арифметических операций + и - (лучше не злоупотреблять странными названиями).

Недопустимы символы ''';''' '''/*''' '''*/''' '''&'''

Грамотное использование имен меток способно серьезно облегчить работу автора.

=Текст=
==Вывод текста==

Поскольку мы имеем дело с текстовыми играми, важнейшим для нас является вывод текста. В FURQ существует несколько способов вывода текста.

===Текст на экране===

Простейший способ вывести текст это использовать команды '''P''' и '''PLN'''. Советую освоить их, прежде чем переходить к другим способам вывода.

Формат команд:
'''p''' [текст]
'''pln''' [текст]

Регистр команд не имеет значения ('''pLn''' = '''PLN''' = '''Pln''').

На практике это выглядит так:
'''p''' Этот текст появится на экране.
или
'''pln''' Этот текст тоже появится на экране.

Каждая последующая команда '''P''' или '''PLN''' дописывает новый текст к тексту который уже есть на экране. Когда текста становится слишком много, появляется возможность его прокрутить.

Разница этих двух команд в следующем - '''P''' просто добавляет новый текст, а '''PLN''' добавляет текст и делает переход на новую строку (создает абзац).

Например:
'''p''' А
'''p''' Б

Выдаст “АБ”, тогда как

'''pln''' А
'''pln''' Б

Выдаст:
А
Б

Чаще всего пользуются командой '''pln''', однако и '''p''' может быть полезна, например, когда строчка текста, которую мы хотим вывести на экран, состоит из нескольких частей и зависит от каких-либо переменных или условий.

Команды '''P''' и '''PLN''' могут напрямую выводить любые символы (кроме символа комментария '''“;”'''), переменные и ссылки.

===Вывод переменных===

Вывод переменных возможен в двух вариантах - числовом и текстовом. Для того чтобы их вывести, нужно заключить имена переменных в соответствующие скобки:
'''pln''' '''#%'''имя_текстовой_переменной'''$''' '''#'''имя_числовой_переменной'''$'''
Несмотря на внешнее сходство, они отличаются содержанием и символом '''%'''. Если в числовые скобки попадет текстовая переменная, то на выводе окажется не текст, а количество символов в этой переменной. И наоборот, если числовая переменная попадет в текстовые скобки, то на выводе окажется пустота.

Выведем оба типа переменных на экран:

'''текстовая_переменная="Геннадий"'''
'''числовая_переменная=42'''
'''pln''' Крокодил схватил вас за ногу и сказал:
'''pln''' - Меня зовут '''#%текстовая_переменная$'''.
'''pln''' Затем крокодил схватил вас за другую ногу и сказал:
'''pln''' - Мне '''#числовая_переменная$''' года. Давай, ты станешь моим близким другом.

Результат:
Крокодил схватил вас за ногу и сказал:
- Меня зовут Геннадий.
Затем крокодил схватил вас за другую ногу и сказал:
- Мне 42 года. Давай, ты станешь моим близким другом.

Кроме того, в '''URQL''' есть специальные обозначения для вывода символа пробела - '''#$''', вывода символа переноса строки - '''#/$''' и вывода символа по ascii-коду - '''##'''ascii-код'''$'''.

Так, например, символ комментария можно вывести на экран, через его ascii-код:
'''pln''' Моя грамотность была на исходе'''##59$''' но, несмотря на это, я поставил точку с запятой в предложении.

Результат:
Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.

Хочу напомнить, что если бы мы написали в коде просто:
'''pln''' Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.
То получили бы на экране:
Моя грамотность была на исходе
Потому что символ ";" и все что после него идет было бы обработано как комментарий.

'''Примечание:'''
Вывод строковой переменной, как числа '''#текстовая_переменная$''' даст нам количество символов в строке.

==Оформление текста==

В 21 веке в '''FURQ''' текст это не просто набор символов, но еще и набор гарнитур, цвет, выравнивание и местоположение.

===Местоположение===
Область экрана, куда выводят текст команды '''p''' и '''pln''' можно двигать, делать шире, уже, выше и т.д. Для этого служат системные переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height''', которые описывают некий прямоугольник куда и выводится текст. По умолчанию он занимает почти весь экран. Это числовые переменные, которые содержат значения в пикселях.

Давайте, используя полученные нами знания, выведем значения этих переменных на экран:
'''pln''' Левая граница='''#textpane_left$''', Верхняя граница='''#textpane_top$''', Ширина='''#textpane_width$''', Высота='''#textpane_height$'''

Результат:
Левая граница=20, Верхняя граница=55, Ширина=760, Высота=525

Вы можете изменять значения этих переменных как угодно в любом месте игры. Например, вы хотите вывести справа от текста картинку: измените ширину ('''textpane_width''') так чтобы текст не мешал. А когда картинка больше не нужна измените ширину обратно. Экспериментируйте.

===Выравнивание текста===

За выравнивание текста отвечает команда числовая системная переменная textalign. Она сообщает FURQ как должен быть расположен текст относительно области его вывода.

Лучше всего это понять на примере:
'''textalign = 1'''
'''pln''' текст выравнивается влево
'''textalign = 2'''
'''pln''' текст выравнивается вправо
'''textalign = 3'''
'''pln''' текст выравнивается по центру

''; Главное теперь не забыть, поменять переменную обратно на '''1''', если вы не хотите, чтобы текст всей игры был выравнен по центру.''

===Цвет===

Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате '''0xAARRGGBB'''. То есть четыре составляющих: альфа, красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.

Встроенная функция '''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255''' (т.е. полностью видимый цвет).

Пример:
'''proc''' _color(x+15, 10, 255, 60)
'''textcolor = _result'''

===Шрифт===

Для определения шрифта, которым будет выводиться текст, используется переменная '''textfont'''. В нее в виде строкового значения следует записать имя файла шрифта.

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

'''FireURQ''' имеет встроенные шрифты с засечками (serif) и без засечек (sans) во всех начертаниях — полужирном (bold), наклонном (italic) и полужирном наклонном (bold-italic).

Чтобы использовать эти шрифты в игре, достаточно написать '''textfont = «serif-italic[25]»''' и у вас будет наклонный шрифт 25-го размера с засечками.

Формат использования шрифта такой:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]'''

*'''size''' – размер шрифта(по умолчанию '''19'''), а точнее высота строки в пикселях
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')

Допустим, мы хотим вывести текст шрифтом Georgia.

Для этого пишем:
'''textfont = "georgia.ttf"'''
И сразу же проверяем результат, при помощи оператора вывода текста '''pln''', который мы уже освоили в совершенстве:
'''pln Крокодил зарылся в ил, крокодила ил манил'''

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

Меняем размер на 42:
'''textfont = "georgia.ttf[42]"'''

Остальные параметры команды нужны, чтобы текст, который будет выведен на экран выглядел еще более красиво (например, при стандартных параметрах текст может выглядеть не слишком хорошо на светлом фоне). В параметре '''bgcolor''', конечно, лучше задать цвет фона, на котором будет выведен текст. Другие параметры подбираются скорее на глаз, чем по науке.

Примеры:
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

Чтобы, после манипуляций с текстом, вернуться к шрифту по умолчанию, следует выполнить:
'''textfont = "_sysfont"'''

'''FireURQ''' может использовать и растровые шрифты формата '''HGE Font''' (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат '''HGE Font''', входит в дистрибутив (папка '''fonted''').

Пример использования HGE шрифта
'''textfont = "myfont.fnt"'''

===Команда CLS===

Часто бывает так, что экран, на который уже выведен текст нужно очистить. Для того чтобы удалить весь текст, выведенный при помощи команд '''P''' и '''PLN''', существует команда '''CLS'''. У нее нет никаких параметров.

Пример:
'''pln Уйма текста.'''
'''cls'''

Результат:
 

===Другие способы вывода текста===

Иногда оказывается недостаточно команд, описанных выше. Например, вы хотите чтобы в верхнем правом углу экрана всегда отображалось количество очков, которые игрок заработал на протяжении игры. Или состояние здоровья персонажа. Или название комнаты, в которой он находится. Или все это одновременно в разных местах экрана. Тогда на помощь автору приходят текстовые [[декораторы]].

===Текст в заголовке===

Для того чтобы вывести название игры или другой текст в заголовок окна FURQ нужно поместить этот текст в системную текстовую переменную gametitle. Если переменная пуста, то в заголовке будет отображаться название файла игры.

Пример:
'''gametitle = “Крокодил”'''

Результат:

[[Изображение:Furq_titlebar.png]]

''; Иногда эту переменную удобно использовать при отладке игры, временно выводя в нее, к примеру, значения других переменных.''

= Переходы =

Любой текстовый квест можно разбить на локации с текстом и переходы между ними. Из каждой локации к другим локациям обычно ведет несколько переходов, которые обозначают некоторые альтернативные варианты действий. В этой главе мы рассмотрим способы, которыми URQL позволяет сделать переходы в игре.

==Переход по кнопкам (оператор BTN)==

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

Общее обозначение: btn <локация>, <надпись на кнопке>]

Где <локация> - имя метки, на которую будет совершен переход, <надпись на кнопке> - надпись на кнопке, которая отображается на экране. В случае если <надпись на кнопке> не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
'''btn лес,Войти в лес'''
Эта команда выведет на экран кнопку с текстом '''Войти в лес''', ведующую на локацию '''лес'''

'''''Примечание 1: пробелы до и после надписи на кнопке игнорируются.'''''

'''''Примечание 2: если локация не найдена, то кнопка выводится с пометкой // phantom.'''''

'''''Примечание 3: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

У кнопок есть так называемое "эхо". Это сообщение, выводящееся на экран о том, что вы перешли по кнопке. Чтобы оно не выводилось, следует использовать переменную '''hide_btn_echo'''. Если установить её в единицу, то сообщения показываться не будут.

'''''Пример:'''''
'''hide_btn_echo = 1'''

===Команда CLSB===

Бывает так, что нам не нужно очищать весь экран, а нужно стереть только кнопки действий. Для того чтобы удалить кнопки выведенные командой '''BTN''', существует команда '''CLSB'''. У нее нет никаких параметров.

Пример:
'''btn север, Идти на Север'''
'''clsb'''
'''btn юг, Идти на Юг'''

Результат (текст на выведенной кнопке):
'''Идти на Юг'''
 

===Оформление кнопок в Fireurq===

Оформление кнопок делается в файле skin.xml
Описание можно найти в статье [[FireURQ:Скины|FireURQ:Скины]].

==Переход по ссылке==

FireURQ позволяет использовать в тексте (и декораторах) ссылки.

'''''Формат ссылок:'''''
'''<nowiki>[[текст ссылки|название локации]]</nowiki>'''

'''''Пример:'''''
'''pln Вы стоите рядом с покосившимся <nowiki>[[домиком|домик_осмотреть]]</nowiki>. Вокруг раскинулись <nowiki>[[клумбы с аромантными цветами|клумбы_осмотреть]]</nowiki>.'''

Здесь '''домик_осмотреть''' и '''клумбы_осмотреть''' - названия локаций, на которые будут осуществляться переходы при нажатии на ссылку.

Цвет ссылок задаётся переменными linkcolor и linkhcolor. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши.

'''''Пример:'''''
'''linkcolor = 0xffffff'''
'''linkhcolor = 0x0000ff'''
В данном примере цвет ссылок в тексте будет белым, а при наведении станет синим.

Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

'''''Упрощенный формат вывода ссылок такой:'''''
'''<nowiki>[[текст ссылки]]</nowiki>'''

В данном случае ссылка будет вести на метку под названием "текст ссылки".

'''''Пример:'''''
'''pln На волнах раскачивается деревянная <nowiki>[[лодка]]</nowiki>.'''

Здесь, при клике на ссылку произойдет переход на метку "лодка".

'''''Замечание: не рекомендуется называть метки именами с пробелами, соответственно не стоит использовать ссылки типа <nowiki>[[деревянная лодка]]</nowiki>, которые ведут на локации с такими именами.'''''

У ссылок, как и у btn есть "эхо", то есть в окне игры пишется, что вы перешли по ссылке. Чтобы его отключить, следует использовать переменную '''hide_link_echo'''. Если установить её в 1, то "эхо" выводиться не будет.

'''''Пример:'''''
'''hide_link_echo = 1'''

'''''Примечание: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

==Переход по оператору GOTO==

'''''Синтаксис:'''''
'''GoTo Метка'''

После выполнения оператора '''goto''' происходит мгновенное перемещение на указанную метку. При наличии локации common (см. ниже) операторы на локации common при переходе по '''goto''' НЕ ВЫПОЛНЯЮТСЯ. Это сделано специально и умышленно - чтобы можно было делать переходы внутри локации.

Примечание: в случае не нахождения метки, goto просто игнорируется.

'''''Пример:'''''
'''goto лес'''
Этот код произведёт перемещение на локацию с названием ''''лес'''.

==Переход по оператору PROC==

'''''Синтаксис:'''''
'''Proc Метка'''

При вызове данного оператора происходит переход на указанную метку и выполнение программы, до встречи первого end, потом управление передается оператору, следующему непосредственно за '''proc''', откуда команда была вызвана. Допустима любая вложенность '''proc'''-вызовов (вплоть до использования рекурсии!).

Нормально обрабатываются последовательные переходы по '''proc''' - цепочка ведется до тех пор, пока не встретится первый end. При этом кнопки во всех пройденных локациях накапливаются(!), но при обнаружении end'а происходит не опрос пользователя, а возврат к предыдущему proc'у и так до самого начала цепочки.

'''''Пример:'''''
''':берег_реки'''
'''pln Вы стоите на берегу реки, позади вас Туманный лес.'''
'''proc лес'''
'''pln Отсюда только одна дорога - на запад.'''
'''end'''
''';----------'''
''':лес'''
'''pln Из леса на вас поглядывают волки.'''
'''end'''

При выполнении этот код выведет на экран следующее:

Вы стоите на берегу реки, позади вас Туманный лес.
Из леса на вас поглядывают волки.
Отсюда только одна дорога - на запад.

То есть, после выполнения по '''proc''' локации '''лес''', мы вернёмся в локацию '''берег_реки''' и продолжим с того места, на котором был вызов команды '''proc'''.

'''''Важно:''''' При наличии локации common (см. ниже) операторы на локации common при переходе по '''proc''' НЕ ВЫПОЛНЯЮТСЯ и системная переменная '''current_loc''' не меняется.

'''Примечание:''' Часто из метки вызванной с помощью '''proc''' ведёт вызов '''goto''' и далее. В таком случае, если мы не хотим возврата к первой локации, нужно использовать оператор '''forget_procs'''

==Переход по декораторам TEXTBUTTON и IMGBUTTON==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Декораторы'''.

==Контекстное меню==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Выпадающие меню'''.

==Параметры при переходах==

Локальные параметры при переходах возможно передать параметры.

Общее обозначение: <метка>(param1, param2, ...)

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные <метка>_1, <метка>_2 и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).

Важное замечание: при использовании параметров в операторе btn подстановки (#...$ и #%...$) раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.

'''''Пример:'''''
'''btn лес(1,"опушка"),Войти в лес'''
На локации '''лес''', переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''

то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''

Параметры при переходах очень удобны для организации проверок внутри локации.

'''''Замечание:''''' Если вы передаёте параметры метке, то её название не должно начинаться с цифры, то есть исключены названия вроде '''25''' или '''40метро'''. Если вы хотите использовать цифры в названии, то ставьте их после букв, к примеру - '''метро40'''.

= Музыка и звук =

В '''FURQ''' есть целый ряд команд для воспроизведения аудио. Оно может быть всевозможных форматов: WAV, AIFF, MP3, MP2, MP1, OGG, MIDXM, IT, S3M, MOD, MTM, UMX. Есть возможность тонкого регулирования громкости звука.

Для начала запасемся на ресурсах, где свободно распространяют звуки (например, www.freesound.org) или запишем сами материала для проигрывания.

==Play==

Команда '''Play''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''play [loop|stop] [<имя файла>[, <громкость>]]'''

Чтобы просто запустить звук на проигрывание с помощью play напишите после команды имя файла. Например, нужно проиграть некий звук крокодила ''alligator.ogg''. Для этого пишем:
'''play alligator.ogg'''

Если файл alligator.ogg лежит рядом с файлом игры, то мы услышим нечто. Но если мы для удобства положим все звуки в отдельную папку sounds, то придется написать так:
'''play sounds/alligator.ogg'''

В нашем примере звук крокодила будет звучать всего один раз, однако, при помощи параметра '''loop''' мы сможем заставить крокодила двигаться и звучать бесконечно:
'''play loop sounds/alligator.ogg'''

Теперь звук будет повторяться снова и снова. Остановить его сможет только параметр '''stop''':
'''play stop sounds/alligator.ogg'''

При помощи '''Play''' можно одновременно проигрывать несколько звуков. Кроме того, можно регулировать громкость звука, добавив к команде play через запятую значение от '''0''' (полная тишина) до '''255''' (максимальная громкость). По умолчанию, '''play''' играет аудио с максимальной громкостью.

К примеру, мы хотим, одновременно наслаждаться звуком крокодила и чмоканием болота, но так, чтобы крокодил был слышен громче:
'''play loop sounds/alligator.ogg'''
'''play loop sounds/swamp.wav, 100'''

Чтобы остановить сразу все звуки, запущенные командой '''play''', мы применим такую на первый взгляд абсурдную команду как:
'''play stop'''

''; Важно помнить, что звуки запущенные на одной локации через '''play''' с параметром '''loop''' без новой команды с параметром '''stop''' сами собой не прекратятся, даже если вы перешли на другую локацию. И если вы вдруг оттуда вернетесь на прежнюю локацию, то те же самые звуки запустятся еще раз. Добро пожаловать в какафонию.''

==Voice==

Команда '''Voice''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''voice <имя файла>'''
'''voice stop'''

Команда предназначена специально для озвучивания игры голосом. Например, ей удобно запускать записи реплик персонажей или рассказчика. Во многом она аналогична команде '''play''', но с несколькими важными особенностями:
Проигрывать можно только одну реплику/звук одновременно(запуск другой озвучки через команду voice останавливает предыдущую).

Переход на другую локацию по кнопке ('''btn''') останавливает озвучку.

Громкость здесь регулируется числовой переменной '''voice_volume''' (от '''0''' до '''255''').

Остановить проигрывание файла можно при помощи команды '''voice stop'''.

Если вам необходимо чтобы прозвучало несколько реплик на одной локации, то достаточно удобно использовать команду voice в связке с командой '''anykey'''. Прослушав реплику, игрок будет нажимать на любую клавишу и слушать следующую.

Например:

'''voice_volume=200'''
'''pln - Еще раз здравствуй. - сказал крокодил и придвинулся поближе.'''
'''voice sounds/helloagain.ogg'''
'''anykey'''
'''pln Вам стало не по себе.'''
'''voice sounds/SCREAM.wav'''

==Music==

Кроме форматов аудиофайлов, которые воспроизводят команды '''play''' и '''voice''', команда '''music''' проигрывает еще и трекерную музыку (XM, IT, S3M, MOD, MTM, UMX), MIDI-файлы (MID) и MO3.

Формат команды:
'''music <имя файла>|stop[, <время в миллисекундах>]'''

Зацикливание проигрывания устанавливается в переменной music_looped ('''0''' - играть один раз, '''1''' - играть бесконечно). По умолчанию, вот отличие от команд '''play''' и '''voice''', здесь музыка зациклена.

''; некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.

''Громкость воспроизведения регулируется переменной music_volume (от '''0''' до '''255''').

С помощью команды '''music''' можно проигрывать только один файл одновременно, однако, можно задавать время, в течении которого громкость следующего аудиофайла будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект '''crossfade''' – старый трек будет угасать, а новый – нарастать по громкости.

Так “'''music stop'''” останавливает воспроизведение музыки. А если указать в качестве параметра время, то воспроизведение остановится через заданный промежуток.
'''music stop, 1500 ''; остановить музыку через 1,5 секунды'''''

===fademusic===

С помощью команды '''fademusic''' можно добиться плавного и красивого изменения громкости музыки.
Формат команды:
'''fademusic <громкость>, <время в миллисекундах>'''
громкость – целевая громкость музыки.

время в миллисекундах – время, в течении которого громкость достигнет целевого значения.

Предположим, что мы хотим сделать красивое и удобное включение и выключение музыки в нашей игре. Для этого используем [[инвентарь]] '''URQ'''. Игрок в любой момент сможет через пункт меню инвентаря включить и выключить музыку, а мы постараемся, чтобы это было плавно. На самом деле выключать музыку совсем мы не будем, а будем только понижать громкость до нуля, но зато нам не придется задаваться вопросом какой именно файл запускать при включении музыки.

В начале игры создадим элемент инвентаря “музыка” и присвоим ему наклейку “выключить музыку”:
'''inv+ музыка'''
'''idisp_музыка = "выключить музыку"'''
Запускаем любую музыку, в любом месте игры:
'''music music\Joe Hisaishi - Пылью на твоих руках.mp3'''
Теперь, в локации, которая отвечает за наш элемент инвентаря “музыка” используем оператор '''fademusic''':
''':Use_музыка'''
'''if idisp_музыка == "включить музыку" then idisp_музыка = "выключить музыку" & fademusic 255, 1500 else idisp_музыка = "включить музыку" & fademusic 0, 1500'''
'''end'''
Теперь по нажатию на “выключить музыку” громкость будет плавно затихать до нуля за 1,5 секунды, а по нажатию на “включить музыку” - так же плавно возрастать.

=Функции=

==Случайное значение Rnd==

Иногда полезно - особенно, если не злоупотреблять этим, ввести в квест элемент случайности, непредсказуемости. Именно для этого был введен механизм случайности: Rnd[x] - системная переменная (только для чтения) которая при пустом значении x хранит в себе случайное значение от 0 до 1, включая 1, а при целом x (к примеру, X=6) выдает выдает целые значения (от 1 до 6 включительно в нашем случае). При каждом обращении к переменной она принимает другое значение.

'''случай1 = rnd''' ;В результате переменная случай1 равна, например, 0.78

'''случай2 = rnd4''' ;В результате переменная случай2 равна, например, 3

==Ввод текста INPUT==

В урке есть возможность ввести строку, значение которой будет потом присвоено указанной переменной.

При необходимости ввести с клавиатуры русский текст через оператор '''input''' в строковую переменную ее следует предварительно объявить выражением:
'''строка = ""'''; Данное выражение создает строковую переменную нулевой длины.

'''pln Введите строку: & input строка'''

На экране мы увидим:
'''Введите строку:'''

==Команда forget_procs==

В URQL есть нюанс - если мы используем '''goto метка''' из локации вызванной по '''proc''', то история вызовов не забывается.
Но есть команда '''forget_procs''', которая позволяет это исправить.

Рассмотрим следующий код:

:пример
pln Выводим текст 1
proc выход1
pln Выводим текст 2
end

:выход1
goto выход2
end

:выход2
forget_procs ; вставляем для того, чтобы забыть предыдущие действия
pln Выводим текст 3
end

Без команды '''forget_procs''' мы увидим на экране

Выводим текст 1
Выводим текст 3
Выводим текст 2

Если же мы используем эту команду, то на экране появится:

Выводим текст 1
Выводим текст 3

что чаще всего и нужно.

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

FireURQ:Руководство пользователя

2017-07-05T12:56:21Z

Ajenta: /* Команда forget_procs */

=Метки=

Метка - одно из важнейших понятий URQL. Она служит для выделения места в квесте, куда затем предстоит перейти. Любые перемещения в квесте могут быть либо на следующий оператор, либо на метку. Все метки имеют имена, чтобы потом можно было указывать, куда вы хотите перейти.
Определяется метка при помощи двоеточия. Все, что правее этого символа, до разделителя, которым является символ конец абзаца (Enter) или '&' - имя метки:

''':Имя_метки'''

Метка и следующий за ней оператор end являются принятой единицей измерения игры - локацией. Между ними обычно пишется описание локации и переходы из неё в другие локации.

''':начало'''
'''end'''

Например, допустимыми именами меток являются:

''':1'''
''':01'''
''':а'''
''':кот1'''
''':@(a)%^Очень_Длинная_и_Запутанная_метка_какими-лучше-не-пользоваться!!!!!_horror_так_как_сами_потом_забудете_как_она_называется!Или_сделаете_ошибку!'''
'''Вы_же_можете_сделать_маленькую_ошибку_в таком_длинном_названии?'''
''':house_flat1'''

'''''Примечание:''''' метка должна начинаться с начала строки и отделяться от других операторов (Enter) или '&', регистр имени метки не важен.

:BIG
:bIG
:Big
:big
- все эти метки для интерпретатора совершенно одинаковы. Но лучше, в целях собственного удобства, придерживаться единого стиля.

В метке лучше не делать пробелов. Длина метки не ограничена, но для удобства автора квеста лучше не делать меток длиннее строки. В метке допускаются символы, обозначающие буквы русского и латинского алфавита, цифры, знак подчеркивания и знаки арифметических операций + и - (лучше не злоупотреблять странными названиями).

Недопустимы символы ''';''' '''/*''' '''*/''' '''&'''

Грамотное использование имен меток способно серьезно облегчить работу автора.

=Текст=
==Вывод текста==

Поскольку мы имеем дело с текстовыми играми, важнейшим для нас является вывод текста. В FURQ существует несколько способов вывода текста.

===Текст на экране===

Простейший способ вывести текст это использовать команды '''P''' и '''PLN'''. Советую освоить их, прежде чем переходить к другим способам вывода.

Формат команд:
'''p''' [текст]
'''pln''' [текст]

Регистр команд не имеет значения ('''pLn''' = '''PLN''' = '''Pln''').

На практике это выглядит так:
'''p''' Этот текст появится на экране.
или
'''pln''' Этот текст тоже появится на экране.

Каждая последующая команда '''P''' или '''PLN''' дописывает новый текст к тексту который уже есть на экране. Когда текста становится слишком много, появляется возможность его прокрутить.

Разница этих двух команд в следующем - '''P''' просто добавляет новый текст, а '''PLN''' добавляет текст и делает переход на новую строку (создает абзац).

Например:
'''p''' А
'''p''' Б

Выдаст “АБ”, тогда как

'''pln''' А
'''pln''' Б

Выдаст:
А
Б

Чаще всего пользуются командой '''pln''', однако и '''p''' может быть полезна, например, когда строчка текста, которую мы хотим вывести на экран, состоит из нескольких частей и зависит от каких-либо переменных или условий.

Команды '''P''' и '''PLN''' могут напрямую выводить любые символы (кроме символа комментария '''“;”'''), переменные и ссылки.

===Вывод переменных===

Вывод переменных возможен в двух вариантах - числовом и текстовом. Для того чтобы их вывести, нужно заключить имена переменных в соответствующие скобки:
'''pln''' '''#%'''имя_текстовой_переменной'''$''' '''#'''имя_числовой_переменной'''$'''
Несмотря на внешнее сходство, они отличаются содержанием и символом '''%'''. Если в числовые скобки попадет текстовая переменная, то на выводе окажется не текст, а количество символов в этой переменной. И наоборот, если числовая переменная попадет в текстовые скобки, то на выводе окажется пустота.

Выведем оба типа переменных на экран:

'''текстовая_переменная="Геннадий"'''
'''числовая_переменная=42'''
'''pln''' Крокодил схватил вас за ногу и сказал:
'''pln''' - Меня зовут '''#%текстовая_переменная$'''.
'''pln''' Затем крокодил схватил вас за другую ногу и сказал:
'''pln''' - Мне '''#числовая_переменная$''' года. Давай, ты станешь моим близким другом.

Результат:
Крокодил схватил вас за ногу и сказал:
- Меня зовут Геннадий.
Затем крокодил схватил вас за другую ногу и сказал:
- Мне 42 года. Давай, ты станешь моим близким другом.

Кроме того, в '''URQL''' есть специальные обозначения для вывода символа пробела - '''#$''', вывода символа переноса строки - '''#/$''' и вывода символа по ascii-коду - '''##'''ascii-код'''$'''.

Так, например, символ комментария можно вывести на экран, через его ascii-код:
'''pln''' Моя грамотность была на исходе'''##59$''' но, несмотря на это, я поставил точку с запятой в предложении.

Результат:
Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.

Хочу напомнить, что если бы мы написали в коде просто:
'''pln''' Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.
То получили бы на экране:
Моя грамотность была на исходе
Потому что символ ";" и все что после него идет было бы обработано как комментарий.

'''Примечание:'''
Вывод строковой переменной, как числа '''#текстовая_переменная$''' даст нам количество символов в строке.

==Оформление текста==

В 21 веке в '''FURQ''' текст это не просто набор символов, но еще и набор гарнитур, цвет, выравнивание и местоположение.

===Местоположение===
Область экрана, куда выводят текст команды '''p''' и '''pln''' можно двигать, делать шире, уже, выше и т.д. Для этого служат системные переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height''', которые описывают некий прямоугольник куда и выводится текст. По умолчанию он занимает почти весь экран. Это числовые переменные, которые содержат значения в пикселях.

Давайте, используя полученные нами знания, выведем значения этих переменных на экран:
'''pln''' Левая граница='''#textpane_left$''', Верхняя граница='''#textpane_top$''', Ширина='''#textpane_width$''', Высота='''#textpane_height$'''

Результат:
Левая граница=20, Верхняя граница=55, Ширина=760, Высота=525

Вы можете изменять значения этих переменных как угодно в любом месте игры. Например, вы хотите вывести справа от текста картинку: измените ширину ('''textpane_width''') так чтобы текст не мешал. А когда картинка больше не нужна измените ширину обратно. Экспериментируйте.

===Выравнивание текста===

За выравнивание текста отвечает команда числовая системная переменная textalign. Она сообщает FURQ как должен быть расположен текст относительно области его вывода.

Лучше всего это понять на примере:
'''textalign = 1'''
'''pln''' текст выравнивается влево
'''textalign = 2'''
'''pln''' текст выравнивается вправо
'''textalign = 3'''
'''pln''' текст выравнивается по центру

''; Главное теперь не забыть, поменять переменную обратно на '''1''', если вы не хотите, чтобы текст всей игры был выравнен по центру.''

===Цвет===

Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате '''0xAARRGGBB'''. То есть четыре составляющих: альфа, красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.

Встроенная функция '''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255''' (т.е. полностью видимый цвет).

Пример:
'''proc''' _color(x+15, 10, 255, 60)
'''textcolor = _result'''

===Шрифт===

Для определения шрифта, которым будет выводиться текст, используется переменная '''textfont'''. В нее в виде строкового значения следует записать имя файла шрифта.

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

'''FireURQ''' имеет встроенные шрифты с засечками (serif) и без засечек (sans) во всех начертаниях — полужирном (bold), наклонном (italic) и полужирном наклонном (bold-italic).

Чтобы использовать эти шрифты в игре, достаточно написать '''textfont = «serif-italic[25]»''' и у вас будет наклонный шрифт 25-го размера с засечками.

Формат использования шрифта такой:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]'''

*'''size''' – размер шрифта(по умолчанию '''19'''), а точнее высота строки в пикселях
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')

Допустим, мы хотим вывести текст шрифтом Georgia.

Для этого пишем:
'''textfont = "georgia.ttf"'''
И сразу же проверяем результат, при помощи оператора вывода текста '''pln''', который мы уже освоили в совершенстве:
'''pln Крокодил зарылся в ил, крокодила ил манил'''

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

Меняем размер на 42:
'''textfont = "georgia.ttf[42]"'''

Остальные параметры команды нужны, чтобы текст, который будет выведен на экран выглядел еще более красиво (например, при стандартных параметрах текст может выглядеть не слишком хорошо на светлом фоне). В параметре '''bgcolor''', конечно, лучше задать цвет фона, на котором будет выведен текст. Другие параметры подбираются скорее на глаз, чем по науке.

Примеры:
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

Чтобы, после манипуляций с текстом, вернуться к шрифту по умолчанию, следует выполнить:
'''textfont = "_sysfont"'''

'''FireURQ''' может использовать и растровые шрифты формата '''HGE Font''' (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат '''HGE Font''', входит в дистрибутив (папка '''fonted''').

Пример использования HGE шрифта
'''textfont = "myfont.fnt"'''

===Команда CLS===

Часто бывает так, что экран, на который уже выведен текст нужно очистить. Для того чтобы удалить весь текст, выведенный при помощи команд '''P''' и '''PLN''', существует команда '''CLS'''. У нее нет никаких параметров.

Пример:
'''pln Уйма текста.'''
'''cls'''

Результат:
 

===Другие способы вывода текста===

Иногда оказывается недостаточно команд, описанных выше. Например, вы хотите чтобы в верхнем правом углу экрана всегда отображалось количество очков, которые игрок заработал на протяжении игры. Или состояние здоровья персонажа. Или название комнаты, в которой он находится. Или все это одновременно в разных местах экрана. Тогда на помощь автору приходят текстовые [[декораторы]].

===Текст в заголовке===

Для того чтобы вывести название игры или другой текст в заголовок окна FURQ нужно поместить этот текст в системную текстовую переменную gametitle. Если переменная пуста, то в заголовке будет отображаться название файла игры.

Пример:
'''gametitle = “Крокодил”'''

Результат:

[[Изображение:Furq_titlebar.png]]

''; Иногда эту переменную удобно использовать при отладке игры, временно выводя в нее, к примеру, значения других переменных.''

= Переходы =

Любой текстовый квест можно разбить на локации с текстом и переходы между ними. Из каждой локации к другим локациям обычно ведет несколько переходов, которые обозначают некоторые альтернативные варианты действий. В этой главе мы рассмотрим способы, которыми URQL позволяет сделать переходы в игре.

==Переход по кнопкам (оператор BTN)==

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

Общее обозначение: btn <локация>, <надпись на кнопке>]

Где <локация> - имя метки, на которую будет совершен переход, <надпись на кнопке> - надпись на кнопке, которая отображается на экране. В случае если <надпись на кнопке> не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
'''btn лес,Войти в лес'''
Эта команда выведет на экран кнопку с текстом '''Войти в лес''', ведующую на локацию '''лес'''

'''''Примечание 1: пробелы до и после надписи на кнопке игнорируются.'''''

'''''Примечание 2: если локация не найдена, то кнопка выводится с пометкой // phantom.'''''

'''''Примечание 3: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

У кнопок есть так называемое "эхо". Это сообщение, выводящееся на экран о том, что вы перешли по кнопке. Чтобы оно не выводилось, следует использовать переменную '''hide_btn_echo'''. Если установить её в единицу, то сообщения показываться не будут.

'''''Пример:'''''
'''hide_btn_echo = 1'''

===Команда CLSB===

Бывает так, что нам не нужно очищать весь экран, а нужно стереть только кнопки действий. Для того чтобы удалить кнопки выведенные командой '''BTN''', существует команда '''CLSB'''. У нее нет никаких параметров.

Пример:
'''btn север, Идти на Север'''
'''clsb'''
'''btn юг, Идти на Юг'''

Результат (текст на выведенной кнопке):
'''Идти на Юг'''
 

===Оформление кнопок в Fireurq===

Оформление кнопок делается в файле skin.xml
Описание можно найти в статье [[FireURQ:Скины|FireURQ:Скины]].

==Переход по ссылке==

FireURQ позволяет использовать в тексте (и декораторах) ссылки.

'''''Формат ссылок:'''''
'''<nowiki>[[текст ссылки|название локации]]</nowiki>'''

'''''Пример:'''''
'''pln Вы стоите рядом с покосившимся <nowiki>[[домиком|домик_осмотреть]]</nowiki>. Вокруг раскинулись <nowiki>[[клумбы с аромантными цветами|клумбы_осмотреть]]</nowiki>.'''

Здесь '''домик_осмотреть''' и '''клумбы_осмотреть''' - названия локаций, на которые будут осуществляться переходы при нажатии на ссылку.

Цвет ссылок задаётся переменными linkcolor и linkhcolor. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши.

'''''Пример:'''''
'''linkcolor = 0xffffff'''
'''linkhcolor = 0x0000ff'''
В данном примере цвет ссылок в тексте будет белым, а при наведении станет синим.

Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

'''''Упрощенный формат вывода ссылок такой:'''''
'''<nowiki>[[текст ссылки]]</nowiki>'''

В данном случае ссылка будет вести на метку под названием "текст ссылки".

'''''Пример:'''''
'''pln На волнах раскачивается деревянная <nowiki>[[лодка]]</nowiki>.'''

Здесь, при клике на ссылку произойдет переход на метку "лодка".

'''''Замечание: не рекомендуется называть метки именами с пробелами, соответственно не стоит использовать ссылки типа <nowiki>[[деревянная лодка]]</nowiki>, которые ведут на локации с такими именами.'''''

У ссылок, как и у btn есть "эхо", то есть в окне игры пишется, что вы перешли по ссылке. Чтобы его отключить, следует использовать переменную '''hide_link_echo'''. Если установить её в 1, то "эхо" выводиться не будет.

'''''Пример:'''''
'''hide_link_echo = 1'''

'''''Примечание: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

==Переход по оператору GOTO==

'''''Синтаксис:'''''
'''GoTo Метка'''

После выполнения оператора '''goto''' происходит мгновенное перемещение на указанную метку. При наличии локации common (см. ниже) операторы на локации common при переходе по '''goto''' НЕ ВЫПОЛНЯЮТСЯ. Это сделано специально и умышленно - чтобы можно было делать переходы внутри локации.

Примечание: в случае не нахождения метки, goto просто игнорируется.

'''''Пример:'''''
'''goto лес'''
Этот код произведёт перемещение на локацию с названием ''''лес'''.

==Переход по оператору PROC==

'''''Синтаксис:'''''
'''Proc Метка'''

При вызове данного оператора происходит переход на указанную метку и выполнение программы, до встречи первого end, потом управление передается оператору, следующему непосредственно за '''proc''', откуда команда была вызвана. Допустима любая вложенность '''proc'''-вызовов (вплоть до использования рекурсии!).

Нормально обрабатываются последовательные переходы по '''proc''' - цепочка ведется до тех пор, пока не встретится первый end. При этом кнопки во всех пройденных локациях накапливаются(!), но при обнаружении end'а происходит не опрос пользователя, а возврат к предыдущему proc'у и так до самого начала цепочки.

'''''Пример:'''''
''':берег_реки'''
'''pln Вы стоите на берегу реки, позади вас Туманный лес.'''
'''proc лес'''
'''pln Отсюда только одна дорога - на запад.'''
'''end'''
''';----------'''
''':лес'''
'''pln Из леса на вас поглядывают волки.'''
'''end'''

При выполнении этот код выведет на экран следующее:

Вы стоите на берегу реки, позади вас Туманный лес.
Из леса на вас поглядывают волки.
Отсюда только одна дорога - на запад.

То есть, после выполнения по '''proc''' локации '''лес''', мы вернёмся в локацию '''берег_реки''' и продолжим с того места, на котором был вызов команды '''proc'''.

'''''Важно:''''' При наличии локации common (см. ниже) операторы на локации common при переходе по '''proc''' НЕ ВЫПОЛНЯЮТСЯ и системная переменная '''current_loc''' не меняется.

'''Примечание:''' Часто из метки вызванной с помощью '''proc''' ведёт вызов '''goto''' и далее. В таком случае, если мы не хотим возврата к первой локации, нужно использовать оператор '''forget_procs'''

==Переход по декораторам TEXTBUTTON и IMGBUTTON==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Декораторы'''.

==Контекстное меню==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Выпадающие меню'''.

==Параметры при переходах==

Локальные параметры при переходах возможно передать параметры.

Общее обозначение: <метка>(param1, param2, ...)

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные <метка>_1, <метка>_2 и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).

Важное замечание: при использовании параметров в операторе btn подстановки (#...$ и #%...$) раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.

'''''Пример:'''''
'''btn лес(1,"опушка"),Войти в лес'''
На локации '''лес''', переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''

то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''

Параметры при переходах очень удобны для организации проверок внутри локации.

'''''Замечание:''''' Если вы передаёте параметры метке, то её название не должно начинаться с цифры, то есть исключены названия вроде '''25''' или '''40метро'''. Если вы хотите использовать цифры в названии, то ставьте их после букв, к примеру - '''метро40'''.

= Музыка и звук =

В '''FURQ''' есть целый ряд команд для воспроизведения аудио. Оно может быть всевозможных форматов: WAV, AIFF, MP3, MP2, MP1, OGG, MIDXM, IT, S3M, MOD, MTM, UMX. Есть возможность тонкого регулирования громкости звука.

Для начала запасемся на ресурсах, где свободно распространяют звуки (например, www.freesound.org) или запишем сами материала для проигрывания.

==Play==

Команда '''Play''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''play [loop|stop] [<имя файла>[, <громкость>]]'''

Чтобы просто запустить звук на проигрывание с помощью play напишите после команды имя файла. Например, нужно проиграть некий звук крокодила ''alligator.ogg''. Для этого пишем:
'''play alligator.ogg'''

Если файл alligator.ogg лежит рядом с файлом игры, то мы услышим нечто. Но если мы для удобства положим все звуки в отдельную папку sounds, то придется написать так:
'''play sounds/alligator.ogg'''

В нашем примере звук крокодила будет звучать всего один раз, однако, при помощи параметра '''loop''' мы сможем заставить крокодила двигаться и звучать бесконечно:
'''play loop sounds/alligator.ogg'''

Теперь звук будет повторяться снова и снова. Остановить его сможет только параметр '''stop''':
'''play stop sounds/alligator.ogg'''

При помощи '''Play''' можно одновременно проигрывать несколько звуков. Кроме того, можно регулировать громкость звука, добавив к команде play через запятую значение от '''0''' (полная тишина) до '''255''' (максимальная громкость). По умолчанию, '''play''' играет аудио с максимальной громкостью.

К примеру, мы хотим, одновременно наслаждаться звуком крокодила и чмоканием болота, но так, чтобы крокодил был слышен громче:
'''play loop sounds/alligator.ogg'''
'''play loop sounds/swamp.wav, 100'''

Чтобы остановить сразу все звуки, запущенные командой '''play''', мы применим такую на первый взгляд абсурдную команду как:
'''play stop'''

''; Важно помнить, что звуки запущенные на одной локации через '''play''' с параметром '''loop''' без новой команды с параметром '''stop''' сами собой не прекратятся, даже если вы перешли на другую локацию. И если вы вдруг оттуда вернетесь на прежнюю локацию, то те же самые звуки запустятся еще раз. Добро пожаловать в какафонию.''

==Voice==

Команда '''Voice''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''voice <имя файла>'''
'''voice stop'''

Команда предназначена специально для озвучивания игры голосом. Например, ей удобно запускать записи реплик персонажей или рассказчика. Во многом она аналогична команде '''play''', но с несколькими важными особенностями:
Проигрывать можно только одну реплику/звук одновременно(запуск другой озвучки через команду voice останавливает предыдущую).

Переход на другую локацию по кнопке ('''btn''') останавливает озвучку.

Громкость здесь регулируется числовой переменной '''voice_volume''' (от '''0''' до '''255''').

Остановить проигрывание файла можно при помощи команды '''voice stop'''.

Если вам необходимо чтобы прозвучало несколько реплик на одной локации, то достаточно удобно использовать команду voice в связке с командой '''anykey'''. Прослушав реплику, игрок будет нажимать на любую клавишу и слушать следующую.

Например:

'''voice_volume=200'''
'''pln - Еще раз здравствуй. - сказал крокодил и придвинулся поближе.'''
'''voice sounds/helloagain.ogg'''
'''anykey'''
'''pln Вам стало не по себе.'''
'''voice sounds/SCREAM.wav'''

==Music==

Кроме форматов аудиофайлов, которые воспроизводят команды '''play''' и '''voice''', команда '''music''' проигрывает еще и трекерную музыку (XM, IT, S3M, MOD, MTM, UMX), MIDI-файлы (MID) и MO3.

Формат команды:
'''music <имя файла>|stop[, <время в миллисекундах>]'''

Зацикливание проигрывания устанавливается в переменной music_looped ('''0''' - играть один раз, '''1''' - играть бесконечно). По умолчанию, вот отличие от команд '''play''' и '''voice''', здесь музыка зациклена.

''; некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.

''Громкость воспроизведения регулируется переменной music_volume (от '''0''' до '''255''').

С помощью команды '''music''' можно проигрывать только один файл одновременно, однако, можно задавать время, в течении которого громкость следующего аудиофайла будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект '''crossfade''' – старый трек будет угасать, а новый – нарастать по громкости.

Так “'''music stop'''” останавливает воспроизведение музыки. А если указать в качестве параметра время, то воспроизведение остановится через заданный промежуток.
'''music stop, 1500 ''; остановить музыку через 1,5 секунды'''''

===fademusic===

С помощью команды '''fademusic''' можно добиться плавного и красивого изменения громкости музыки.
Формат команды:
'''fademusic <громкость>, <время в миллисекундах>'''
громкость – целевая громкость музыки.

время в миллисекундах – время, в течении которого громкость достигнет целевого значения.

Предположим, что мы хотим сделать красивое и удобное включение и выключение музыки в нашей игре. Для этого используем [[инвентарь]] '''URQ'''. Игрок в любой момент сможет через пункт меню инвентаря включить и выключить музыку, а мы постараемся, чтобы это было плавно. На самом деле выключать музыку совсем мы не будем, а будем только понижать громкость до нуля, но зато нам не придется задаваться вопросом какой именно файл запускать при включении музыки.

В начале игры создадим элемент инвентаря “музыка” и присвоим ему наклейку “выключить музыку”:
'''inv+ музыка'''
'''idisp_музыка = "выключить музыку"'''
Запускаем любую музыку, в любом месте игры:
'''music music\Joe Hisaishi - Пылью на твоих руках.mp3'''
Теперь, в локации, которая отвечает за наш элемент инвентаря “музыка” используем оператор '''fademusic''':
''':Use_музыка'''
'''if idisp_музыка == "включить музыку" then idisp_музыка = "выключить музыку" & fademusic 255, 1500 else idisp_музыка = "включить музыку" & fademusic 0, 1500'''
'''end'''
Теперь по нажатию на “выключить музыку” громкость будет плавно затихать до нуля за 1,5 секунды, а по нажатию на “включить музыку” - так же плавно возрастать.

=Функции=

==Случайное значение Rnd==

Иногда полезно - особенно, если не злоупотреблять этим, ввести в квест элемент случайности, непредсказуемости. Именно для этого был введен механизм случайности: Rnd[x] - системная переменная (только для чтения) которая при пустом значении x хранит в себе случайное значение от 0 до 1, включая 1, а при целом x (к примеру, X=6) выдает выдает целые значения (от 1 до 6 включительно в нашем случае). При каждом обращении к переменной она принимает другое значение.

'''случай1 = rnd''' ;В результате переменная случай1 равна, например, 0.78

'''случай2 = rnd4''' ;В результате переменная случай2 равна, например, 3

==Ввод текста INPUT==

В урке есть возможность ввести строку, значение которой будет потом присвоено указанной переменной.

При необходимости ввести с клавиатуры русский текст через оператор '''input''' в строковую переменную ее следует предварительно объявить выражением:
'''строка = ""'''; Данное выражение создает строковую переменную нулевой длины.

'''pln Введите строку: & input строка'''

На экране мы увидим:
'''Введите строку:'''

==Команда forget_procs==

В URQL есть нюанс - если мы используем '''goto метка''' из локации вызванной по '''proc''', то история вызовов не забывается.
Но есть команда '''forget_procs''', которая позволяет это исправить.

Рассмотрим следующий код:

''':пример
pln Выводим текст 1
proc выход1
pln Выводим текст 2
end

:выход1
goto выход2
end

:выход2
forget_procs ; вставляем для того, чтобы забыть предыдущие действия
pln Выводим текст 3
end'''

Без команды '''forget_procs''' мы увидим на экране

'''Выводим текст 1
Выводим текст 3
Выводим текст 2'''

Если же мы используем эту команду, то на экране появится:

'''Выводим текст 1
Выводим текст 3'''

что чаще всего и нужно.

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

FireURQ:Руководство пользователя

2017-07-05T12:50:55Z

Ajenta: /* Команда forget_procs */

=Метки=

Метка - одно из важнейших понятий URQL. Она служит для выделения места в квесте, куда затем предстоит перейти. Любые перемещения в квесте могут быть либо на следующий оператор, либо на метку. Все метки имеют имена, чтобы потом можно было указывать, куда вы хотите перейти.
Определяется метка при помощи двоеточия. Все, что правее этого символа, до разделителя, которым является символ конец абзаца (Enter) или '&' - имя метки:

''':Имя_метки'''

Метка и следующий за ней оператор end являются принятой единицей измерения игры - локацией. Между ними обычно пишется описание локации и переходы из неё в другие локации.

''':начало'''
'''end'''

Например, допустимыми именами меток являются:

''':1'''
''':01'''
''':а'''
''':кот1'''
''':@(a)%^Очень_Длинная_и_Запутанная_метка_какими-лучше-не-пользоваться!!!!!_horror_так_как_сами_потом_забудете_как_она_называется!Или_сделаете_ошибку!'''
'''Вы_же_можете_сделать_маленькую_ошибку_в таком_длинном_названии?'''
''':house_flat1'''

'''''Примечание:''''' метка должна начинаться с начала строки и отделяться от других операторов (Enter) или '&', регистр имени метки не важен.

:BIG
:bIG
:Big
:big
- все эти метки для интерпретатора совершенно одинаковы. Но лучше, в целях собственного удобства, придерживаться единого стиля.

В метке лучше не делать пробелов. Длина метки не ограничена, но для удобства автора квеста лучше не делать меток длиннее строки. В метке допускаются символы, обозначающие буквы русского и латинского алфавита, цифры, знак подчеркивания и знаки арифметических операций + и - (лучше не злоупотреблять странными названиями).

Недопустимы символы ''';''' '''/*''' '''*/''' '''&'''

Грамотное использование имен меток способно серьезно облегчить работу автора.

=Текст=
==Вывод текста==

Поскольку мы имеем дело с текстовыми играми, важнейшим для нас является вывод текста. В FURQ существует несколько способов вывода текста.

===Текст на экране===

Простейший способ вывести текст это использовать команды '''P''' и '''PLN'''. Советую освоить их, прежде чем переходить к другим способам вывода.

Формат команд:
'''p''' [текст]
'''pln''' [текст]

Регистр команд не имеет значения ('''pLn''' = '''PLN''' = '''Pln''').

На практике это выглядит так:
'''p''' Этот текст появится на экране.
или
'''pln''' Этот текст тоже появится на экране.

Каждая последующая команда '''P''' или '''PLN''' дописывает новый текст к тексту который уже есть на экране. Когда текста становится слишком много, появляется возможность его прокрутить.

Разница этих двух команд в следующем - '''P''' просто добавляет новый текст, а '''PLN''' добавляет текст и делает переход на новую строку (создает абзац).

Например:
'''p''' А
'''p''' Б

Выдаст “АБ”, тогда как

'''pln''' А
'''pln''' Б

Выдаст:
А
Б

Чаще всего пользуются командой '''pln''', однако и '''p''' может быть полезна, например, когда строчка текста, которую мы хотим вывести на экран, состоит из нескольких частей и зависит от каких-либо переменных или условий.

Команды '''P''' и '''PLN''' могут напрямую выводить любые символы (кроме символа комментария '''“;”'''), переменные и ссылки.

===Вывод переменных===

Вывод переменных возможен в двух вариантах - числовом и текстовом. Для того чтобы их вывести, нужно заключить имена переменных в соответствующие скобки:
'''pln''' '''#%'''имя_текстовой_переменной'''$''' '''#'''имя_числовой_переменной'''$'''
Несмотря на внешнее сходство, они отличаются содержанием и символом '''%'''. Если в числовые скобки попадет текстовая переменная, то на выводе окажется не текст, а количество символов в этой переменной. И наоборот, если числовая переменная попадет в текстовые скобки, то на выводе окажется пустота.

Выведем оба типа переменных на экран:

'''текстовая_переменная="Геннадий"'''
'''числовая_переменная=42'''
'''pln''' Крокодил схватил вас за ногу и сказал:
'''pln''' - Меня зовут '''#%текстовая_переменная$'''.
'''pln''' Затем крокодил схватил вас за другую ногу и сказал:
'''pln''' - Мне '''#числовая_переменная$''' года. Давай, ты станешь моим близким другом.

Результат:
Крокодил схватил вас за ногу и сказал:
- Меня зовут Геннадий.
Затем крокодил схватил вас за другую ногу и сказал:
- Мне 42 года. Давай, ты станешь моим близким другом.

Кроме того, в '''URQL''' есть специальные обозначения для вывода символа пробела - '''#$''', вывода символа переноса строки - '''#/$''' и вывода символа по ascii-коду - '''##'''ascii-код'''$'''.

Так, например, символ комментария можно вывести на экран, через его ascii-код:
'''pln''' Моя грамотность была на исходе'''##59$''' но, несмотря на это, я поставил точку с запятой в предложении.

Результат:
Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.

Хочу напомнить, что если бы мы написали в коде просто:
'''pln''' Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.
То получили бы на экране:
Моя грамотность была на исходе
Потому что символ ";" и все что после него идет было бы обработано как комментарий.

'''Примечание:'''
Вывод строковой переменной, как числа '''#текстовая_переменная$''' даст нам количество символов в строке.

==Оформление текста==

В 21 веке в '''FURQ''' текст это не просто набор символов, но еще и набор гарнитур, цвет, выравнивание и местоположение.

===Местоположение===
Область экрана, куда выводят текст команды '''p''' и '''pln''' можно двигать, делать шире, уже, выше и т.д. Для этого служат системные переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height''', которые описывают некий прямоугольник куда и выводится текст. По умолчанию он занимает почти весь экран. Это числовые переменные, которые содержат значения в пикселях.

Давайте, используя полученные нами знания, выведем значения этих переменных на экран:
'''pln''' Левая граница='''#textpane_left$''', Верхняя граница='''#textpane_top$''', Ширина='''#textpane_width$''', Высота='''#textpane_height$'''

Результат:
Левая граница=20, Верхняя граница=55, Ширина=760, Высота=525

Вы можете изменять значения этих переменных как угодно в любом месте игры. Например, вы хотите вывести справа от текста картинку: измените ширину ('''textpane_width''') так чтобы текст не мешал. А когда картинка больше не нужна измените ширину обратно. Экспериментируйте.

===Выравнивание текста===

За выравнивание текста отвечает команда числовая системная переменная textalign. Она сообщает FURQ как должен быть расположен текст относительно области его вывода.

Лучше всего это понять на примере:
'''textalign = 1'''
'''pln''' текст выравнивается влево
'''textalign = 2'''
'''pln''' текст выравнивается вправо
'''textalign = 3'''
'''pln''' текст выравнивается по центру

''; Главное теперь не забыть, поменять переменную обратно на '''1''', если вы не хотите, чтобы текст всей игры был выравнен по центру.''

===Цвет===

Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате '''0xAARRGGBB'''. То есть четыре составляющих: альфа, красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.

Встроенная функция '''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255''' (т.е. полностью видимый цвет).

Пример:
'''proc''' _color(x+15, 10, 255, 60)
'''textcolor = _result'''

===Шрифт===

Для определения шрифта, которым будет выводиться текст, используется переменная '''textfont'''. В нее в виде строкового значения следует записать имя файла шрифта.

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

'''FireURQ''' имеет встроенные шрифты с засечками (serif) и без засечек (sans) во всех начертаниях — полужирном (bold), наклонном (italic) и полужирном наклонном (bold-italic).

Чтобы использовать эти шрифты в игре, достаточно написать '''textfont = «serif-italic[25]»''' и у вас будет наклонный шрифт 25-го размера с засечками.

Формат использования шрифта такой:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]'''

*'''size''' – размер шрифта(по умолчанию '''19'''), а точнее высота строки в пикселях
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')

Допустим, мы хотим вывести текст шрифтом Georgia.

Для этого пишем:
'''textfont = "georgia.ttf"'''
И сразу же проверяем результат, при помощи оператора вывода текста '''pln''', который мы уже освоили в совершенстве:
'''pln Крокодил зарылся в ил, крокодила ил манил'''

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

Меняем размер на 42:
'''textfont = "georgia.ttf[42]"'''

Остальные параметры команды нужны, чтобы текст, который будет выведен на экран выглядел еще более красиво (например, при стандартных параметрах текст может выглядеть не слишком хорошо на светлом фоне). В параметре '''bgcolor''', конечно, лучше задать цвет фона, на котором будет выведен текст. Другие параметры подбираются скорее на глаз, чем по науке.

Примеры:
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

Чтобы, после манипуляций с текстом, вернуться к шрифту по умолчанию, следует выполнить:
'''textfont = "_sysfont"'''

'''FireURQ''' может использовать и растровые шрифты формата '''HGE Font''' (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат '''HGE Font''', входит в дистрибутив (папка '''fonted''').

Пример использования HGE шрифта
'''textfont = "myfont.fnt"'''

===Команда CLS===

Часто бывает так, что экран, на который уже выведен текст нужно очистить. Для того чтобы удалить весь текст, выведенный при помощи команд '''P''' и '''PLN''', существует команда '''CLS'''. У нее нет никаких параметров.

Пример:
'''pln Уйма текста.'''
'''cls'''

Результат:
 

===Другие способы вывода текста===

Иногда оказывается недостаточно команд, описанных выше. Например, вы хотите чтобы в верхнем правом углу экрана всегда отображалось количество очков, которые игрок заработал на протяжении игры. Или состояние здоровья персонажа. Или название комнаты, в которой он находится. Или все это одновременно в разных местах экрана. Тогда на помощь автору приходят текстовые [[декораторы]].

===Текст в заголовке===

Для того чтобы вывести название игры или другой текст в заголовок окна FURQ нужно поместить этот текст в системную текстовую переменную gametitle. Если переменная пуста, то в заголовке будет отображаться название файла игры.

Пример:
'''gametitle = “Крокодил”'''

Результат:

[[Изображение:Furq_titlebar.png]]

''; Иногда эту переменную удобно использовать при отладке игры, временно выводя в нее, к примеру, значения других переменных.''

= Переходы =

Любой текстовый квест можно разбить на локации с текстом и переходы между ними. Из каждой локации к другим локациям обычно ведет несколько переходов, которые обозначают некоторые альтернативные варианты действий. В этой главе мы рассмотрим способы, которыми URQL позволяет сделать переходы в игре.

==Переход по кнопкам (оператор BTN)==

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

Общее обозначение: btn <локация>, <надпись на кнопке>]

Где <локация> - имя метки, на которую будет совершен переход, <надпись на кнопке> - надпись на кнопке, которая отображается на экране. В случае если <надпись на кнопке> не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
'''btn лес,Войти в лес'''
Эта команда выведет на экран кнопку с текстом '''Войти в лес''', ведующую на локацию '''лес'''

'''''Примечание 1: пробелы до и после надписи на кнопке игнорируются.'''''

'''''Примечание 2: если локация не найдена, то кнопка выводится с пометкой // phantom.'''''

'''''Примечание 3: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

У кнопок есть так называемое "эхо". Это сообщение, выводящееся на экран о том, что вы перешли по кнопке. Чтобы оно не выводилось, следует использовать переменную '''hide_btn_echo'''. Если установить её в единицу, то сообщения показываться не будут.

'''''Пример:'''''
'''hide_btn_echo = 1'''

===Команда CLSB===

Бывает так, что нам не нужно очищать весь экран, а нужно стереть только кнопки действий. Для того чтобы удалить кнопки выведенные командой '''BTN''', существует команда '''CLSB'''. У нее нет никаких параметров.

Пример:
'''btn север, Идти на Север'''
'''clsb'''
'''btn юг, Идти на Юг'''

Результат (текст на выведенной кнопке):
'''Идти на Юг'''
 

===Оформление кнопок в Fireurq===

Оформление кнопок делается в файле skin.xml
Описание можно найти в статье [[FireURQ:Скины|FireURQ:Скины]].

==Переход по ссылке==

FireURQ позволяет использовать в тексте (и декораторах) ссылки.

'''''Формат ссылок:'''''
'''<nowiki>[[текст ссылки|название локации]]</nowiki>'''

'''''Пример:'''''
'''pln Вы стоите рядом с покосившимся <nowiki>[[домиком|домик_осмотреть]]</nowiki>. Вокруг раскинулись <nowiki>[[клумбы с аромантными цветами|клумбы_осмотреть]]</nowiki>.'''

Здесь '''домик_осмотреть''' и '''клумбы_осмотреть''' - названия локаций, на которые будут осуществляться переходы при нажатии на ссылку.

Цвет ссылок задаётся переменными linkcolor и linkhcolor. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши.

'''''Пример:'''''
'''linkcolor = 0xffffff'''
'''linkhcolor = 0x0000ff'''
В данном примере цвет ссылок в тексте будет белым, а при наведении станет синим.

Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

'''''Упрощенный формат вывода ссылок такой:'''''
'''<nowiki>[[текст ссылки]]</nowiki>'''

В данном случае ссылка будет вести на метку под названием "текст ссылки".

'''''Пример:'''''
'''pln На волнах раскачивается деревянная <nowiki>[[лодка]]</nowiki>.'''

Здесь, при клике на ссылку произойдет переход на метку "лодка".

'''''Замечание: не рекомендуется называть метки именами с пробелами, соответственно не стоит использовать ссылки типа <nowiki>[[деревянная лодка]]</nowiki>, которые ведут на локации с такими именами.'''''

У ссылок, как и у btn есть "эхо", то есть в окне игры пишется, что вы перешли по ссылке. Чтобы его отключить, следует использовать переменную '''hide_link_echo'''. Если установить её в 1, то "эхо" выводиться не будет.

'''''Пример:'''''
'''hide_link_echo = 1'''

'''''Примечание: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

==Переход по оператору GOTO==

'''''Синтаксис:'''''
'''GoTo Метка'''

После выполнения оператора '''goto''' происходит мгновенное перемещение на указанную метку. При наличии локации common (см. ниже) операторы на локации common при переходе по '''goto''' НЕ ВЫПОЛНЯЮТСЯ. Это сделано специально и умышленно - чтобы можно было делать переходы внутри локации.

Примечание: в случае не нахождения метки, goto просто игнорируется.

'''''Пример:'''''
'''goto лес'''
Этот код произведёт перемещение на локацию с названием ''''лес'''.

==Переход по оператору PROC==

'''''Синтаксис:'''''
'''Proc Метка'''

При вызове данного оператора происходит переход на указанную метку и выполнение программы, до встречи первого end, потом управление передается оператору, следующему непосредственно за '''proc''', откуда команда была вызвана. Допустима любая вложенность '''proc'''-вызовов (вплоть до использования рекурсии!).

Нормально обрабатываются последовательные переходы по '''proc''' - цепочка ведется до тех пор, пока не встретится первый end. При этом кнопки во всех пройденных локациях накапливаются(!), но при обнаружении end'а происходит не опрос пользователя, а возврат к предыдущему proc'у и так до самого начала цепочки.

'''''Пример:'''''
''':берег_реки'''
'''pln Вы стоите на берегу реки, позади вас Туманный лес.'''
'''proc лес'''
'''pln Отсюда только одна дорога - на запад.'''
'''end'''
''';----------'''
''':лес'''
'''pln Из леса на вас поглядывают волки.'''
'''end'''

При выполнении этот код выведет на экран следующее:

Вы стоите на берегу реки, позади вас Туманный лес.
Из леса на вас поглядывают волки.
Отсюда только одна дорога - на запад.

То есть, после выполнения по '''proc''' локации '''лес''', мы вернёмся в локацию '''берег_реки''' и продолжим с того места, на котором был вызов команды '''proc'''.

'''''Важно:''''' При наличии локации common (см. ниже) операторы на локации common при переходе по '''proc''' НЕ ВЫПОЛНЯЮТСЯ и системная переменная '''current_loc''' не меняется.

'''Примечание:''' Часто из метки вызванной с помощью '''proc''' ведёт вызов '''goto''' и далее. В таком случае, если мы не хотим возврата к первой локации, нужно использовать оператор '''forget_procs'''

==Переход по декораторам TEXTBUTTON и IMGBUTTON==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Декораторы'''.

==Контекстное меню==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Выпадающие меню'''.

==Параметры при переходах==

Локальные параметры при переходах возможно передать параметры.

Общее обозначение: <метка>(param1, param2, ...)

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные <метка>_1, <метка>_2 и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).

Важное замечание: при использовании параметров в операторе btn подстановки (#...$ и #%...$) раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.

'''''Пример:'''''
'''btn лес(1,"опушка"),Войти в лес'''
На локации '''лес''', переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''

то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''

Параметры при переходах очень удобны для организации проверок внутри локации.

'''''Замечание:''''' Если вы передаёте параметры метке, то её название не должно начинаться с цифры, то есть исключены названия вроде '''25''' или '''40метро'''. Если вы хотите использовать цифры в названии, то ставьте их после букв, к примеру - '''метро40'''.

= Музыка и звук =

В '''FURQ''' есть целый ряд команд для воспроизведения аудио. Оно может быть всевозможных форматов: WAV, AIFF, MP3, MP2, MP1, OGG, MIDXM, IT, S3M, MOD, MTM, UMX. Есть возможность тонкого регулирования громкости звука.

Для начала запасемся на ресурсах, где свободно распространяют звуки (например, www.freesound.org) или запишем сами материала для проигрывания.

==Play==

Команда '''Play''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''play [loop|stop] [<имя файла>[, <громкость>]]'''

Чтобы просто запустить звук на проигрывание с помощью play напишите после команды имя файла. Например, нужно проиграть некий звук крокодила ''alligator.ogg''. Для этого пишем:
'''play alligator.ogg'''

Если файл alligator.ogg лежит рядом с файлом игры, то мы услышим нечто. Но если мы для удобства положим все звуки в отдельную папку sounds, то придется написать так:
'''play sounds/alligator.ogg'''

В нашем примере звук крокодила будет звучать всего один раз, однако, при помощи параметра '''loop''' мы сможем заставить крокодила двигаться и звучать бесконечно:
'''play loop sounds/alligator.ogg'''

Теперь звук будет повторяться снова и снова. Остановить его сможет только параметр '''stop''':
'''play stop sounds/alligator.ogg'''

При помощи '''Play''' можно одновременно проигрывать несколько звуков. Кроме того, можно регулировать громкость звука, добавив к команде play через запятую значение от '''0''' (полная тишина) до '''255''' (максимальная громкость). По умолчанию, '''play''' играет аудио с максимальной громкостью.

К примеру, мы хотим, одновременно наслаждаться звуком крокодила и чмоканием болота, но так, чтобы крокодил был слышен громче:
'''play loop sounds/alligator.ogg'''
'''play loop sounds/swamp.wav, 100'''

Чтобы остановить сразу все звуки, запущенные командой '''play''', мы применим такую на первый взгляд абсурдную команду как:
'''play stop'''

''; Важно помнить, что звуки запущенные на одной локации через '''play''' с параметром '''loop''' без новой команды с параметром '''stop''' сами собой не прекратятся, даже если вы перешли на другую локацию. И если вы вдруг оттуда вернетесь на прежнюю локацию, то те же самые звуки запустятся еще раз. Добро пожаловать в какафонию.''

==Voice==

Команда '''Voice''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''voice <имя файла>'''
'''voice stop'''

Команда предназначена специально для озвучивания игры голосом. Например, ей удобно запускать записи реплик персонажей или рассказчика. Во многом она аналогична команде '''play''', но с несколькими важными особенностями:
Проигрывать можно только одну реплику/звук одновременно(запуск другой озвучки через команду voice останавливает предыдущую).

Переход на другую локацию по кнопке ('''btn''') останавливает озвучку.

Громкость здесь регулируется числовой переменной '''voice_volume''' (от '''0''' до '''255''').

Остановить проигрывание файла можно при помощи команды '''voice stop'''.

Если вам необходимо чтобы прозвучало несколько реплик на одной локации, то достаточно удобно использовать команду voice в связке с командой '''anykey'''. Прослушав реплику, игрок будет нажимать на любую клавишу и слушать следующую.

Например:

'''voice_volume=200'''
'''pln - Еще раз здравствуй. - сказал крокодил и придвинулся поближе.'''
'''voice sounds/helloagain.ogg'''
'''anykey'''
'''pln Вам стало не по себе.'''
'''voice sounds/SCREAM.wav'''

==Music==

Кроме форматов аудиофайлов, которые воспроизводят команды '''play''' и '''voice''', команда '''music''' проигрывает еще и трекерную музыку (XM, IT, S3M, MOD, MTM, UMX), MIDI-файлы (MID) и MO3.

Формат команды:
'''music <имя файла>|stop[, <время в миллисекундах>]'''

Зацикливание проигрывания устанавливается в переменной music_looped ('''0''' - играть один раз, '''1''' - играть бесконечно). По умолчанию, вот отличие от команд '''play''' и '''voice''', здесь музыка зациклена.

''; некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.

''Громкость воспроизведения регулируется переменной music_volume (от '''0''' до '''255''').

С помощью команды '''music''' можно проигрывать только один файл одновременно, однако, можно задавать время, в течении которого громкость следующего аудиофайла будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект '''crossfade''' – старый трек будет угасать, а новый – нарастать по громкости.

Так “'''music stop'''” останавливает воспроизведение музыки. А если указать в качестве параметра время, то воспроизведение остановится через заданный промежуток.
'''music stop, 1500 ''; остановить музыку через 1,5 секунды'''''

===fademusic===

С помощью команды '''fademusic''' можно добиться плавного и красивого изменения громкости музыки.
Формат команды:
'''fademusic <громкость>, <время в миллисекундах>'''
громкость – целевая громкость музыки.

время в миллисекундах – время, в течении которого громкость достигнет целевого значения.

Предположим, что мы хотим сделать красивое и удобное включение и выключение музыки в нашей игре. Для этого используем [[инвентарь]] '''URQ'''. Игрок в любой момент сможет через пункт меню инвентаря включить и выключить музыку, а мы постараемся, чтобы это было плавно. На самом деле выключать музыку совсем мы не будем, а будем только понижать громкость до нуля, но зато нам не придется задаваться вопросом какой именно файл запускать при включении музыки.

В начале игры создадим элемент инвентаря “музыка” и присвоим ему наклейку “выключить музыку”:
'''inv+ музыка'''
'''idisp_музыка = "выключить музыку"'''
Запускаем любую музыку, в любом месте игры:
'''music music\Joe Hisaishi - Пылью на твоих руках.mp3'''
Теперь, в локации, которая отвечает за наш элемент инвентаря “музыка” используем оператор '''fademusic''':
''':Use_музыка'''
'''if idisp_музыка == "включить музыку" then idisp_музыка = "выключить музыку" & fademusic 255, 1500 else idisp_музыка = "включить музыку" & fademusic 0, 1500'''
'''end'''
Теперь по нажатию на “выключить музыку” громкость будет плавно затихать до нуля за 1,5 секунды, а по нажатию на “включить музыку” - так же плавно возрастать.

=Функции=

==Случайное значение Rnd==

Иногда полезно - особенно, если не злоупотреблять этим, ввести в квест элемент случайности, непредсказуемости. Именно для этого был введен механизм случайности: Rnd[x] - системная переменная (только для чтения) которая при пустом значении x хранит в себе случайное значение от 0 до 1, включая 1, а при целом x (к примеру, X=6) выдает выдает целые значения (от 1 до 6 включительно в нашем случае). При каждом обращении к переменной она принимает другое значение.

'''случай1 = rnd''' ;В результате переменная случай1 равна, например, 0.78

'''случай2 = rnd4''' ;В результате переменная случай2 равна, например, 3

==Ввод текста INPUT==

В урке есть возможность ввести строку, значение которой будет потом присвоено указанной переменной.

При необходимости ввести с клавиатуры русский текст через оператор '''input''' в строковую переменную ее следует предварительно объявить выражением:
'''строка = ""'''; Данное выражение создает строковую переменную нулевой длины.

'''pln Введите строку: & input строка'''

На экране мы увидим:
'''Введите строку:'''

==Команда forget_procs==

В URQL есть нюанс - если мы используем '''goto метка''' из локации вызванной по '''proc''', то история вызовов не забывается.
Но есть команда '''forget_procs''', которая позволяет это исправить.

Рассмотрим следующий код:

''':пример
pln Выводим текст 1
proc выход1
pln Выводим текст 2
end

:выход1
goto выход2
end

:выход2
forget_procs ; вставляем для того, чтобы забыть предыдущие действия
pln Выводим текст 3
pln Выводим текст 4
end'''

Без команды '''forget_procs''' мы увидим на экране

'''Выводим текст 1
Выводим текст 3
Выводим текст 4
Выводим текст 2'''

Если же мы используем эту команду, то на экране появится:

'''Выводим текст 1
Выводим текст 3
Выводим текст 4'''

что чаще всего и нужно.

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

FireURQ:Руководство пользователя

2017-07-05T12:50:00Z

Ajenta: /* Команда forget_procs */

=Метки=

Метка - одно из важнейших понятий URQL. Она служит для выделения места в квесте, куда затем предстоит перейти. Любые перемещения в квесте могут быть либо на следующий оператор, либо на метку. Все метки имеют имена, чтобы потом можно было указывать, куда вы хотите перейти.
Определяется метка при помощи двоеточия. Все, что правее этого символа, до разделителя, которым является символ конец абзаца (Enter) или '&' - имя метки:

''':Имя_метки'''

Метка и следующий за ней оператор end являются принятой единицей измерения игры - локацией. Между ними обычно пишется описание локации и переходы из неё в другие локации.

''':начало'''
'''end'''

Например, допустимыми именами меток являются:

''':1'''
''':01'''
''':а'''
''':кот1'''
''':@(a)%^Очень_Длинная_и_Запутанная_метка_какими-лучше-не-пользоваться!!!!!_horror_так_как_сами_потом_забудете_как_она_называется!Или_сделаете_ошибку!'''
'''Вы_же_можете_сделать_маленькую_ошибку_в таком_длинном_названии?'''
''':house_flat1'''

'''''Примечание:''''' метка должна начинаться с начала строки и отделяться от других операторов (Enter) или '&', регистр имени метки не важен.

:BIG
:bIG
:Big
:big
- все эти метки для интерпретатора совершенно одинаковы. Но лучше, в целях собственного удобства, придерживаться единого стиля.

В метке лучше не делать пробелов. Длина метки не ограничена, но для удобства автора квеста лучше не делать меток длиннее строки. В метке допускаются символы, обозначающие буквы русского и латинского алфавита, цифры, знак подчеркивания и знаки арифметических операций + и - (лучше не злоупотреблять странными названиями).

Недопустимы символы ''';''' '''/*''' '''*/''' '''&'''

Грамотное использование имен меток способно серьезно облегчить работу автора.

=Текст=
==Вывод текста==

Поскольку мы имеем дело с текстовыми играми, важнейшим для нас является вывод текста. В FURQ существует несколько способов вывода текста.

===Текст на экране===

Простейший способ вывести текст это использовать команды '''P''' и '''PLN'''. Советую освоить их, прежде чем переходить к другим способам вывода.

Формат команд:
'''p''' [текст]
'''pln''' [текст]

Регистр команд не имеет значения ('''pLn''' = '''PLN''' = '''Pln''').

На практике это выглядит так:
'''p''' Этот текст появится на экране.
или
'''pln''' Этот текст тоже появится на экране.

Каждая последующая команда '''P''' или '''PLN''' дописывает новый текст к тексту который уже есть на экране. Когда текста становится слишком много, появляется возможность его прокрутить.

Разница этих двух команд в следующем - '''P''' просто добавляет новый текст, а '''PLN''' добавляет текст и делает переход на новую строку (создает абзац).

Например:
'''p''' А
'''p''' Б

Выдаст “АБ”, тогда как

'''pln''' А
'''pln''' Б

Выдаст:
А
Б

Чаще всего пользуются командой '''pln''', однако и '''p''' может быть полезна, например, когда строчка текста, которую мы хотим вывести на экран, состоит из нескольких частей и зависит от каких-либо переменных или условий.

Команды '''P''' и '''PLN''' могут напрямую выводить любые символы (кроме символа комментария '''“;”'''), переменные и ссылки.

===Вывод переменных===

Вывод переменных возможен в двух вариантах - числовом и текстовом. Для того чтобы их вывести, нужно заключить имена переменных в соответствующие скобки:
'''pln''' '''#%'''имя_текстовой_переменной'''$''' '''#'''имя_числовой_переменной'''$'''
Несмотря на внешнее сходство, они отличаются содержанием и символом '''%'''. Если в числовые скобки попадет текстовая переменная, то на выводе окажется не текст, а количество символов в этой переменной. И наоборот, если числовая переменная попадет в текстовые скобки, то на выводе окажется пустота.

Выведем оба типа переменных на экран:

'''текстовая_переменная="Геннадий"'''
'''числовая_переменная=42'''
'''pln''' Крокодил схватил вас за ногу и сказал:
'''pln''' - Меня зовут '''#%текстовая_переменная$'''.
'''pln''' Затем крокодил схватил вас за другую ногу и сказал:
'''pln''' - Мне '''#числовая_переменная$''' года. Давай, ты станешь моим близким другом.

Результат:
Крокодил схватил вас за ногу и сказал:
- Меня зовут Геннадий.
Затем крокодил схватил вас за другую ногу и сказал:
- Мне 42 года. Давай, ты станешь моим близким другом.

Кроме того, в '''URQL''' есть специальные обозначения для вывода символа пробела - '''#$''', вывода символа переноса строки - '''#/$''' и вывода символа по ascii-коду - '''##'''ascii-код'''$'''.

Так, например, символ комментария можно вывести на экран, через его ascii-код:
'''pln''' Моя грамотность была на исходе'''##59$''' но, несмотря на это, я поставил точку с запятой в предложении.

Результат:
Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.

Хочу напомнить, что если бы мы написали в коде просто:
'''pln''' Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.
То получили бы на экране:
Моя грамотность была на исходе
Потому что символ ";" и все что после него идет было бы обработано как комментарий.

'''Примечание:'''
Вывод строковой переменной, как числа '''#текстовая_переменная$''' даст нам количество символов в строке.

==Оформление текста==

В 21 веке в '''FURQ''' текст это не просто набор символов, но еще и набор гарнитур, цвет, выравнивание и местоположение.

===Местоположение===
Область экрана, куда выводят текст команды '''p''' и '''pln''' можно двигать, делать шире, уже, выше и т.д. Для этого служат системные переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height''', которые описывают некий прямоугольник куда и выводится текст. По умолчанию он занимает почти весь экран. Это числовые переменные, которые содержат значения в пикселях.

Давайте, используя полученные нами знания, выведем значения этих переменных на экран:
'''pln''' Левая граница='''#textpane_left$''', Верхняя граница='''#textpane_top$''', Ширина='''#textpane_width$''', Высота='''#textpane_height$'''

Результат:
Левая граница=20, Верхняя граница=55, Ширина=760, Высота=525

Вы можете изменять значения этих переменных как угодно в любом месте игры. Например, вы хотите вывести справа от текста картинку: измените ширину ('''textpane_width''') так чтобы текст не мешал. А когда картинка больше не нужна измените ширину обратно. Экспериментируйте.

===Выравнивание текста===

За выравнивание текста отвечает команда числовая системная переменная textalign. Она сообщает FURQ как должен быть расположен текст относительно области его вывода.

Лучше всего это понять на примере:
'''textalign = 1'''
'''pln''' текст выравнивается влево
'''textalign = 2'''
'''pln''' текст выравнивается вправо
'''textalign = 3'''
'''pln''' текст выравнивается по центру

''; Главное теперь не забыть, поменять переменную обратно на '''1''', если вы не хотите, чтобы текст всей игры был выравнен по центру.''

===Цвет===

Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате '''0xAARRGGBB'''. То есть четыре составляющих: альфа, красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.

Встроенная функция '''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255''' (т.е. полностью видимый цвет).

Пример:
'''proc''' _color(x+15, 10, 255, 60)
'''textcolor = _result'''

===Шрифт===

Для определения шрифта, которым будет выводиться текст, используется переменная '''textfont'''. В нее в виде строкового значения следует записать имя файла шрифта.

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

'''FireURQ''' имеет встроенные шрифты с засечками (serif) и без засечек (sans) во всех начертаниях — полужирном (bold), наклонном (italic) и полужирном наклонном (bold-italic).

Чтобы использовать эти шрифты в игре, достаточно написать '''textfont = «serif-italic[25]»''' и у вас будет наклонный шрифт 25-го размера с засечками.

Формат использования шрифта такой:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]'''

*'''size''' – размер шрифта(по умолчанию '''19'''), а точнее высота строки в пикселях
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')

Допустим, мы хотим вывести текст шрифтом Georgia.

Для этого пишем:
'''textfont = "georgia.ttf"'''
И сразу же проверяем результат, при помощи оператора вывода текста '''pln''', который мы уже освоили в совершенстве:
'''pln Крокодил зарылся в ил, крокодила ил манил'''

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

Меняем размер на 42:
'''textfont = "georgia.ttf[42]"'''

Остальные параметры команды нужны, чтобы текст, который будет выведен на экран выглядел еще более красиво (например, при стандартных параметрах текст может выглядеть не слишком хорошо на светлом фоне). В параметре '''bgcolor''', конечно, лучше задать цвет фона, на котором будет выведен текст. Другие параметры подбираются скорее на глаз, чем по науке.

Примеры:
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

Чтобы, после манипуляций с текстом, вернуться к шрифту по умолчанию, следует выполнить:
'''textfont = "_sysfont"'''

'''FireURQ''' может использовать и растровые шрифты формата '''HGE Font''' (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат '''HGE Font''', входит в дистрибутив (папка '''fonted''').

Пример использования HGE шрифта
'''textfont = "myfont.fnt"'''

===Команда CLS===

Часто бывает так, что экран, на который уже выведен текст нужно очистить. Для того чтобы удалить весь текст, выведенный при помощи команд '''P''' и '''PLN''', существует команда '''CLS'''. У нее нет никаких параметров.

Пример:
'''pln Уйма текста.'''
'''cls'''

Результат:
 

===Другие способы вывода текста===

Иногда оказывается недостаточно команд, описанных выше. Например, вы хотите чтобы в верхнем правом углу экрана всегда отображалось количество очков, которые игрок заработал на протяжении игры. Или состояние здоровья персонажа. Или название комнаты, в которой он находится. Или все это одновременно в разных местах экрана. Тогда на помощь автору приходят текстовые [[декораторы]].

===Текст в заголовке===

Для того чтобы вывести название игры или другой текст в заголовок окна FURQ нужно поместить этот текст в системную текстовую переменную gametitle. Если переменная пуста, то в заголовке будет отображаться название файла игры.

Пример:
'''gametitle = “Крокодил”'''

Результат:

[[Изображение:Furq_titlebar.png]]

''; Иногда эту переменную удобно использовать при отладке игры, временно выводя в нее, к примеру, значения других переменных.''

= Переходы =

Любой текстовый квест можно разбить на локации с текстом и переходы между ними. Из каждой локации к другим локациям обычно ведет несколько переходов, которые обозначают некоторые альтернативные варианты действий. В этой главе мы рассмотрим способы, которыми URQL позволяет сделать переходы в игре.

==Переход по кнопкам (оператор BTN)==

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

Общее обозначение: btn <локация>, <надпись на кнопке>]

Где <локация> - имя метки, на которую будет совершен переход, <надпись на кнопке> - надпись на кнопке, которая отображается на экране. В случае если <надпись на кнопке> не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
'''btn лес,Войти в лес'''
Эта команда выведет на экран кнопку с текстом '''Войти в лес''', ведующую на локацию '''лес'''

'''''Примечание 1: пробелы до и после надписи на кнопке игнорируются.'''''

'''''Примечание 2: если локация не найдена, то кнопка выводится с пометкой // phantom.'''''

'''''Примечание 3: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

У кнопок есть так называемое "эхо". Это сообщение, выводящееся на экран о том, что вы перешли по кнопке. Чтобы оно не выводилось, следует использовать переменную '''hide_btn_echo'''. Если установить её в единицу, то сообщения показываться не будут.

'''''Пример:'''''
'''hide_btn_echo = 1'''

===Команда CLSB===

Бывает так, что нам не нужно очищать весь экран, а нужно стереть только кнопки действий. Для того чтобы удалить кнопки выведенные командой '''BTN''', существует команда '''CLSB'''. У нее нет никаких параметров.

Пример:
'''btn север, Идти на Север'''
'''clsb'''
'''btn юг, Идти на Юг'''

Результат (текст на выведенной кнопке):
'''Идти на Юг'''
 

===Оформление кнопок в Fireurq===

Оформление кнопок делается в файле skin.xml
Описание можно найти в статье [[FireURQ:Скины|FireURQ:Скины]].

==Переход по ссылке==

FireURQ позволяет использовать в тексте (и декораторах) ссылки.

'''''Формат ссылок:'''''
'''<nowiki>[[текст ссылки|название локации]]</nowiki>'''

'''''Пример:'''''
'''pln Вы стоите рядом с покосившимся <nowiki>[[домиком|домик_осмотреть]]</nowiki>. Вокруг раскинулись <nowiki>[[клумбы с аромантными цветами|клумбы_осмотреть]]</nowiki>.'''

Здесь '''домик_осмотреть''' и '''клумбы_осмотреть''' - названия локаций, на которые будут осуществляться переходы при нажатии на ссылку.

Цвет ссылок задаётся переменными linkcolor и linkhcolor. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши.

'''''Пример:'''''
'''linkcolor = 0xffffff'''
'''linkhcolor = 0x0000ff'''
В данном примере цвет ссылок в тексте будет белым, а при наведении станет синим.

Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

'''''Упрощенный формат вывода ссылок такой:'''''
'''<nowiki>[[текст ссылки]]</nowiki>'''

В данном случае ссылка будет вести на метку под названием "текст ссылки".

'''''Пример:'''''
'''pln На волнах раскачивается деревянная <nowiki>[[лодка]]</nowiki>.'''

Здесь, при клике на ссылку произойдет переход на метку "лодка".

'''''Замечание: не рекомендуется называть метки именами с пробелами, соответственно не стоит использовать ссылки типа <nowiki>[[деревянная лодка]]</nowiki>, которые ведут на локации с такими именами.'''''

У ссылок, как и у btn есть "эхо", то есть в окне игры пишется, что вы перешли по ссылке. Чтобы его отключить, следует использовать переменную '''hide_link_echo'''. Если установить её в 1, то "эхо" выводиться не будет.

'''''Пример:'''''
'''hide_link_echo = 1'''

'''''Примечание: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

==Переход по оператору GOTO==

'''''Синтаксис:'''''
'''GoTo Метка'''

После выполнения оператора '''goto''' происходит мгновенное перемещение на указанную метку. При наличии локации common (см. ниже) операторы на локации common при переходе по '''goto''' НЕ ВЫПОЛНЯЮТСЯ. Это сделано специально и умышленно - чтобы можно было делать переходы внутри локации.

Примечание: в случае не нахождения метки, goto просто игнорируется.

'''''Пример:'''''
'''goto лес'''
Этот код произведёт перемещение на локацию с названием ''''лес'''.

==Переход по оператору PROC==

'''''Синтаксис:'''''
'''Proc Метка'''

При вызове данного оператора происходит переход на указанную метку и выполнение программы, до встречи первого end, потом управление передается оператору, следующему непосредственно за '''proc''', откуда команда была вызвана. Допустима любая вложенность '''proc'''-вызовов (вплоть до использования рекурсии!).

Нормально обрабатываются последовательные переходы по '''proc''' - цепочка ведется до тех пор, пока не встретится первый end. При этом кнопки во всех пройденных локациях накапливаются(!), но при обнаружении end'а происходит не опрос пользователя, а возврат к предыдущему proc'у и так до самого начала цепочки.

'''''Пример:'''''
''':берег_реки'''
'''pln Вы стоите на берегу реки, позади вас Туманный лес.'''
'''proc лес'''
'''pln Отсюда только одна дорога - на запад.'''
'''end'''
''';----------'''
''':лес'''
'''pln Из леса на вас поглядывают волки.'''
'''end'''

При выполнении этот код выведет на экран следующее:

Вы стоите на берегу реки, позади вас Туманный лес.
Из леса на вас поглядывают волки.
Отсюда только одна дорога - на запад.

То есть, после выполнения по '''proc''' локации '''лес''', мы вернёмся в локацию '''берег_реки''' и продолжим с того места, на котором был вызов команды '''proc'''.

'''''Важно:''''' При наличии локации common (см. ниже) операторы на локации common при переходе по '''proc''' НЕ ВЫПОЛНЯЮТСЯ и системная переменная '''current_loc''' не меняется.

'''Примечание:''' Часто из метки вызванной с помощью '''proc''' ведёт вызов '''goto''' и далее. В таком случае, если мы не хотим возврата к первой локации, нужно использовать оператор '''forget_procs'''

==Переход по декораторам TEXTBUTTON и IMGBUTTON==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Декораторы'''.

==Контекстное меню==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Выпадающие меню'''.

==Параметры при переходах==

Локальные параметры при переходах возможно передать параметры.

Общее обозначение: <метка>(param1, param2, ...)

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные <метка>_1, <метка>_2 и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).

Важное замечание: при использовании параметров в операторе btn подстановки (#...$ и #%...$) раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.

'''''Пример:'''''
'''btn лес(1,"опушка"),Войти в лес'''
На локации '''лес''', переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''

то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''

Параметры при переходах очень удобны для организации проверок внутри локации.

'''''Замечание:''''' Если вы передаёте параметры метке, то её название не должно начинаться с цифры, то есть исключены названия вроде '''25''' или '''40метро'''. Если вы хотите использовать цифры в названии, то ставьте их после букв, к примеру - '''метро40'''.

= Музыка и звук =

В '''FURQ''' есть целый ряд команд для воспроизведения аудио. Оно может быть всевозможных форматов: WAV, AIFF, MP3, MP2, MP1, OGG, MIDXM, IT, S3M, MOD, MTM, UMX. Есть возможность тонкого регулирования громкости звука.

Для начала запасемся на ресурсах, где свободно распространяют звуки (например, www.freesound.org) или запишем сами материала для проигрывания.

==Play==

Команда '''Play''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''play [loop|stop] [<имя файла>[, <громкость>]]'''

Чтобы просто запустить звук на проигрывание с помощью play напишите после команды имя файла. Например, нужно проиграть некий звук крокодила ''alligator.ogg''. Для этого пишем:
'''play alligator.ogg'''

Если файл alligator.ogg лежит рядом с файлом игры, то мы услышим нечто. Но если мы для удобства положим все звуки в отдельную папку sounds, то придется написать так:
'''play sounds/alligator.ogg'''

В нашем примере звук крокодила будет звучать всего один раз, однако, при помощи параметра '''loop''' мы сможем заставить крокодила двигаться и звучать бесконечно:
'''play loop sounds/alligator.ogg'''

Теперь звук будет повторяться снова и снова. Остановить его сможет только параметр '''stop''':
'''play stop sounds/alligator.ogg'''

При помощи '''Play''' можно одновременно проигрывать несколько звуков. Кроме того, можно регулировать громкость звука, добавив к команде play через запятую значение от '''0''' (полная тишина) до '''255''' (максимальная громкость). По умолчанию, '''play''' играет аудио с максимальной громкостью.

К примеру, мы хотим, одновременно наслаждаться звуком крокодила и чмоканием болота, но так, чтобы крокодил был слышен громче:
'''play loop sounds/alligator.ogg'''
'''play loop sounds/swamp.wav, 100'''

Чтобы остановить сразу все звуки, запущенные командой '''play''', мы применим такую на первый взгляд абсурдную команду как:
'''play stop'''

''; Важно помнить, что звуки запущенные на одной локации через '''play''' с параметром '''loop''' без новой команды с параметром '''stop''' сами собой не прекратятся, даже если вы перешли на другую локацию. И если вы вдруг оттуда вернетесь на прежнюю локацию, то те же самые звуки запустятся еще раз. Добро пожаловать в какафонию.''

==Voice==

Команда '''Voice''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''voice <имя файла>'''
'''voice stop'''

Команда предназначена специально для озвучивания игры голосом. Например, ей удобно запускать записи реплик персонажей или рассказчика. Во многом она аналогична команде '''play''', но с несколькими важными особенностями:
Проигрывать можно только одну реплику/звук одновременно(запуск другой озвучки через команду voice останавливает предыдущую).

Переход на другую локацию по кнопке ('''btn''') останавливает озвучку.

Громкость здесь регулируется числовой переменной '''voice_volume''' (от '''0''' до '''255''').

Остановить проигрывание файла можно при помощи команды '''voice stop'''.

Если вам необходимо чтобы прозвучало несколько реплик на одной локации, то достаточно удобно использовать команду voice в связке с командой '''anykey'''. Прослушав реплику, игрок будет нажимать на любую клавишу и слушать следующую.

Например:

'''voice_volume=200'''
'''pln - Еще раз здравствуй. - сказал крокодил и придвинулся поближе.'''
'''voice sounds/helloagain.ogg'''
'''anykey'''
'''pln Вам стало не по себе.'''
'''voice sounds/SCREAM.wav'''

==Music==

Кроме форматов аудиофайлов, которые воспроизводят команды '''play''' и '''voice''', команда '''music''' проигрывает еще и трекерную музыку (XM, IT, S3M, MOD, MTM, UMX), MIDI-файлы (MID) и MO3.

Формат команды:
'''music <имя файла>|stop[, <время в миллисекундах>]'''

Зацикливание проигрывания устанавливается в переменной music_looped ('''0''' - играть один раз, '''1''' - играть бесконечно). По умолчанию, вот отличие от команд '''play''' и '''voice''', здесь музыка зациклена.

''; некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.

''Громкость воспроизведения регулируется переменной music_volume (от '''0''' до '''255''').

С помощью команды '''music''' можно проигрывать только один файл одновременно, однако, можно задавать время, в течении которого громкость следующего аудиофайла будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект '''crossfade''' – старый трек будет угасать, а новый – нарастать по громкости.

Так “'''music stop'''” останавливает воспроизведение музыки. А если указать в качестве параметра время, то воспроизведение остановится через заданный промежуток.
'''music stop, 1500 ''; остановить музыку через 1,5 секунды'''''

===fademusic===

С помощью команды '''fademusic''' можно добиться плавного и красивого изменения громкости музыки.
Формат команды:
'''fademusic <громкость>, <время в миллисекундах>'''
громкость – целевая громкость музыки.

время в миллисекундах – время, в течении которого громкость достигнет целевого значения.

Предположим, что мы хотим сделать красивое и удобное включение и выключение музыки в нашей игре. Для этого используем [[инвентарь]] '''URQ'''. Игрок в любой момент сможет через пункт меню инвентаря включить и выключить музыку, а мы постараемся, чтобы это было плавно. На самом деле выключать музыку совсем мы не будем, а будем только понижать громкость до нуля, но зато нам не придется задаваться вопросом какой именно файл запускать при включении музыки.

В начале игры создадим элемент инвентаря “музыка” и присвоим ему наклейку “выключить музыку”:
'''inv+ музыка'''
'''idisp_музыка = "выключить музыку"'''
Запускаем любую музыку, в любом месте игры:
'''music music\Joe Hisaishi - Пылью на твоих руках.mp3'''
Теперь, в локации, которая отвечает за наш элемент инвентаря “музыка” используем оператор '''fademusic''':
''':Use_музыка'''
'''if idisp_музыка == "включить музыку" then idisp_музыка = "выключить музыку" & fademusic 255, 1500 else idisp_музыка = "включить музыку" & fademusic 0, 1500'''
'''end'''
Теперь по нажатию на “выключить музыку” громкость будет плавно затихать до нуля за 1,5 секунды, а по нажатию на “включить музыку” - так же плавно возрастать.

=Функции=

==Случайное значение Rnd==

Иногда полезно - особенно, если не злоупотреблять этим, ввести в квест элемент случайности, непредсказуемости. Именно для этого был введен механизм случайности: Rnd[x] - системная переменная (только для чтения) которая при пустом значении x хранит в себе случайное значение от 0 до 1, включая 1, а при целом x (к примеру, X=6) выдает выдает целые значения (от 1 до 6 включительно в нашем случае). При каждом обращении к переменной она принимает другое значение.

'''случай1 = rnd''' ;В результате переменная случай1 равна, например, 0.78

'''случай2 = rnd4''' ;В результате переменная случай2 равна, например, 3

==Ввод текста INPUT==

В урке есть возможность ввести строку, значение которой будет потом присвоено указанной переменной.

При необходимости ввести с клавиатуры русский текст через оператор '''input''' в строковую переменную ее следует предварительно объявить выражением:
'''строка = ""'''; Данное выражение создает строковую переменную нулевой длины.

'''pln Введите строку: & input строка'''

На экране мы увидим:
'''Введите строку:'''

==Команда forget_procs==

В URQL есть нюанс - если мы используем '''goto метка''' из локации вызванной по '''proc''', то история вызовов не забывается.
Но есть команда '''forget_procs''', которая позволяет это исправить.

''':пример
pln Выводим текст 1
proc выход1
pln Выводим текст 2
end

:выход1
goto выход2
end

:выход2
forget_procs ; вставляем для того, чтобы забыть предыдущие действия
pln Выводим текст 3
pln Выводим текст 4
end'''

Без команды '''forget_procs''' мы увидим на экране

'''Выводим текст 1
Выводим текст 3
Выводим текст 4
Выводим текст 2'''

Если же мы используем эту команду, то на экране появится:

'''Выводим текст 1
Выводим текст 3
Выводим текст 4'''

что чаще всего и нужно.

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

FireURQ:Руководство пользователя

2017-07-05T12:46:54Z

Ajenta:

=Метки=

Метка - одно из важнейших понятий URQL. Она служит для выделения места в квесте, куда затем предстоит перейти. Любые перемещения в квесте могут быть либо на следующий оператор, либо на метку. Все метки имеют имена, чтобы потом можно было указывать, куда вы хотите перейти.
Определяется метка при помощи двоеточия. Все, что правее этого символа, до разделителя, которым является символ конец абзаца (Enter) или '&' - имя метки:

''':Имя_метки'''

Метка и следующий за ней оператор end являются принятой единицей измерения игры - локацией. Между ними обычно пишется описание локации и переходы из неё в другие локации.

''':начало'''
'''end'''

Например, допустимыми именами меток являются:

''':1'''
''':01'''
''':а'''
''':кот1'''
''':@(a)%^Очень_Длинная_и_Запутанная_метка_какими-лучше-не-пользоваться!!!!!_horror_так_как_сами_потом_забудете_как_она_называется!Или_сделаете_ошибку!'''
'''Вы_же_можете_сделать_маленькую_ошибку_в таком_длинном_названии?'''
''':house_flat1'''

'''''Примечание:''''' метка должна начинаться с начала строки и отделяться от других операторов (Enter) или '&', регистр имени метки не важен.

:BIG
:bIG
:Big
:big
- все эти метки для интерпретатора совершенно одинаковы. Но лучше, в целях собственного удобства, придерживаться единого стиля.

В метке лучше не делать пробелов. Длина метки не ограничена, но для удобства автора квеста лучше не делать меток длиннее строки. В метке допускаются символы, обозначающие буквы русского и латинского алфавита, цифры, знак подчеркивания и знаки арифметических операций + и - (лучше не злоупотреблять странными названиями).

Недопустимы символы ''';''' '''/*''' '''*/''' '''&'''

Грамотное использование имен меток способно серьезно облегчить работу автора.

=Текст=
==Вывод текста==

Поскольку мы имеем дело с текстовыми играми, важнейшим для нас является вывод текста. В FURQ существует несколько способов вывода текста.

===Текст на экране===

Простейший способ вывести текст это использовать команды '''P''' и '''PLN'''. Советую освоить их, прежде чем переходить к другим способам вывода.

Формат команд:
'''p''' [текст]
'''pln''' [текст]

Регистр команд не имеет значения ('''pLn''' = '''PLN''' = '''Pln''').

На практике это выглядит так:
'''p''' Этот текст появится на экране.
или
'''pln''' Этот текст тоже появится на экране.

Каждая последующая команда '''P''' или '''PLN''' дописывает новый текст к тексту который уже есть на экране. Когда текста становится слишком много, появляется возможность его прокрутить.

Разница этих двух команд в следующем - '''P''' просто добавляет новый текст, а '''PLN''' добавляет текст и делает переход на новую строку (создает абзац).

Например:
'''p''' А
'''p''' Б

Выдаст “АБ”, тогда как

'''pln''' А
'''pln''' Б

Выдаст:
А
Б

Чаще всего пользуются командой '''pln''', однако и '''p''' может быть полезна, например, когда строчка текста, которую мы хотим вывести на экран, состоит из нескольких частей и зависит от каких-либо переменных или условий.

Команды '''P''' и '''PLN''' могут напрямую выводить любые символы (кроме символа комментария '''“;”'''), переменные и ссылки.

===Вывод переменных===

Вывод переменных возможен в двух вариантах - числовом и текстовом. Для того чтобы их вывести, нужно заключить имена переменных в соответствующие скобки:
'''pln''' '''#%'''имя_текстовой_переменной'''$''' '''#'''имя_числовой_переменной'''$'''
Несмотря на внешнее сходство, они отличаются содержанием и символом '''%'''. Если в числовые скобки попадет текстовая переменная, то на выводе окажется не текст, а количество символов в этой переменной. И наоборот, если числовая переменная попадет в текстовые скобки, то на выводе окажется пустота.

Выведем оба типа переменных на экран:

'''текстовая_переменная="Геннадий"'''
'''числовая_переменная=42'''
'''pln''' Крокодил схватил вас за ногу и сказал:
'''pln''' - Меня зовут '''#%текстовая_переменная$'''.
'''pln''' Затем крокодил схватил вас за другую ногу и сказал:
'''pln''' - Мне '''#числовая_переменная$''' года. Давай, ты станешь моим близким другом.

Результат:
Крокодил схватил вас за ногу и сказал:
- Меня зовут Геннадий.
Затем крокодил схватил вас за другую ногу и сказал:
- Мне 42 года. Давай, ты станешь моим близким другом.

Кроме того, в '''URQL''' есть специальные обозначения для вывода символа пробела - '''#$''', вывода символа переноса строки - '''#/$''' и вывода символа по ascii-коду - '''##'''ascii-код'''$'''.

Так, например, символ комментария можно вывести на экран, через его ascii-код:
'''pln''' Моя грамотность была на исходе'''##59$''' но, несмотря на это, я поставил точку с запятой в предложении.

Результат:
Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.

Хочу напомнить, что если бы мы написали в коде просто:
'''pln''' Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.
То получили бы на экране:
Моя грамотность была на исходе
Потому что символ ";" и все что после него идет было бы обработано как комментарий.

'''Примечание:'''
Вывод строковой переменной, как числа '''#текстовая_переменная$''' даст нам количество символов в строке.

==Оформление текста==

В 21 веке в '''FURQ''' текст это не просто набор символов, но еще и набор гарнитур, цвет, выравнивание и местоположение.

===Местоположение===
Область экрана, куда выводят текст команды '''p''' и '''pln''' можно двигать, делать шире, уже, выше и т.д. Для этого служат системные переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height''', которые описывают некий прямоугольник куда и выводится текст. По умолчанию он занимает почти весь экран. Это числовые переменные, которые содержат значения в пикселях.

Давайте, используя полученные нами знания, выведем значения этих переменных на экран:
'''pln''' Левая граница='''#textpane_left$''', Верхняя граница='''#textpane_top$''', Ширина='''#textpane_width$''', Высота='''#textpane_height$'''

Результат:
Левая граница=20, Верхняя граница=55, Ширина=760, Высота=525

Вы можете изменять значения этих переменных как угодно в любом месте игры. Например, вы хотите вывести справа от текста картинку: измените ширину ('''textpane_width''') так чтобы текст не мешал. А когда картинка больше не нужна измените ширину обратно. Экспериментируйте.

===Выравнивание текста===

За выравнивание текста отвечает команда числовая системная переменная textalign. Она сообщает FURQ как должен быть расположен текст относительно области его вывода.

Лучше всего это понять на примере:
'''textalign = 1'''
'''pln''' текст выравнивается влево
'''textalign = 2'''
'''pln''' текст выравнивается вправо
'''textalign = 3'''
'''pln''' текст выравнивается по центру

''; Главное теперь не забыть, поменять переменную обратно на '''1''', если вы не хотите, чтобы текст всей игры был выравнен по центру.''

===Цвет===

Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате '''0xAARRGGBB'''. То есть четыре составляющих: альфа, красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.

Встроенная функция '''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255''' (т.е. полностью видимый цвет).

Пример:
'''proc''' _color(x+15, 10, 255, 60)
'''textcolor = _result'''

===Шрифт===

Для определения шрифта, которым будет выводиться текст, используется переменная '''textfont'''. В нее в виде строкового значения следует записать имя файла шрифта.

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

'''FireURQ''' имеет встроенные шрифты с засечками (serif) и без засечек (sans) во всех начертаниях — полужирном (bold), наклонном (italic) и полужирном наклонном (bold-italic).

Чтобы использовать эти шрифты в игре, достаточно написать '''textfont = «serif-italic[25]»''' и у вас будет наклонный шрифт 25-го размера с засечками.

Формат использования шрифта такой:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]'''

*'''size''' – размер шрифта(по умолчанию '''19'''), а точнее высота строки в пикселях
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')

Допустим, мы хотим вывести текст шрифтом Georgia.

Для этого пишем:
'''textfont = "georgia.ttf"'''
И сразу же проверяем результат, при помощи оператора вывода текста '''pln''', который мы уже освоили в совершенстве:
'''pln Крокодил зарылся в ил, крокодила ил манил'''

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

Меняем размер на 42:
'''textfont = "georgia.ttf[42]"'''

Остальные параметры команды нужны, чтобы текст, который будет выведен на экран выглядел еще более красиво (например, при стандартных параметрах текст может выглядеть не слишком хорошо на светлом фоне). В параметре '''bgcolor''', конечно, лучше задать цвет фона, на котором будет выведен текст. Другие параметры подбираются скорее на глаз, чем по науке.

Примеры:
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

Чтобы, после манипуляций с текстом, вернуться к шрифту по умолчанию, следует выполнить:
'''textfont = "_sysfont"'''

'''FireURQ''' может использовать и растровые шрифты формата '''HGE Font''' (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат '''HGE Font''', входит в дистрибутив (папка '''fonted''').

Пример использования HGE шрифта
'''textfont = "myfont.fnt"'''

===Команда CLS===

Часто бывает так, что экран, на который уже выведен текст нужно очистить. Для того чтобы удалить весь текст, выведенный при помощи команд '''P''' и '''PLN''', существует команда '''CLS'''. У нее нет никаких параметров.

Пример:
'''pln Уйма текста.'''
'''cls'''

Результат:
 

===Другие способы вывода текста===

Иногда оказывается недостаточно команд, описанных выше. Например, вы хотите чтобы в верхнем правом углу экрана всегда отображалось количество очков, которые игрок заработал на протяжении игры. Или состояние здоровья персонажа. Или название комнаты, в которой он находится. Или все это одновременно в разных местах экрана. Тогда на помощь автору приходят текстовые [[декораторы]].

===Текст в заголовке===

Для того чтобы вывести название игры или другой текст в заголовок окна FURQ нужно поместить этот текст в системную текстовую переменную gametitle. Если переменная пуста, то в заголовке будет отображаться название файла игры.

Пример:
'''gametitle = “Крокодил”'''

Результат:

[[Изображение:Furq_titlebar.png]]

''; Иногда эту переменную удобно использовать при отладке игры, временно выводя в нее, к примеру, значения других переменных.''

= Переходы =

Любой текстовый квест можно разбить на локации с текстом и переходы между ними. Из каждой локации к другим локациям обычно ведет несколько переходов, которые обозначают некоторые альтернативные варианты действий. В этой главе мы рассмотрим способы, которыми URQL позволяет сделать переходы в игре.

==Переход по кнопкам (оператор BTN)==

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

Общее обозначение: btn <локация>, <надпись на кнопке>]

Где <локация> - имя метки, на которую будет совершен переход, <надпись на кнопке> - надпись на кнопке, которая отображается на экране. В случае если <надпись на кнопке> не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
'''btn лес,Войти в лес'''
Эта команда выведет на экран кнопку с текстом '''Войти в лес''', ведующую на локацию '''лес'''

'''''Примечание 1: пробелы до и после надписи на кнопке игнорируются.'''''

'''''Примечание 2: если локация не найдена, то кнопка выводится с пометкой // phantom.'''''

'''''Примечание 3: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

У кнопок есть так называемое "эхо". Это сообщение, выводящееся на экран о том, что вы перешли по кнопке. Чтобы оно не выводилось, следует использовать переменную '''hide_btn_echo'''. Если установить её в единицу, то сообщения показываться не будут.

'''''Пример:'''''
'''hide_btn_echo = 1'''

===Команда CLSB===

Бывает так, что нам не нужно очищать весь экран, а нужно стереть только кнопки действий. Для того чтобы удалить кнопки выведенные командой '''BTN''', существует команда '''CLSB'''. У нее нет никаких параметров.

Пример:
'''btn север, Идти на Север'''
'''clsb'''
'''btn юг, Идти на Юг'''

Результат (текст на выведенной кнопке):
'''Идти на Юг'''
 

===Оформление кнопок в Fireurq===

Оформление кнопок делается в файле skin.xml
Описание можно найти в статье [[FireURQ:Скины|FireURQ:Скины]].

==Переход по ссылке==

FireURQ позволяет использовать в тексте (и декораторах) ссылки.

'''''Формат ссылок:'''''
'''<nowiki>[[текст ссылки|название локации]]</nowiki>'''

'''''Пример:'''''
'''pln Вы стоите рядом с покосившимся <nowiki>[[домиком|домик_осмотреть]]</nowiki>. Вокруг раскинулись <nowiki>[[клумбы с аромантными цветами|клумбы_осмотреть]]</nowiki>.'''

Здесь '''домик_осмотреть''' и '''клумбы_осмотреть''' - названия локаций, на которые будут осуществляться переходы при нажатии на ссылку.

Цвет ссылок задаётся переменными linkcolor и linkhcolor. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши.

'''''Пример:'''''
'''linkcolor = 0xffffff'''
'''linkhcolor = 0x0000ff'''
В данном примере цвет ссылок в тексте будет белым, а при наведении станет синим.

Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

'''''Упрощенный формат вывода ссылок такой:'''''
'''<nowiki>[[текст ссылки]]</nowiki>'''

В данном случае ссылка будет вести на метку под названием "текст ссылки".

'''''Пример:'''''
'''pln На волнах раскачивается деревянная <nowiki>[[лодка]]</nowiki>.'''

Здесь, при клике на ссылку произойдет переход на метку "лодка".

'''''Замечание: не рекомендуется называть метки именами с пробелами, соответственно не стоит использовать ссылки типа <nowiki>[[деревянная лодка]]</nowiki>, которые ведут на локации с такими именами.'''''

У ссылок, как и у btn есть "эхо", то есть в окне игры пишется, что вы перешли по ссылке. Чтобы его отключить, следует использовать переменную '''hide_link_echo'''. Если установить её в 1, то "эхо" выводиться не будет.

'''''Пример:'''''
'''hide_link_echo = 1'''

'''''Примечание: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

==Переход по оператору GOTO==

'''''Синтаксис:'''''
'''GoTo Метка'''

После выполнения оператора '''goto''' происходит мгновенное перемещение на указанную метку. При наличии локации common (см. ниже) операторы на локации common при переходе по '''goto''' НЕ ВЫПОЛНЯЮТСЯ. Это сделано специально и умышленно - чтобы можно было делать переходы внутри локации.

Примечание: в случае не нахождения метки, goto просто игнорируется.

'''''Пример:'''''
'''goto лес'''
Этот код произведёт перемещение на локацию с названием ''''лес'''.

==Переход по оператору PROC==

'''''Синтаксис:'''''
'''Proc Метка'''

При вызове данного оператора происходит переход на указанную метку и выполнение программы, до встречи первого end, потом управление передается оператору, следующему непосредственно за '''proc''', откуда команда была вызвана. Допустима любая вложенность '''proc'''-вызовов (вплоть до использования рекурсии!).

Нормально обрабатываются последовательные переходы по '''proc''' - цепочка ведется до тех пор, пока не встретится первый end. При этом кнопки во всех пройденных локациях накапливаются(!), но при обнаружении end'а происходит не опрос пользователя, а возврат к предыдущему proc'у и так до самого начала цепочки.

'''''Пример:'''''
''':берег_реки'''
'''pln Вы стоите на берегу реки, позади вас Туманный лес.'''
'''proc лес'''
'''pln Отсюда только одна дорога - на запад.'''
'''end'''
''';----------'''
''':лес'''
'''pln Из леса на вас поглядывают волки.'''
'''end'''

При выполнении этот код выведет на экран следующее:

Вы стоите на берегу реки, позади вас Туманный лес.
Из леса на вас поглядывают волки.
Отсюда только одна дорога - на запад.

То есть, после выполнения по '''proc''' локации '''лес''', мы вернёмся в локацию '''берег_реки''' и продолжим с того места, на котором был вызов команды '''proc'''.

'''''Важно:''''' При наличии локации common (см. ниже) операторы на локации common при переходе по '''proc''' НЕ ВЫПОЛНЯЮТСЯ и системная переменная '''current_loc''' не меняется.

'''Примечание:''' Часто из метки вызванной с помощью '''proc''' ведёт вызов '''goto''' и далее. В таком случае, если мы не хотим возврата к первой локации, нужно использовать оператор '''forget_procs'''

==Переход по декораторам TEXTBUTTON и IMGBUTTON==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Декораторы'''.

==Контекстное меню==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Выпадающие меню'''.

==Параметры при переходах==

Локальные параметры при переходах возможно передать параметры.

Общее обозначение: <метка>(param1, param2, ...)

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные <метка>_1, <метка>_2 и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).

Важное замечание: при использовании параметров в операторе btn подстановки (#...$ и #%...$) раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.

'''''Пример:'''''
'''btn лес(1,"опушка"),Войти в лес'''
На локации '''лес''', переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''

то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''

Параметры при переходах очень удобны для организации проверок внутри локации.

'''''Замечание:''''' Если вы передаёте параметры метке, то её название не должно начинаться с цифры, то есть исключены названия вроде '''25''' или '''40метро'''. Если вы хотите использовать цифры в названии, то ставьте их после букв, к примеру - '''метро40'''.

= Музыка и звук =

В '''FURQ''' есть целый ряд команд для воспроизведения аудио. Оно может быть всевозможных форматов: WAV, AIFF, MP3, MP2, MP1, OGG, MIDXM, IT, S3M, MOD, MTM, UMX. Есть возможность тонкого регулирования громкости звука.

Для начала запасемся на ресурсах, где свободно распространяют звуки (например, www.freesound.org) или запишем сами материала для проигрывания.

==Play==

Команда '''Play''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''play [loop|stop] [<имя файла>[, <громкость>]]'''

Чтобы просто запустить звук на проигрывание с помощью play напишите после команды имя файла. Например, нужно проиграть некий звук крокодила ''alligator.ogg''. Для этого пишем:
'''play alligator.ogg'''

Если файл alligator.ogg лежит рядом с файлом игры, то мы услышим нечто. Но если мы для удобства положим все звуки в отдельную папку sounds, то придется написать так:
'''play sounds/alligator.ogg'''

В нашем примере звук крокодила будет звучать всего один раз, однако, при помощи параметра '''loop''' мы сможем заставить крокодила двигаться и звучать бесконечно:
'''play loop sounds/alligator.ogg'''

Теперь звук будет повторяться снова и снова. Остановить его сможет только параметр '''stop''':
'''play stop sounds/alligator.ogg'''

При помощи '''Play''' можно одновременно проигрывать несколько звуков. Кроме того, можно регулировать громкость звука, добавив к команде play через запятую значение от '''0''' (полная тишина) до '''255''' (максимальная громкость). По умолчанию, '''play''' играет аудио с максимальной громкостью.

К примеру, мы хотим, одновременно наслаждаться звуком крокодила и чмоканием болота, но так, чтобы крокодил был слышен громче:
'''play loop sounds/alligator.ogg'''
'''play loop sounds/swamp.wav, 100'''

Чтобы остановить сразу все звуки, запущенные командой '''play''', мы применим такую на первый взгляд абсурдную команду как:
'''play stop'''

''; Важно помнить, что звуки запущенные на одной локации через '''play''' с параметром '''loop''' без новой команды с параметром '''stop''' сами собой не прекратятся, даже если вы перешли на другую локацию. И если вы вдруг оттуда вернетесь на прежнюю локацию, то те же самые звуки запустятся еще раз. Добро пожаловать в какафонию.''

==Voice==

Команда '''Voice''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''voice <имя файла>'''
'''voice stop'''

Команда предназначена специально для озвучивания игры голосом. Например, ей удобно запускать записи реплик персонажей или рассказчика. Во многом она аналогична команде '''play''', но с несколькими важными особенностями:
Проигрывать можно только одну реплику/звук одновременно(запуск другой озвучки через команду voice останавливает предыдущую).

Переход на другую локацию по кнопке ('''btn''') останавливает озвучку.

Громкость здесь регулируется числовой переменной '''voice_volume''' (от '''0''' до '''255''').

Остановить проигрывание файла можно при помощи команды '''voice stop'''.

Если вам необходимо чтобы прозвучало несколько реплик на одной локации, то достаточно удобно использовать команду voice в связке с командой '''anykey'''. Прослушав реплику, игрок будет нажимать на любую клавишу и слушать следующую.

Например:

'''voice_volume=200'''
'''pln - Еще раз здравствуй. - сказал крокодил и придвинулся поближе.'''
'''voice sounds/helloagain.ogg'''
'''anykey'''
'''pln Вам стало не по себе.'''
'''voice sounds/SCREAM.wav'''

==Music==

Кроме форматов аудиофайлов, которые воспроизводят команды '''play''' и '''voice''', команда '''music''' проигрывает еще и трекерную музыку (XM, IT, S3M, MOD, MTM, UMX), MIDI-файлы (MID) и MO3.

Формат команды:
'''music <имя файла>|stop[, <время в миллисекундах>]'''

Зацикливание проигрывания устанавливается в переменной music_looped ('''0''' - играть один раз, '''1''' - играть бесконечно). По умолчанию, вот отличие от команд '''play''' и '''voice''', здесь музыка зациклена.

''; некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.

''Громкость воспроизведения регулируется переменной music_volume (от '''0''' до '''255''').

С помощью команды '''music''' можно проигрывать только один файл одновременно, однако, можно задавать время, в течении которого громкость следующего аудиофайла будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект '''crossfade''' – старый трек будет угасать, а новый – нарастать по громкости.

Так “'''music stop'''” останавливает воспроизведение музыки. А если указать в качестве параметра время, то воспроизведение остановится через заданный промежуток.
'''music stop, 1500 ''; остановить музыку через 1,5 секунды'''''

===fademusic===

С помощью команды '''fademusic''' можно добиться плавного и красивого изменения громкости музыки.
Формат команды:
'''fademusic <громкость>, <время в миллисекундах>'''
громкость – целевая громкость музыки.

время в миллисекундах – время, в течении которого громкость достигнет целевого значения.

Предположим, что мы хотим сделать красивое и удобное включение и выключение музыки в нашей игре. Для этого используем [[инвентарь]] '''URQ'''. Игрок в любой момент сможет через пункт меню инвентаря включить и выключить музыку, а мы постараемся, чтобы это было плавно. На самом деле выключать музыку совсем мы не будем, а будем только понижать громкость до нуля, но зато нам не придется задаваться вопросом какой именно файл запускать при включении музыки.

В начале игры создадим элемент инвентаря “музыка” и присвоим ему наклейку “выключить музыку”:
'''inv+ музыка'''
'''idisp_музыка = "выключить музыку"'''
Запускаем любую музыку, в любом месте игры:
'''music music\Joe Hisaishi - Пылью на твоих руках.mp3'''
Теперь, в локации, которая отвечает за наш элемент инвентаря “музыка” используем оператор '''fademusic''':
''':Use_музыка'''
'''if idisp_музыка == "включить музыку" then idisp_музыка = "выключить музыку" & fademusic 255, 1500 else idisp_музыка = "включить музыку" & fademusic 0, 1500'''
'''end'''
Теперь по нажатию на “выключить музыку” громкость будет плавно затихать до нуля за 1,5 секунды, а по нажатию на “включить музыку” - так же плавно возрастать.

=Функции=

==Случайное значение Rnd==

Иногда полезно - особенно, если не злоупотреблять этим, ввести в квест элемент случайности, непредсказуемости. Именно для этого был введен механизм случайности: Rnd[x] - системная переменная (только для чтения) которая при пустом значении x хранит в себе случайное значение от 0 до 1, включая 1, а при целом x (к примеру, X=6) выдает выдает целые значения (от 1 до 6 включительно в нашем случае). При каждом обращении к переменной она принимает другое значение.

'''случай1 = rnd''' ;В результате переменная случай1 равна, например, 0.78

'''случай2 = rnd4''' ;В результате переменная случай2 равна, например, 3

==Ввод текста INPUT==

В урке есть возможность ввести строку, значение которой будет потом присвоено указанной переменной.

При необходимости ввести с клавиатуры русский текст через оператор '''input''' в строковую переменную ее следует предварительно объявить выражением:
'''строка = ""'''; Данное выражение создает строковую переменную нулевой длины.

'''pln Введите строку: & input строка'''

На экране мы увидим:
'''Введите строку:'''

==Команда forget_procs==

В URQL есть нюанс - если мы используем '''goto метка''' из локации вызванной по ''proc'', то история вызовов не забывается.
Но есть команда '''forget_procs''', которая позволяет это исправить.

''':пример
pln Выводим текст 1
proc выход1
pln Выводим текст 2
end

:выход1
goto выход2
end

:выход2
forget_procs ; вставляем для того, чтобы забыть предыдущие действия
pln Выводим текст 3
pln Выводим текст 4
end'''

Без команды '''forget_procs''' мы увидим на экране

'''Выводим текст 1
Выводим текст 3
Выводим текст 4
Выводим текст 2'''

Если же мы используем эту команду, то на экране появится:

'''Выводим текст 1
Выводим текст 3
Выводим текст 4'''

что чаще всего и нужно.

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

FireURQ:Особенности реализации URQL

2017-06-29T15:20:17Z

Ajenta: /* Загрузка игры через оператор LOAD */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль.
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительного команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, существует возможность конвертации квеста в формате QSZ в исполняемый файл. Для этого следует использовать утилиту '''QSZ2EXE''', которая входит в комплект поставки. Эта консольная утилита находится в папке на диске, которую вы выбрали при инсталляции '''FireURQ'''.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная '''save_success''' устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.

C версии '''FireURQ 2.2''' появилась возможность загружать сохранения непосредственно из слотов, не вызывая меню "Загрузить сохранение".

Если написать '''LOAD 1''', то будет загружено сохранение из первого слота. '''LOAD 0''' загрузит игру из слота автосохранения.

== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логии прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

FireURQ:Особенности реализации URQL

2017-06-29T15:19:54Z

Ajenta: /* Загрузка игры через оператор LOAD */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль.
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительного команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, существует возможность конвертации квеста в формате QSZ в исполняемый файл. Для этого следует использовать утилиту '''QSZ2EXE''', которая входит в комплект поставки. Эта консольная утилита находится в папке на диске, которую вы выбрали при инсталляции '''FireURQ'''.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная '''save_success''' устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.

C версии '''FireURQ 2.2''' появилась возможность загружать сохранения непосредственно из слотов, не вызывая меню "Загрузить сохранение"
Если написать '''LOAD 1''', то будет загружено сохранение из первого слота. '''LOAD 0''' загрузит игру из слота автосохранения.

== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логии прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

FireURQ:Особенности реализации URQL

2017-06-29T14:26:24Z

Ajenta: /* Сохранение игры и оператор SAVE */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль.
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительного команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, существует возможность конвертации квеста в формате QSZ в исполняемый файл. Для этого следует использовать утилиту '''QSZ2EXE''', которая входит в комплект поставки. Эта консольная утилита находится в папке на диске, которую вы выбрали при инсталляции '''FireURQ'''.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная '''save_success''' устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.
== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логии прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

FireURQ:Особенности реализации URQL

2017-06-29T14:25:54Z

Ajenta: /* Сохранение игры и оператор SAVE */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) должны лежать в папке игры (в архиве '''QSZ'''). Если их там нет, то игра возьмёт системный шрифт для текста по умолчанию.

Фурка носит с собой шрифты стандартных начертаний с засечками ('''serif''') и без засечек ('''sans''') трёх начертаний- обычной, полужирной ('''bold''') и наклонной ('''italic'''). Эти стандартные шрифты можно использовать, подставляя вместо имени файла TTF название, комбинирующее нужное начертание шрифта. Например,
'''textfont = "serif[35]"'''
это шрифт с засечками 35-го размера. А
'''textfont = "sans-bold-italic[18]"'''
это полужирный наклонный шрифт без засечек 18-го размера.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль.
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительного команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, существует возможность конвертации квеста в формате QSZ в исполняемый файл. Для этого следует использовать утилиту '''QSZ2EXE''', которая входит в комплект поставки. Эта консольная утилита находится в папке на диске, которую вы выбрали при инсталляции '''FireURQ'''.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

При сохранении игры командой SAVE переменная save_success устанавливается в 1 при успешном сохранении и в 0, если сохранение по каким-то причинам не удалось.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.
== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логии прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

FireURQ:Скины

2017-03-21T12:37:13Z

Ajenta: /* Интерфейс сохранения/загрузки. */

Скин игры - это такой файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста.
<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Изменение внешнего вида интерпретатора - это тема повышенной сложности. Поэтому, если вы сомневаетесь, нужны ли вам скины в вашей игре - они вам не нужны.
</div>

Кроме того, чтобы понимать, о чём будет идти речь в данном разделе, нужно хорошо представлять себе, что такое язык разметки XML.

==Общие сведения==

Файл описания скина представляет собой файл в формате XML с именем '''skin.xml''', лежащий в папке с игрой. Если ваша игра упакована в файл с расширением QSZ, то скин и все его ресурсы должны помещаться внутри архива.

Вот, для примера, как выглядит скин FireURQ по умолчанию (который загружается тогда, когда скин игры не определён):

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="800" height="600" />
'''<resources>
'''<texture name="res" file="furq_texture.png" />
'''</resources>
'''<main>
'''<textpane left="20" top="55" width="760" height="525" />
'''<menus>
'''<sysbutton tex="res" tx="0" ty="0" width="106" height="46" posx="0" posy="0"/>
'''<sysmenu posx="20" posy="42" datum="lt"/>
'''<invbutton tex="res" tx="424" ty="0" width="130" height="46" posx="671" posy="0"/>
'''<invmenu posx="780" posy="42" datum="rt"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="47" width="566" height="17" posx="105" posy="29"/>
'''</decorations>
'''</main>
'''</skin>

А это скин из демо для FireURQ 1.3:

'''<?xml version="1.0" encoding="window-1251"?>
'''<skin>
'''<screen width="1024" height="768" />
'''<resources>
'''<texture name="res" file="demo_tex.png" />
'''<font name="btnfont" file="buttons_font.fnt" />
'''<font name="mnufont" file="menu_font.fnt" />
'''<buttonframe name="tbuttons" tex="res" font="btnfont" texx="0" texy="210" width="109" height="55" leftw="31" midw="10" cnormal="FF94cddb" cfocused="FFFFFFFF" />
'''</resources>
'''<splash bgcolor="FF00042c">
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />
'''</splash>
'''<main bgcolor="FF00042c">
'''<textpane bframe="tbuttons" top="55" left="255" width="555" height="615" btnalign="3"/>
'''<menus font="mnufont" bgcolor="c01c79ae" bordercolor="ff60c5ff" vindent="1" textcolor="FFFFFFFF" disabledcolor="FF818181" selectioncolor="E0003f95">
'''<invbutton tex="res" tx="341" ty="10" width="55" height="55" posx="959" posy="703"/>
'''<sysbutton tex="res" tx="342" ty="80" width="60" height="60" posx="0" posy="708"/>
'''<sysmenu posx="60" posy="720" datum="lb"/>
'''</menus>
'''<decorations>
'''<image tex="res" tx="0" ty="285" width="1024" height="257" posx="0" posy="511"/>
'''</decorations>
'''</main>
'''</skin>

Как видно, первой должна идти строчка, определяющая формат XML-документа:
'''<?xml version="1.0" encoding="window-1251"?>

А все данные собственно скина размещаются в тегах внутри корневого тега skin:
'''<skin>
'''...
'''</skin>

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font>
*Названия тегов и параметров чувствительны к регистру.
*Стоит принять во внимание, что интерфейс игры без скина и с пустым скином (в котором есть только тег '''skin''', но внутри него ничего нет) будут отличаться. В первом случае будет загружен скин по умолчанию. Во втором - никакого скина загружено не будет и FireURQ сама создаст минимально возможный для игры интерфейс, используя значения по умолчанию, зашитые в программу.</div>

==Настройки экрана==

Можно задать размер окна FireURQ с помощью тега '''screen'''.

'''''Параметры:'''''
*'''width''' - ширина окна (по умолчанию 800)
*'''height''' - высота окна (по умолчанию 600)
*'''fullscreen''' - если равна 1, то FireURQ запустится сразу в полноэкранном режиме (по умолчанию 0)

'''''Пример:'''''
'''<screen width="1024" height="768" fullscreen="1" />
FireURQ установит размер окна в 1024х768 и запустится в полноэкранном режиме.

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

Учтите, что хотя размер окна можно задать хоть 628х315, но если вы установите размер, не поддерживаемый видеокартой и монитором, то FireURQ не сможет запуститься в полноэкранном режиме!

==Ресурсы==

Ресурсы - это текстуры, шрифты и заранее определённые рамки для кнопок, которые используются при оформлении скина. Каждому ресурсу присваивается имя, на которое потом ссылаются другие структуры данных, описывающие скин. Все ресурсы помещаются внутри тега '''resources'''.

===Текстуры===

Ресурс текстуры описывается тегом texture.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''file''' - файл текстуры (изображение JPEG, TGA или PNG).

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

Учтите, что многие из элементов управления (кнопки, например) должны иметь прозрачные элементы для того, чтобы смотреться хорошо. Прозрачность поддерживается только для 24-битных PNG и TGA.

===Шрифты===

Ресурс шрифта описывается тегом '''font'''.

Параметры:
*'''name''' - имя ресурса
*'''file''' - файл шрифта, подготовленного программой fonted из поставки FireURQ, или шрифт TrueType

===Рамки кнопок===

Рамка кнопок описывает оформление кнопки с текстом внутри. В настоящий момент данный ресурс используется только для оформления кнопок перехода между локациями, но не исключено, что в будущем он будет использоваться для чего-то ещё (например, кастомных кнопок внутри квеста). Ресурс рамки кнопок описывается тегом '''buttonframe'''.

'''''Параметры:'''''
*'''name''' - имя ресурса
*'''tex''' - имя ресурса текстуры, на которой нарисован глиф кнопки
*'''font''' - имя ресурса шрифта, который будет использован для подписи кнопки
*'''texx''' и '''texy''' - координаты глифа кнопки на текстуре
*'''width''' и '''height''' - ширина и высота глифа кнопки
*'''leftw''' - ширина левой "крышечки" кнопки
*'''midw''' - ширина средней части кнопки
*'''cnormal''' - цвет (в шестнадцатиричном формате) надписи в нормальном состоянии (по умолчанию - FFA0A0A0 )
*'''cdisabled''' - цвет надписи в неактивном состоянии (по умолчанию - FF606060 )
*'''cfocused''' - цвет надписи при наведении мыши/перемещении фокуса (по умолчанию - FFA0A0FF )

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

На текстуре должны быть расположены справа налево три глифа - для каждого из состояний кнопки (обычное, неактивное и сфокусированное). Разные параметры этого ресурса легче всего проиллюстрировать на картинке (это то, как определена рамка кнопок на текстуре по умолчанию, изображение увеличено):

[[Изображение:Btn schema.png]]

==Интерфейс сохранения/загрузки. ==

Описывается тегом '''saveload''' и располагается в главном элементе '''skin'''

'''''Параметры:'''''
*'''bgcolor''' - цвет фона в шестнадцатеричном формате
*'''captioncolor''' - цвет заголовка в шестнадцатеричном формате
*'''captionfont''' - шрифт заголовка

'''''Пример:'''''
'''<saveload bgcolor="C0000000" captioncolor="FFFFBB4F" captionfont="myfont">'''
'''<buttons frame="myframe" />'''
'''</saveload>'''

Если '''myframe''' не определена, то берётся системная кнопка, которая используется обычно в игре. Если '''myfont''' не определён, берётся системный шрифт. Цвета указаны те, которые берутся по умолчанию. Для кнопок, использующихся на экране сохранения/загрузки, необходимо четыре состояния: нормальное, дизабленое, выбранное и нажатое.

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

'''''Пример:'''''
'''<saveload>'''
'''...'''
'''<backbutton tex="res" tx="565" ty="106" width="50" height="50" posx="35" posy="60"/>'''
'''...'''
'''</saveload>'''

==Заставка==

Заставка (сплеш-скрин) показывается при запуске игры. Настройки заставки помещатся в теге '''splash'''. Если тег '''splash''' отсутствует в скине, то проигрывается стандартная заставка.

'''''Параметры тега''''' ''splash'':
*'''bgcolor''' - цвет фона в шеснадцатеричном формате (по умолчанию - 0)
*'''vcolor''' - цвет надписи о версии FireURQ (по умолчанию - FFEE9A00)

Внутри тега '''splash''' может помещаться тег '''logo''', с помощью которого можно заменить логотип FireURQ на изображение чего-нибудь другого.

'''''Параметры тега''''' ''logo'':
*'''tex''' - имя ресурса текстуры, на которой нарисован логотип
*'''tx''' и '''ty''' - координаты верхнего левого угла логотипа на текстуре
*'''width''' и '''height''' - ширина и высота изображения логотипа

'''''Пример:'''''
'''<splash bgcolor="FF000000" vcolor="FFEE9A00">'''
'''<logo tex="res" tx="0" ty="0" width="307" height="201" />'''
'''</splash>'''

==Основной раздел==

Основной раздел скина, описывающий интерфейс собственно проигрывателя, располагается внутри тега '''main'''. Если в скине отсутствует тег '''main''', то создаётся интерфейс по умолчанию - чёрный фон, текстовое поле занимает почти всё окно (с небольшими отступами), кнопки меню и инвентаря отсутствуют (меню и инвентарь можно вызвать только с клавиатуры), загружаются стандартные шрифты и стандартная рамка кнопок, никаких украшений.

'''''Параметры тега''''' ''main'':
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - 0)

===Текстовое поле===

Настройки текстового поля определяются с помощью тега '''textpane''' внутри тега '''main'''.

'''''Параметры:'''''
*'''font''' - имя ресурса шрифта текстового поля (по умолчанию - как в стандартном скине)
*'''bframe''' - имя ресурса рамки (стиля) кнопок, которая будет использована для оформления кнопок действий (по умолчанию - как в стандартном скине)
*'''left''' и '''top''' - координаты левого верхнего угла текстового поля в окне FireURQ (по умолчанию - 20, 10)
*'''width''' и '''height''' - ширина и высота текстового поля (по умолчанию выбираются так, чтобы правый край отставал на 20 пикселей от края окна, а нижний край - на 10 пикселов от нижнего края окна)
*'''btnalign''' - выравнивание кнопок (1 - по левому краю, 2 - по правому, 3 - по центру)
*'''btntxtalign''' - выравнивание текста на кнопках (так же, 1 - по левому краю, 2 - по правому, 3 - по центру)

'''''Пример:'''''
'''<textpane font="georgia[24]" bframe="tbuttons" top="30" left="30" width="400" height="500" btnalign="3" btntxtalign="3"/>'''
создаст текстовое поле с шрифтом 24 размера типа georgia и определёнными вами кнопками, с координатами левого верхнего угла (30, 30),
с шириной 400 пикселов и высотой 500 пикселов, и с выравнивание текста внутри поля по центру.
Внутри кнопок текст так же будет выровнен по центру.

===Меню и инвентарь===

Параметры меню описываются внутри тега '''menus'''. И системное меню, и меню инвентаря имеют единый стиль, т.е. цвета и шрифт для них одинаковые.

'''''Параметры тега''''' ''menus'':
*'''font''' - имя ресурса шрифта меню (по умолчанию - как в стандартном скине)
*'''bgcolor''' - цвет фона в шестнадцатеричном формате (по умолчанию - FFFFFFFF)
*'''bordercolor''' - цвет рамки (по умолчанию - FFA0A0A0)
*'''textcolor''' - цвет текста пунктов меню (по умолчанию - FF000000)
*'''selectioncolor''' - цвет фона выделенного пункта меню (по умолчанию - FF0000A0)
*'''selectedcolor''' - цвет текста выделенного пункта меню (по умолчанию - FFFFFFFF)
*'''disabledcolor''' - цвет текста неактивного пункта меню (по умолчанию - FFC0C0C0)
*'''hindent''' - отступ в пикселях слева и справа от текста до рамки (по умолчанию - 2)
*'''vindent''' - отступ сверху и снизу от текста до следующего пункта меню в пикселях (по умолчанию - 2)

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

Лучше всего понять, к чему относятся те или иные параметры можно, взглянув на рисунок:

[[Изображение:Menu schema.png]]

'''''Пример:'''''
'''<menus font="myfont" bgcolor="FFFFFFFF" bordercolor="FFA0A0A0" textcolor="FF000000" selectioncolor="FF0000A0" selectedcolor="FFFFFFFF" disabledcolor="FFC0C0C0"'''
'''hindent="2" vindent="2">'''
'''</menus>'''

====Кнопки системного меню и инвентаря====

Внутри тега '''menus''' могут располагаться теги '''sysbutton''' и '''invbutton''', определяющие кнопки вызова системного меню и инвентаря соответственно. Если этих тегов нет в скине, то соответствующие кнопки созданы не будут и соответствующие меню можно будет вызвать только с клавиатуры.

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисованы глифы кнопки (всего их должно быть четыре - нормальная, неактивная, выделенная и нажатая)
*'''tx''' и '''ty''' - координаты верхнего левого угла первого глифа на текстуре
*'''width''' и '''height''' - ширина и высота кнопки
*'''posx''' и '''posy''' - координаты кнопки в окне FireURQ

'''''Пример:'''''
'''<invbutton tex="res" tx="300" ty="10" width="50" height="50" posx="500" posy="0"/>'''
'''<sysbutton tex="res" tx="400" ty="80" width="60" height="60" posx="0" posy="0"/>'''

====Позиция меню на экране====

Если определены кнопки для системного меню и инвентаря, то FireURQ использует специальный алгоритм, чтобы определить как и в каком месте должны раскрываться соответствующие меню. Например, если кнопка системного меню сделана в правом нижнем углу окна, то системное меню будет раскрываться над этой кнопкой с привязкой за правый нижний угол.

Если кнопки не определены, то системное меню будет открываться в левом верхнем углу окна, а инвентарь - в правом верхнем.

Однако, есть возможность жёстко задать координаты, где будет открываться то или иное меню. Так сделано, например, в стандартном скине. Это возможно с помощью тегов '''sysmenu''' и '''invmenu'''.

'''''Параметры:'''''
*'''posx''' и '''posy''' - координаты одного из углов меню в окне FireURQ
*'''datum''' - указание на то, за какой, собственно, угол меню осуществляется привязка. Возможны четыре значения - '''lt''' (по умолчанию), '''lb''', '''rt''' и '''rb'''. Левый верхний, левый нижний, правый верхний и правый нижний. Привязка влияет на то, как будет открываться меню. Например, если для меню указал параметр '''lb''', то оно будет открываться "вверх" и "вправо".

'''''Пример:'''''
'''<sysmenu posx="0" posy="0" datum="lt"/>''' Системное меню будет открываться в левом верхнем углу экрана
'''<invmenu posx="800" posy="0" datum="rt"/>''' Инвентарь будет открываться в правом верхнем углу экрана,
если ширина окна игры равна 800 пикселей (по умолчанию).

===Иконки состояний===

Иконки состояний - это мигающие изображения, появляющиеся в особые моменты игры. Все описания иконок состояний размещаются внутри тега '''icons''', который в свою очередь размещается внутри тега '''main'''. При этом существуют три типа этих иконок, описывамых в тегах '''timer''' (иконка ожидания, появляется при команде ''pause''), '''anykey''' (когда игра ждёт нажатия клавиши) и '''scroll''' (когда текст локации не помещается целиком и игра ждёт нажатия клавиши, чтобы продолжить вывод текста). Каждый из этих тегов имеет следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисована иконка
*'''tx''' и '''ty''' - координаты верхнего левого угла иконки на текстуре
*'''width''' и '''height''' - ширина и высота изображения иконки

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

Все иконки всегда появляются на экране на одном месте - в правом нижнем углу текстового поля.

'''''Пример:'''''
'''<icons>'''
'''<scroll tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<timer tex="res" tx="0" ty="0" width="9" height="14" />'''
'''<anykey tex="res" tx="0" ty="0" width="9" height="14" />'''
'''</icons>'''
Этот код будет выводить одну и ту же иконку из ресурса '''res''' для всех состояний.

===Украшения===

Существует возможность задать в скине изображения, которые являются частью оформления скина и всегда находятся на экране. Все элементы оформления помещаются внутри тега '''decorations''' и определяются тегом '''image''', имеющим следующие параметры:

'''''Параметры:'''''
*'''tex''' - имя ресурса текстуры, на которой нарисовано изображение
*'''tx''' и '''ty''' - координаты верхнего левого угла изображения на текстуре
*'''width''' и '''height''' - ширина и высота изображения
*'''posx''' и '''posy''' - координаты изображения в окне FireURQ
*'''flipx''' - если равна 1, то изображение будет перевёрнуто по вертикальной оси (по умолчанию 0)
*'''flipy''' - если равна 1, то изображение будет перевёрнуто по горизонтальной оси (по умолчанию 0)

'''''Примечания:'''''
Параметры '''flipx''' и '''flipy''' удобно использовать, когда элементы оформления являются зеркальным отражением друг друга. В этом случае можно создать на текстуре одно изображение и разместить его в окне FireURQ, переворачивая по-всякому, чтобы добиться симметричного рисунка.

'''''Пример:'''''
'''<decorations>'''
'''<image tex="res" tx="0" ty="0" width="800" height="600" posx="0" posy="0"/>'''
'''</decorations>'''
Данный код выведет картинку из ресурсного файла на весь экран игры (размеры окна игры взяты по умолчанию).

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

== См. также ==
* [[FireURQ:Скинование Дат-Навирэ]]
* Собственно для чего эта документация [[FireURQ]]

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

FireURQ:Руководство пользователя

2017-03-21T12:34:05Z

Ajenta: /* Шрифт */

=Метки=

Метка - одно из важнейших понятий URQL. Она служит для выделения места в квесте, куда затем предстоит перейти. Любые перемещения в квесте могут быть либо на следующий оператор, либо на метку. Все метки имеют имена, чтобы потом можно было указывать, куда вы хотите перейти.
Определяется метка при помощи двоеточия. Все, что правее этого символа, до разделителя, которым является символ конец абзаца (Enter) или '&' - имя метки:

''':Имя_метки'''

Метка и следующий за ней оператор end являются принятой единицей измерения игры - локацией. Между ними обычно пишется описание локации и переходы из неё в другие локации.

''':начало'''
'''end'''

Например, допустимыми именами меток являются:

''':1'''
''':01'''
''':а'''
''':кот1'''
''':@(a)%^Очень_Длинная_и_Запутанная_метка_какими-лучше-не-пользоваться!!!!!_horror_так_как_сами_потом_забудете_как_она_называется!Или_сделаете_ошибку!'''
'''Вы_же_можете_сделать_маленькую_ошибку_в таком_длинном_названии?'''
''':house_flat1'''

'''''Примечание:''''' метка должна начинаться с начала строки и отделяться от других операторов (Enter) или '&', регистр имени метки не важен.

:BIG
:bIG
:Big
:big
- все эти метки для интерпретатора совершенно одинаковы. Но лучше, в целях собственного удобства, придерживаться единого стиля.

В метке лучше не делать пробелов. Длина метки не ограничена, но для удобства автора квеста лучше не делать меток длиннее строки. В метке допускаются символы, обозначающие буквы русского и латинского алфавита, цифры, знак подчеркивания и знаки арифметических операций + и - (лучше не злоупотреблять странными названиями).

Недопустимы символы ''';''' '''/*''' '''*/''' '''&'''

Грамотное использование имен меток способно серьезно облегчить работу автора.

=Текст=
==Вывод текста==

Поскольку мы имеем дело с текстовыми играми, важнейшим для нас является вывод текста. В FURQ существует несколько способов вывода текста.

===Текст на экране===

Простейший способ вывести текст это использовать команды '''P''' и '''PLN'''. Советую освоить их, прежде чем переходить к другим способам вывода.

Формат команд:
'''p''' [текст]
'''pln''' [текст]

Регистр команд не имеет значения ('''pLn''' = '''PLN''' = '''Pln''').

На практике это выглядит так:
'''p''' Этот текст появится на экране.
или
'''pln''' Этот текст тоже появится на экране.

Каждая последующая команда '''P''' или '''PLN''' дописывает новый текст к тексту который уже есть на экране. Когда текста становится слишком много, появляется возможность его прокрутить.

Разница этих двух команд в следующем - '''P''' просто добавляет новый текст, а '''PLN''' добавляет текст и делает переход на новую строку (создает абзац).

Например:
'''p''' А
'''p''' Б

Выдаст “АБ”, тогда как

'''pln''' А
'''pln''' Б

Выдаст:
А
Б

Чаще всего пользуются командой '''pln''', однако и '''p''' может быть полезна, например, когда строчка текста, которую мы хотим вывести на экран, состоит из нескольких частей и зависит от каких-либо переменных или условий.

Команды '''P''' и '''PLN''' могут напрямую выводить любые символы (кроме символа комментария '''“;”'''), переменные и ссылки.

===Вывод переменных===

Вывод переменных возможен в двух вариантах - числовом и текстовом. Для того чтобы их вывести, нужно заключить имена переменных в соответствующие скобки:
'''pln''' '''#%'''имя_текстовой_переменной'''$''' '''#'''имя_числовой_переменной'''$'''
Несмотря на внешнее сходство, они отличаются содержанием и символом '''%'''. Если в числовые скобки попадет текстовая переменная, то на выводе окажется не текст, а количество символов в этой переменной. И наоборот, если числовая переменная попадет в текстовые скобки, то на выводе окажется пустота.

Выведем оба типа переменных на экран:

'''текстовая_переменная="Геннадий"'''
'''числовая_переменная=42'''
'''pln''' Крокодил схватил вас за ногу и сказал:
'''pln''' - Меня зовут '''#%текстовая_переменная$'''.
'''pln''' Затем крокодил схватил вас за другую ногу и сказал:
'''pln''' - Мне '''#числовая_переменная$''' года. Давай, ты станешь моим близким другом.

Результат:
Крокодил схватил вас за ногу и сказал:
- Меня зовут Геннадий.
Затем крокодил схватил вас за другую ногу и сказал:
- Мне 42 года. Давай, ты станешь моим близким другом.

Кроме того, в '''URQL''' есть специальные обозначения для вывода символа пробела - '''#$''', вывода символа переноса строки - '''#/$''' и вывода символа по ascii-коду - '''##'''ascii-код'''$'''.

Так, например, символ комментария можно вывести на экран, через его ascii-код:
'''pln''' Моя грамотность была на исходе'''##59$''' но, несмотря на это, я поставил точку с запятой в предложении.

Результат:
Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.

Хочу напомнить, что если бы мы написали в коде просто:
'''pln''' Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.
То получили бы на экране:
Моя грамотность была на исходе
Потому что символ ";" и все что после него идет было бы обработано как комментарий.

'''Примечание:'''
Вывод строковой переменной, как числа '''#текстовая_переменная$''' даст нам количество символов в строке.

==Оформление текста==

В 21 веке в '''FURQ''' текст это не просто набор символов, но еще и набор гарнитур, цвет, выравнивание и местоположение.

===Местоположение===
Область экрана, куда выводят текст команды '''p''' и '''pln''' можно двигать, делать шире, уже, выше и т.д. Для этого служат системные переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height''', которые описывают некий прямоугольник куда и выводится текст. По умолчанию он занимает почти весь экран. Это числовые переменные, которые содержат значения в пикселях.

Давайте, используя полученные нами знания, выведем значения этих переменных на экран:
'''pln''' Левая граница='''#textpane_left$''', Верхняя граница='''#textpane_top$''', Ширина='''#textpane_width$''', Высота='''#textpane_height$'''

Результат:
Левая граница=20, Верхняя граница=55, Ширина=760, Высота=525

Вы можете изменять значения этих переменных как угодно в любом месте игры. Например, вы хотите вывести справа от текста картинку: измените ширину ('''textpane_width''') так чтобы текст не мешал. А когда картинка больше не нужна измените ширину обратно. Экспериментируйте.

===Выравнивание текста===

За выравнивание текста отвечает команда числовая системная переменная textalign. Она сообщает FURQ как должен быть расположен текст относительно области его вывода.

Лучше всего это понять на примере:
'''textalign = 1'''
'''pln''' текст выравнивается влево
'''textalign = 2'''
'''pln''' текст выравнивается вправо
'''textalign = 3'''
'''pln''' текст выравнивается по центру

''; Главное теперь не забыть, поменять переменную обратно на '''1''', если вы не хотите, чтобы текст всей игры был выравнен по центру.''

===Цвет===

Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате '''0xAARRGGBB'''. То есть четыре составляющих: альфа, красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.

Встроенная функция '''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255''' (т.е. полностью видимый цвет).

Пример:
'''proc''' _color(x+15, 10, 255, 60)
'''textcolor = _result'''

===Шрифт===

Для определения шрифта, которым будет выводиться текст, используется переменная '''textfont'''. В нее в виде строкового значения следует записать имя файла шрифта.

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

'''FireURQ''' имеет встроенные шрифты с засечками (serif) и без засечек (sans) во всех начертаниях — полужирном (bold), наклонном (italic) и полужирном наклонном (bold-italic).

Чтобы использовать эти шрифты в игре, достаточно написать '''textfont = «serif-italic[25]»''' и у вас будет наклонный шрифт 25-го размера с засечками.

Формат использования шрифта такой:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]'''

*'''size''' – размер шрифта(по умолчанию '''19'''), а точнее высота строки в пикселях
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')

Допустим, мы хотим вывести текст шрифтом Georgia.

Для этого пишем:
'''textfont = "georgia.ttf"'''
И сразу же проверяем результат, при помощи оператора вывода текста '''pln''', который мы уже освоили в совершенстве:
'''pln Крокодил зарылся в ил, крокодила ил манил'''

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

Меняем размер на 42:
'''textfont = "georgia.ttf[42]"'''

Остальные параметры команды нужны, чтобы текст, который будет выведен на экран выглядел еще более красиво (например, при стандартных параметрах текст может выглядеть не слишком хорошо на светлом фоне). В параметре '''bgcolor''', конечно, лучше задать цвет фона, на котором будет выведен текст. Другие параметры подбираются скорее на глаз, чем по науке.

Примеры:
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

Чтобы, после манипуляций с текстом, вернуться к шрифту по умолчанию, следует выполнить:
'''textfont = "_sysfont"'''

'''FireURQ''' может использовать и растровые шрифты формата '''HGE Font''' (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат '''HGE Font''', входит в дистрибутив (папка '''fonted''').

Пример использования HGE шрифта
'''textfont = "myfont.fnt"'''

===Команда CLS===

Часто бывает так, что экран, на который уже выведен текст нужно очистить. Для того чтобы удалить весь текст, выведенный при помощи команд '''P''' и '''PLN''', существует команда '''CLS'''. У нее нет никаких параметров.

Пример:
'''pln Уйма текста.'''
'''cls'''

Результат:
 

===Другие способы вывода текста===

Иногда оказывается недостаточно команд, описанных выше. Например, вы хотите чтобы в верхнем правом углу экрана всегда отображалось количество очков, которые игрок заработал на протяжении игры. Или состояние здоровья персонажа. Или название комнаты, в которой он находится. Или все это одновременно в разных местах экрана. Тогда на помощь автору приходят текстовые [[декораторы]].

===Текст в заголовке===

Для того чтобы вывести название игры или другой текст в заголовок окна FURQ нужно поместить этот текст в системную текстовую переменную gametitle. Если переменная пуста, то в заголовке будет отображаться название файла игры.

Пример:
'''gametitle = “Крокодил”'''

Результат:

[[Изображение:Furq_titlebar.png]]

''; Иногда эту переменную удобно использовать при отладке игры, временно выводя в нее, к примеру, значения других переменных.''

= Переходы =

Любой текстовый квест можно разбить на локации с текстом и переходы между ними. Из каждой локации к другим локациям обычно ведет несколько переходов, которые обозначают некоторые альтернативные варианты действий. В этой главе мы рассмотрим способы, которыми URQL позволяет сделать переходы в игре.

==Переход по кнопкам (оператор BTN)==

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

Общее обозначение: btn <локация>, <надпись на кнопке>]

Где <локация> - имя метки, на которую будет совершен переход, <надпись на кнопке> - надпись на кнопке, которая отображается на экране. В случае если <надпись на кнопке> не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
'''btn лес,Войти в лес'''
Эта команда выведет на экран кнопку с текстом '''Войти в лес''', ведующую на локацию '''лес'''

'''''Примечание 1: пробелы до и после надписи на кнопке игнорируются.'''''

'''''Примечание 2: если локация не найдена, то кнопка выводится с пометкой // phantom.'''''

'''''Примечание 3: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

У кнопок есть так называемое "эхо". Это сообщение, выводящееся на экран о том, что вы перешли по кнопке. Чтобы оно не выводилось, следует использовать переменную '''hide_btn_echo'''. Если установить её в единицу, то сообщения показываться не будут.

'''''Пример:'''''
'''hide_btn_echo = 1'''

===Команда CLSB===

Бывает так, что нам не нужно очищать весь экран, а нужно стереть только кнопки действий. Для того чтобы удалить кнопки выведенные командой '''BTN''', существует команда '''CLSB'''. У нее нет никаких параметров.

Пример:
'''btn север, Идти на Север'''
'''clsb'''
'''btn юг, Идти на Юг'''

Результат (текст на выведенной кнопке):
'''Идти на Юг'''
 

===Оформление кнопок в Fireurq===

Оформление кнопок делается в файле skin.xml
Описание можно найти в статье [[FireURQ:Скины|FireURQ:Скины]].

==Переход по ссылке==

FireURQ позволяет использовать в тексте (и декораторах) ссылки.

'''''Формат ссылок:'''''
'''<nowiki>[[текст ссылки|название локации]]</nowiki>'''

'''''Пример:'''''
'''pln Вы стоите рядом с покосившимся <nowiki>[[домиком|домик_осмотреть]]</nowiki>. Вокруг раскинулись <nowiki>[[клумбы с аромантными цветами|клумбы_осмотреть]]</nowiki>.'''

Здесь '''домик_осмотреть''' и '''клумбы_осмотреть''' - названия локаций, на которые будут осуществляться переходы при нажатии на ссылку.

Цвет ссылок задаётся переменными linkcolor и linkhcolor. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши.

'''''Пример:'''''
'''linkcolor = 0xffffff'''
'''linkhcolor = 0x0000ff'''
В данном примере цвет ссылок в тексте будет белым, а при наведении станет синим.

Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

'''''Упрощенный формат вывода ссылок такой:'''''
'''<nowiki>[[текст ссылки]]</nowiki>'''

В данном случае ссылка будет вести на метку под названием "текст ссылки".

'''''Пример:'''''
'''pln На волнах раскачивается деревянная <nowiki>[[лодка]]</nowiki>.'''

Здесь, при клике на ссылку произойдет переход на метку "лодка".

'''''Замечание: не рекомендуется называть метки именами с пробелами, соответственно не стоит использовать ссылки типа <nowiki>[[деревянная лодка]]</nowiki>, которые ведут на локации с такими именами.'''''

У ссылок, как и у btn есть "эхо", то есть в окне игры пишется, что вы перешли по ссылке. Чтобы его отключить, следует использовать переменную '''hide_link_echo'''. Если установить её в 1, то "эхо" выводиться не будет.

'''''Пример:'''''
'''hide_link_echo = 1'''

'''''Примечание: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

==Переход по оператору GOTO==

'''''Синтаксис:'''''
'''GoTo Метка'''

После выполнения оператора '''goto''' происходит мгновенное перемещение на указанную метку. При наличии локации common (см. ниже) операторы на локации common при переходе по '''goto''' НЕ ВЫПОЛНЯЮТСЯ. Это сделано специально и умышленно - чтобы можно было делать переходы внутри локации.

Примечание: в случае не нахождения метки, goto просто игнорируется.

'''''Пример:'''''
'''goto лес'''
Этот код произведёт перемещение на локацию с названием ''''лес'''.

==Переход по оператору PROC==

'''''Синтаксис:'''''
'''Proc Метка'''

При вызове данного оператора происходит переход на указанную метку и выполнение программы, до встречи первого end, потом управление передается оператору, следующему непосредственно за '''proc''', откуда команда была вызвана. Допустима любая вложенность '''proc'''-вызовов (вплоть до использования рекурсии!).

Нормально обрабатываются последовательные переходы по '''proc''' - цепочка ведется до тех пор, пока не встретится первый end. При этом кнопки во всех пройденных локациях накапливаются(!), но при обнаружении end'а происходит не опрос пользователя, а возврат к предыдущему proc'у и так до самого начала цепочки.

'''''Пример:'''''
''':берег_реки'''
'''pln Вы стоите на берегу реки, позади вас Туманный лес.'''
'''proc лес'''
'''pln Отсюда только одна дорога - на запад.'''
'''end'''
''';----------'''
''':лес'''
'''pln Из леса на вас поглядывают волки.'''
'''end'''

При выполнении этот код выведет на экран следующее:

Вы стоите на берегу реки, позади вас Туманный лес.
Из леса на вас поглядывают волки.
Отсюда только одна дорога - на запад.

То есть, после выполнения по '''proc''' локации '''лес''', мы вернёмся в локацию '''берег_реки''' и продолжим с того места, на котором был вызов команды '''proc'''.

'''''Важно:''''' При наличии локации common (см. ниже) операторы на локации common при переходе по '''proc''' НЕ ВЫПОЛНЯЮТСЯ и системная переменная '''current_loc''' не меняется.

'''Примечание:''' Часто из метки вызванной с помощью '''proc''' ведёт вызов '''goto''' и далее. В таком случае, если мы не хотим возврата к первой локации, нужно использовать оператор '''forget_procs'''

==Переход по декораторам TEXTBUTTON и IMGBUTTON==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Декораторы'''.

==Контекстное меню==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Выпадающие меню'''.

==Параметры при переходах==

Локальные параметры при переходах возможно передать параметры.

Общее обозначение: <метка>(param1, param2, ...)

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные <метка>_1, <метка>_2 и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).

Важное замечание: при использовании параметров в операторе btn подстановки (#...$ и #%...$) раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.

'''''Пример:'''''
'''btn лес(1,"опушка"),Войти в лес'''
На локации '''лес''', переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''

то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''

Параметры при переходах очень удобны для организации проверок внутри локации.

'''''Замечание:''''' Если вы передаёте параметры метке, то её название не должно начинаться с цифры, то есть исключены названия вроде '''25''' или '''40метро'''. Если вы хотите использовать цифры в названии, то ставьте их после букв, к примеру - '''метро40'''.

= Музыка и звук =

В '''FURQ''' есть целый ряд команд для воспроизведения аудио. Оно может быть всевозможных форматов: WAV, AIFF, MP3, MP2, MP1, OGG, MIDXM, IT, S3M, MOD, MTM, UMX. Есть возможность тонкого регулирования громкости звука.

Для начала запасемся на ресурсах, где свободно распространяют звуки (например, www.freesound.org) или запишем сами материала для проигрывания.

==Play==

Команда '''Play''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''play [loop|stop] [<имя файла>[, <громкость>]]'''

Чтобы просто запустить звук на проигрывание с помощью play напишите после команды имя файла. Например, нужно проиграть некий звук крокодила ''alligator.ogg''. Для этого пишем:
'''play alligator.ogg'''

Если файл alligator.ogg лежит рядом с файлом игры, то мы услышим нечто. Но если мы для удобства положим все звуки в отдельную папку sounds, то придется написать так:
'''play sounds/alligator.ogg'''

В нашем примере звук крокодила будет звучать всего один раз, однако, при помощи параметра '''loop''' мы сможем заставить крокодила двигаться и звучать бесконечно:
'''play loop sounds/alligator.ogg'''

Теперь звук будет повторяться снова и снова. Остановить его сможет только параметр '''stop''':
'''play stop sounds/alligator.ogg'''

При помощи '''Play''' можно одновременно проигрывать несколько звуков. Кроме того, можно регулировать громкость звука, добавив к команде play через запятую значение от '''0''' (полная тишина) до '''255''' (максимальная громкость). По умолчанию, '''play''' играет аудио с максимальной громкостью.

К примеру, мы хотим, одновременно наслаждаться звуком крокодила и чмоканием болота, но так, чтобы крокодил был слышен громче:
'''play loop sounds/alligator.ogg'''
'''play loop sounds/swamp.wav, 100'''

Чтобы остановить сразу все звуки, запущенные командой '''play''', мы применим такую на первый взгляд абсурдную команду как:
'''play stop'''

''; Важно помнить, что звуки запущенные на одной локации через '''play''' с параметром '''loop''' без новой команды с параметром '''stop''' сами собой не прекратятся, даже если вы перешли на другую локацию. И если вы вдруг оттуда вернетесь на прежнюю локацию, то те же самые звуки запустятся еще раз. Добро пожаловать в какафонию.''

==Voice==

Команда '''Voice''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''voice <имя файла>'''
'''voice stop'''

Команда предназначена специально для озвучивания игры голосом. Например, ей удобно запускать записи реплик персонажей или рассказчика. Во многом она аналогична команде '''play''', но с несколькими важными особенностями:
Проигрывать можно только одну реплику/звук одновременно(запуск другой озвучки через команду voice останавливает предыдущую).

Переход на другую локацию по кнопке ('''btn''') останавливает озвучку.

Громкость здесь регулируется числовой переменной '''voice_volume''' (от '''0''' до '''255''').

Остановить проигрывание файла можно при помощи команды '''voice stop'''.

Если вам необходимо чтобы прозвучало несколько реплик на одной локации, то достаточно удобно использовать команду voice в связке с командой '''anykey'''. Прослушав реплику, игрок будет нажимать на любую клавишу и слушать следующую.

Например:

'''voice_volume=200'''
'''pln - Еще раз здравствуй. - сказал крокодил и придвинулся поближе.'''
'''voice sounds/helloagain.ogg'''
'''anykey'''
'''pln Вам стало не по себе.'''
'''voice sounds/SCREAM.wav'''

==Music==

Кроме форматов аудиофайлов, которые воспроизводят команды '''play''' и '''voice''', команда '''music''' проигрывает еще и трекерную музыку (XM, IT, S3M, MOD, MTM, UMX), MIDI-файлы (MID) и MO3.

Формат команды:
'''music <имя файла>|stop[, <время в миллисекундах>]'''

Зацикливание проигрывания устанавливается в переменной music_looped ('''0''' - играть один раз, '''1''' - играть бесконечно). По умолчанию, вот отличие от команд '''play''' и '''voice''', здесь музыка зациклена.

''; некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.

''Громкость воспроизведения регулируется переменной music_volume (от '''0''' до '''255''').

С помощью команды '''music''' можно проигрывать только один файл одновременно, однако, можно задавать время, в течении которого громкость следующего аудиофайла будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект '''crossfade''' – старый трек будет угасать, а новый – нарастать по громкости.

Так “'''music stop'''” останавливает воспроизведение музыки. А если указать в качестве параметра время, то воспроизведение остановится через заданный промежуток.
'''music stop, 1500 ''; остановить музыку через 1,5 секунды'''''

===fademusic===

С помощью команды '''fademusic''' можно добиться плавного и красивого изменения громкости музыки.
Формат команды:
'''fademusic <громкость>, <время в миллисекундах>'''
громкость – целевая громкость музыки.

время в миллисекундах – время, в течении которого громкость достигнет целевого значения.

Предположим, что мы хотим сделать красивое и удобное включение и выключение музыки в нашей игре. Для этого используем [[инвентарь]] '''URQ'''. Игрок в любой момент сможет через пункт меню инвентаря включить и выключить музыку, а мы постараемся, чтобы это было плавно. На самом деле выключать музыку совсем мы не будем, а будем только понижать громкость до нуля, но зато нам не придется задаваться вопросом какой именно файл запускать при включении музыки.

В начале игры создадим элемент инвентаря “музыка” и присвоим ему наклейку “выключить музыку”:
'''inv+ музыка'''
'''idisp_музыка = "выключить музыку"'''
Запускаем любую музыку, в любом месте игры:
'''music music\Joe Hisaishi - Пылью на твоих руках.mp3'''
Теперь, в локации, которая отвечает за наш элемент инвентаря “музыка” используем оператор '''fademusic''':
''':Use_музыка'''
'''if idisp_музыка == "включить музыку" then idisp_музыка = "выключить музыку" & fademusic 255, 1500 else idisp_музыка = "включить музыку" & fademusic 0, 1500'''
'''end'''
Теперь по нажатию на “выключить музыку” громкость будет плавно затихать до нуля за 1,5 секунды, а по нажатию на “включить музыку” - так же плавно возрастать.

=Функции=

==Случайное значение Rnd==

Иногда полезно - особенно, если не злоупотреблять этим, ввести в квест элемент случайности, непредсказуемости. Именно для этого был введен механизм случайности: Rnd[x] - системная переменная (только для чтения) которая при пустом значении x хранит в себе случайное значение от 0 до 1, включая 1, а при целом x (к примеру, X=6) выдает выдает целые значения (от 1 до 6 включительно в нашем случае). При каждом обращении к переменной она принимает другое значение.

'''случай1 = rnd''' ;В результате переменная случай1 равна, например, 0.78

'''случай2 = rnd4''' ;В результате переменная случай2 равна, например, 3

==Ввод текста INPUT==

В урке есть возможность ввести строку, значение которой будет потом присвоено указанной переменной.

При необходимости ввести с клавиатуры русский текст через оператор '''input''' в строковую переменную ее следует предварительно объявить выражением:
'''строка = ""'''; Данное выражение создает строковую переменную нулевой длины.

'''pln Введите строку: & input строка'''

На экране мы увидим:
'''Введите строку:'''

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

FireURQ:Руководство пользователя

2017-03-21T12:33:24Z

Ajenta: /* Шрифт */

=Метки=

Метка - одно из важнейших понятий URQL. Она служит для выделения места в квесте, куда затем предстоит перейти. Любые перемещения в квесте могут быть либо на следующий оператор, либо на метку. Все метки имеют имена, чтобы потом можно было указывать, куда вы хотите перейти.
Определяется метка при помощи двоеточия. Все, что правее этого символа, до разделителя, которым является символ конец абзаца (Enter) или '&' - имя метки:

''':Имя_метки'''

Метка и следующий за ней оператор end являются принятой единицей измерения игры - локацией. Между ними обычно пишется описание локации и переходы из неё в другие локации.

''':начало'''
'''end'''

Например, допустимыми именами меток являются:

''':1'''
''':01'''
''':а'''
''':кот1'''
''':@(a)%^Очень_Длинная_и_Запутанная_метка_какими-лучше-не-пользоваться!!!!!_horror_так_как_сами_потом_забудете_как_она_называется!Или_сделаете_ошибку!'''
'''Вы_же_можете_сделать_маленькую_ошибку_в таком_длинном_названии?'''
''':house_flat1'''

'''''Примечание:''''' метка должна начинаться с начала строки и отделяться от других операторов (Enter) или '&', регистр имени метки не важен.

:BIG
:bIG
:Big
:big
- все эти метки для интерпретатора совершенно одинаковы. Но лучше, в целях собственного удобства, придерживаться единого стиля.

В метке лучше не делать пробелов. Длина метки не ограничена, но для удобства автора квеста лучше не делать меток длиннее строки. В метке допускаются символы, обозначающие буквы русского и латинского алфавита, цифры, знак подчеркивания и знаки арифметических операций + и - (лучше не злоупотреблять странными названиями).

Недопустимы символы ''';''' '''/*''' '''*/''' '''&'''

Грамотное использование имен меток способно серьезно облегчить работу автора.

=Текст=
==Вывод текста==

Поскольку мы имеем дело с текстовыми играми, важнейшим для нас является вывод текста. В FURQ существует несколько способов вывода текста.

===Текст на экране===

Простейший способ вывести текст это использовать команды '''P''' и '''PLN'''. Советую освоить их, прежде чем переходить к другим способам вывода.

Формат команд:
'''p''' [текст]
'''pln''' [текст]

Регистр команд не имеет значения ('''pLn''' = '''PLN''' = '''Pln''').

На практике это выглядит так:
'''p''' Этот текст появится на экране.
или
'''pln''' Этот текст тоже появится на экране.

Каждая последующая команда '''P''' или '''PLN''' дописывает новый текст к тексту который уже есть на экране. Когда текста становится слишком много, появляется возможность его прокрутить.

Разница этих двух команд в следующем - '''P''' просто добавляет новый текст, а '''PLN''' добавляет текст и делает переход на новую строку (создает абзац).

Например:
'''p''' А
'''p''' Б

Выдаст “АБ”, тогда как

'''pln''' А
'''pln''' Б

Выдаст:
А
Б

Чаще всего пользуются командой '''pln''', однако и '''p''' может быть полезна, например, когда строчка текста, которую мы хотим вывести на экран, состоит из нескольких частей и зависит от каких-либо переменных или условий.

Команды '''P''' и '''PLN''' могут напрямую выводить любые символы (кроме символа комментария '''“;”'''), переменные и ссылки.

===Вывод переменных===

Вывод переменных возможен в двух вариантах - числовом и текстовом. Для того чтобы их вывести, нужно заключить имена переменных в соответствующие скобки:
'''pln''' '''#%'''имя_текстовой_переменной'''$''' '''#'''имя_числовой_переменной'''$'''
Несмотря на внешнее сходство, они отличаются содержанием и символом '''%'''. Если в числовые скобки попадет текстовая переменная, то на выводе окажется не текст, а количество символов в этой переменной. И наоборот, если числовая переменная попадет в текстовые скобки, то на выводе окажется пустота.

Выведем оба типа переменных на экран:

'''текстовая_переменная="Геннадий"'''
'''числовая_переменная=42'''
'''pln''' Крокодил схватил вас за ногу и сказал:
'''pln''' - Меня зовут '''#%текстовая_переменная$'''.
'''pln''' Затем крокодил схватил вас за другую ногу и сказал:
'''pln''' - Мне '''#числовая_переменная$''' года. Давай, ты станешь моим близким другом.

Результат:
Крокодил схватил вас за ногу и сказал:
- Меня зовут Геннадий.
Затем крокодил схватил вас за другую ногу и сказал:
- Мне 42 года. Давай, ты станешь моим близким другом.

Кроме того, в '''URQL''' есть специальные обозначения для вывода символа пробела - '''#$''', вывода символа переноса строки - '''#/$''' и вывода символа по ascii-коду - '''##'''ascii-код'''$'''.

Так, например, символ комментария можно вывести на экран, через его ascii-код:
'''pln''' Моя грамотность была на исходе'''##59$''' но, несмотря на это, я поставил точку с запятой в предложении.

Результат:
Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.

Хочу напомнить, что если бы мы написали в коде просто:
'''pln''' Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.
То получили бы на экране:
Моя грамотность была на исходе
Потому что символ ";" и все что после него идет было бы обработано как комментарий.

'''Примечание:'''
Вывод строковой переменной, как числа '''#текстовая_переменная$''' даст нам количество символов в строке.

==Оформление текста==

В 21 веке в '''FURQ''' текст это не просто набор символов, но еще и набор гарнитур, цвет, выравнивание и местоположение.

===Местоположение===
Область экрана, куда выводят текст команды '''p''' и '''pln''' можно двигать, делать шире, уже, выше и т.д. Для этого служат системные переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height''', которые описывают некий прямоугольник куда и выводится текст. По умолчанию он занимает почти весь экран. Это числовые переменные, которые содержат значения в пикселях.

Давайте, используя полученные нами знания, выведем значения этих переменных на экран:
'''pln''' Левая граница='''#textpane_left$''', Верхняя граница='''#textpane_top$''', Ширина='''#textpane_width$''', Высота='''#textpane_height$'''

Результат:
Левая граница=20, Верхняя граница=55, Ширина=760, Высота=525

Вы можете изменять значения этих переменных как угодно в любом месте игры. Например, вы хотите вывести справа от текста картинку: измените ширину ('''textpane_width''') так чтобы текст не мешал. А когда картинка больше не нужна измените ширину обратно. Экспериментируйте.

===Выравнивание текста===

За выравнивание текста отвечает команда числовая системная переменная textalign. Она сообщает FURQ как должен быть расположен текст относительно области его вывода.

Лучше всего это понять на примере:
'''textalign = 1'''
'''pln''' текст выравнивается влево
'''textalign = 2'''
'''pln''' текст выравнивается вправо
'''textalign = 3'''
'''pln''' текст выравнивается по центру

''; Главное теперь не забыть, поменять переменную обратно на '''1''', если вы не хотите, чтобы текст всей игры был выравнен по центру.''

===Цвет===

Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате '''0xAARRGGBB'''. То есть четыре составляющих: альфа, красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.

Встроенная функция '''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255''' (т.е. полностью видимый цвет).

Пример:
'''proc''' _color(x+15, 10, 255, 60)
'''textcolor = _result'''

===Шрифт===

Для определения шрифта, которым будет выводиться текст, используется переменная '''textfont'''. В нее в виде строкового значения следует записать имя файла шрифта.

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

'''FireURQ''' имеет встроенные шрифты с засечками (serif) и без засечек (sans) во всех начертаниях — полужирном (bold), наклонном (italic) и полужирном наклонном (bold-italic).

Чтобы использовать эти шрифты в игре, достаточно написать '''textfont = «serif-italic[25]»''' и у вас будет наклонный шрифт 25-го размера с засечками.

Формат использования шрифта такой:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]'''

*'''size''' – размер шрифта(по умолчанию '''19'''), а точнее высота строки в пикселях
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')

Допустим, мы хотим вывести текст шрифтом Georgia.

Для этого пишем:
'''textfont = "georgia.ttf"'''
И сразу же проверяем результат, при помощи оператора вывода текста '''pln''', который мы уже освоили в совершенстве:
'''pln Крокодил зарылся в ил, крокодила ил манил'''

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

Меняем размер на 42:
'''textfont = "georgia.ttf[42]"'''

Остальные параметры команды нужны, чтобы текст, который будет выведен на экран выглядел еще более красиво (например, при стандартных параметрах текст может выглядеть не слишком хорошо на светлом фоне). В параметре '''bgcolor''', конечно, лучше задать цвет фона, на котором будет выведен текст. Другие параметры подбираются скорее на глаз, чем по науке.

Примеры:
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

Чтобы, после манипуляций с текстом, вернуться к шрифту по умолчанию, следует выполнить:
'''textfont = "_sysfont"'''

'''FireURQ''' может использовать и растровые шрифты формата '''HGE Font''' (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат '''HGE Font''', входит в дистрибутив (папка '''fonted''').

Пример использования HGE шрифта
'''textfont = "myfont.fnt"'''

===Команда CLS===

Часто бывает так, что экран, на который уже выведен текст нужно очистить. Для того чтобы удалить весь текст, выведенный при помощи команд '''P''' и '''PLN''', существует команда '''CLS'''. У нее нет никаких параметров.

Пример:
'''pln Уйма текста.'''
'''cls'''

Результат:
 

===Другие способы вывода текста===

Иногда оказывается недостаточно команд, описанных выше. Например, вы хотите чтобы в верхнем правом углу экрана всегда отображалось количество очков, которые игрок заработал на протяжении игры. Или состояние здоровья персонажа. Или название комнаты, в которой он находится. Или все это одновременно в разных местах экрана. Тогда на помощь автору приходят текстовые [[декораторы]].

===Текст в заголовке===

Для того чтобы вывести название игры или другой текст в заголовок окна FURQ нужно поместить этот текст в системную текстовую переменную gametitle. Если переменная пуста, то в заголовке будет отображаться название файла игры.

Пример:
'''gametitle = “Крокодил”'''

Результат:

[[Изображение:Furq_titlebar.png]]

''; Иногда эту переменную удобно использовать при отладке игры, временно выводя в нее, к примеру, значения других переменных.''

= Переходы =

Любой текстовый квест можно разбить на локации с текстом и переходы между ними. Из каждой локации к другим локациям обычно ведет несколько переходов, которые обозначают некоторые альтернативные варианты действий. В этой главе мы рассмотрим способы, которыми URQL позволяет сделать переходы в игре.

==Переход по кнопкам (оператор BTN)==

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

Общее обозначение: btn <локация>, <надпись на кнопке>]

Где <локация> - имя метки, на которую будет совершен переход, <надпись на кнопке> - надпись на кнопке, которая отображается на экране. В случае если <надпись на кнопке> не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
'''btn лес,Войти в лес'''
Эта команда выведет на экран кнопку с текстом '''Войти в лес''', ведующую на локацию '''лес'''

'''''Примечание 1: пробелы до и после надписи на кнопке игнорируются.'''''

'''''Примечание 2: если локация не найдена, то кнопка выводится с пометкой // phantom.'''''

'''''Примечание 3: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

У кнопок есть так называемое "эхо". Это сообщение, выводящееся на экран о том, что вы перешли по кнопке. Чтобы оно не выводилось, следует использовать переменную '''hide_btn_echo'''. Если установить её в единицу, то сообщения показываться не будут.

'''''Пример:'''''
'''hide_btn_echo = 1'''

===Команда CLSB===

Бывает так, что нам не нужно очищать весь экран, а нужно стереть только кнопки действий. Для того чтобы удалить кнопки выведенные командой '''BTN''', существует команда '''CLSB'''. У нее нет никаких параметров.

Пример:
'''btn север, Идти на Север'''
'''clsb'''
'''btn юг, Идти на Юг'''

Результат (текст на выведенной кнопке):
'''Идти на Юг'''
 

===Оформление кнопок в Fireurq===

Оформление кнопок делается в файле skin.xml
Описание можно найти в статье [[FireURQ:Скины|FireURQ:Скины]].

==Переход по ссылке==

FireURQ позволяет использовать в тексте (и декораторах) ссылки.

'''''Формат ссылок:'''''
'''<nowiki>[[текст ссылки|название локации]]</nowiki>'''

'''''Пример:'''''
'''pln Вы стоите рядом с покосившимся <nowiki>[[домиком|домик_осмотреть]]</nowiki>. Вокруг раскинулись <nowiki>[[клумбы с аромантными цветами|клумбы_осмотреть]]</nowiki>.'''

Здесь '''домик_осмотреть''' и '''клумбы_осмотреть''' - названия локаций, на которые будут осуществляться переходы при нажатии на ссылку.

Цвет ссылок задаётся переменными linkcolor и linkhcolor. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши.

'''''Пример:'''''
'''linkcolor = 0xffffff'''
'''linkhcolor = 0x0000ff'''
В данном примере цвет ссылок в тексте будет белым, а при наведении станет синим.

Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

'''''Упрощенный формат вывода ссылок такой:'''''
'''<nowiki>[[текст ссылки]]</nowiki>'''

В данном случае ссылка будет вести на метку под названием "текст ссылки".

'''''Пример:'''''
'''pln На волнах раскачивается деревянная <nowiki>[[лодка]]</nowiki>.'''

Здесь, при клике на ссылку произойдет переход на метку "лодка".

'''''Замечание: не рекомендуется называть метки именами с пробелами, соответственно не стоит использовать ссылки типа <nowiki>[[деревянная лодка]]</nowiki>, которые ведут на локации с такими именами.'''''

У ссылок, как и у btn есть "эхо", то есть в окне игры пишется, что вы перешли по ссылке. Чтобы его отключить, следует использовать переменную '''hide_link_echo'''. Если установить её в 1, то "эхо" выводиться не будет.

'''''Пример:'''''
'''hide_link_echo = 1'''

'''''Примечание: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

==Переход по оператору GOTO==

'''''Синтаксис:'''''
'''GoTo Метка'''

После выполнения оператора '''goto''' происходит мгновенное перемещение на указанную метку. При наличии локации common (см. ниже) операторы на локации common при переходе по '''goto''' НЕ ВЫПОЛНЯЮТСЯ. Это сделано специально и умышленно - чтобы можно было делать переходы внутри локации.

Примечание: в случае не нахождения метки, goto просто игнорируется.

'''''Пример:'''''
'''goto лес'''
Этот код произведёт перемещение на локацию с названием ''''лес'''.

==Переход по оператору PROC==

'''''Синтаксис:'''''
'''Proc Метка'''

При вызове данного оператора происходит переход на указанную метку и выполнение программы, до встречи первого end, потом управление передается оператору, следующему непосредственно за '''proc''', откуда команда была вызвана. Допустима любая вложенность '''proc'''-вызовов (вплоть до использования рекурсии!).

Нормально обрабатываются последовательные переходы по '''proc''' - цепочка ведется до тех пор, пока не встретится первый end. При этом кнопки во всех пройденных локациях накапливаются(!), но при обнаружении end'а происходит не опрос пользователя, а возврат к предыдущему proc'у и так до самого начала цепочки.

'''''Пример:'''''
''':берег_реки'''
'''pln Вы стоите на берегу реки, позади вас Туманный лес.'''
'''proc лес'''
'''pln Отсюда только одна дорога - на запад.'''
'''end'''
''';----------'''
''':лес'''
'''pln Из леса на вас поглядывают волки.'''
'''end'''

При выполнении этот код выведет на экран следующее:

Вы стоите на берегу реки, позади вас Туманный лес.
Из леса на вас поглядывают волки.
Отсюда только одна дорога - на запад.

То есть, после выполнения по '''proc''' локации '''лес''', мы вернёмся в локацию '''берег_реки''' и продолжим с того места, на котором был вызов команды '''proc'''.

'''''Важно:''''' При наличии локации common (см. ниже) операторы на локации common при переходе по '''proc''' НЕ ВЫПОЛНЯЮТСЯ и системная переменная '''current_loc''' не меняется.

'''Примечание:''' Часто из метки вызванной с помощью '''proc''' ведёт вызов '''goto''' и далее. В таком случае, если мы не хотим возврата к первой локации, нужно использовать оператор '''forget_procs'''

==Переход по декораторам TEXTBUTTON и IMGBUTTON==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Декораторы'''.

==Контекстное меню==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Выпадающие меню'''.

==Параметры при переходах==

Локальные параметры при переходах возможно передать параметры.

Общее обозначение: <метка>(param1, param2, ...)

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные <метка>_1, <метка>_2 и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).

Важное замечание: при использовании параметров в операторе btn подстановки (#...$ и #%...$) раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.

'''''Пример:'''''
'''btn лес(1,"опушка"),Войти в лес'''
На локации '''лес''', переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''

то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''

Параметры при переходах очень удобны для организации проверок внутри локации.

'''''Замечание:''''' Если вы передаёте параметры метке, то её название не должно начинаться с цифры, то есть исключены названия вроде '''25''' или '''40метро'''. Если вы хотите использовать цифры в названии, то ставьте их после букв, к примеру - '''метро40'''.

= Музыка и звук =

В '''FURQ''' есть целый ряд команд для воспроизведения аудио. Оно может быть всевозможных форматов: WAV, AIFF, MP3, MP2, MP1, OGG, MIDXM, IT, S3M, MOD, MTM, UMX. Есть возможность тонкого регулирования громкости звука.

Для начала запасемся на ресурсах, где свободно распространяют звуки (например, www.freesound.org) или запишем сами материала для проигрывания.

==Play==

Команда '''Play''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''play [loop|stop] [<имя файла>[, <громкость>]]'''

Чтобы просто запустить звук на проигрывание с помощью play напишите после команды имя файла. Например, нужно проиграть некий звук крокодила ''alligator.ogg''. Для этого пишем:
'''play alligator.ogg'''

Если файл alligator.ogg лежит рядом с файлом игры, то мы услышим нечто. Но если мы для удобства положим все звуки в отдельную папку sounds, то придется написать так:
'''play sounds/alligator.ogg'''

В нашем примере звук крокодила будет звучать всего один раз, однако, при помощи параметра '''loop''' мы сможем заставить крокодила двигаться и звучать бесконечно:
'''play loop sounds/alligator.ogg'''

Теперь звук будет повторяться снова и снова. Остановить его сможет только параметр '''stop''':
'''play stop sounds/alligator.ogg'''

При помощи '''Play''' можно одновременно проигрывать несколько звуков. Кроме того, можно регулировать громкость звука, добавив к команде play через запятую значение от '''0''' (полная тишина) до '''255''' (максимальная громкость). По умолчанию, '''play''' играет аудио с максимальной громкостью.

К примеру, мы хотим, одновременно наслаждаться звуком крокодила и чмоканием болота, но так, чтобы крокодил был слышен громче:
'''play loop sounds/alligator.ogg'''
'''play loop sounds/swamp.wav, 100'''

Чтобы остановить сразу все звуки, запущенные командой '''play''', мы применим такую на первый взгляд абсурдную команду как:
'''play stop'''

''; Важно помнить, что звуки запущенные на одной локации через '''play''' с параметром '''loop''' без новой команды с параметром '''stop''' сами собой не прекратятся, даже если вы перешли на другую локацию. И если вы вдруг оттуда вернетесь на прежнюю локацию, то те же самые звуки запустятся еще раз. Добро пожаловать в какафонию.''

==Voice==

Команда '''Voice''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''voice <имя файла>'''
'''voice stop'''

Команда предназначена специально для озвучивания игры голосом. Например, ей удобно запускать записи реплик персонажей или рассказчика. Во многом она аналогична команде '''play''', но с несколькими важными особенностями:
Проигрывать можно только одну реплику/звук одновременно(запуск другой озвучки через команду voice останавливает предыдущую).

Переход на другую локацию по кнопке ('''btn''') останавливает озвучку.

Громкость здесь регулируется числовой переменной '''voice_volume''' (от '''0''' до '''255''').

Остановить проигрывание файла можно при помощи команды '''voice stop'''.

Если вам необходимо чтобы прозвучало несколько реплик на одной локации, то достаточно удобно использовать команду voice в связке с командой '''anykey'''. Прослушав реплику, игрок будет нажимать на любую клавишу и слушать следующую.

Например:

'''voice_volume=200'''
'''pln - Еще раз здравствуй. - сказал крокодил и придвинулся поближе.'''
'''voice sounds/helloagain.ogg'''
'''anykey'''
'''pln Вам стало не по себе.'''
'''voice sounds/SCREAM.wav'''

==Music==

Кроме форматов аудиофайлов, которые воспроизводят команды '''play''' и '''voice''', команда '''music''' проигрывает еще и трекерную музыку (XM, IT, S3M, MOD, MTM, UMX), MIDI-файлы (MID) и MO3.

Формат команды:
'''music <имя файла>|stop[, <время в миллисекундах>]'''

Зацикливание проигрывания устанавливается в переменной music_looped ('''0''' - играть один раз, '''1''' - играть бесконечно). По умолчанию, вот отличие от команд '''play''' и '''voice''', здесь музыка зациклена.

''; некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.

''Громкость воспроизведения регулируется переменной music_volume (от '''0''' до '''255''').

С помощью команды '''music''' можно проигрывать только один файл одновременно, однако, можно задавать время, в течении которого громкость следующего аудиофайла будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект '''crossfade''' – старый трек будет угасать, а новый – нарастать по громкости.

Так “'''music stop'''” останавливает воспроизведение музыки. А если указать в качестве параметра время, то воспроизведение остановится через заданный промежуток.
'''music stop, 1500 ''; остановить музыку через 1,5 секунды'''''

===fademusic===

С помощью команды '''fademusic''' можно добиться плавного и красивого изменения громкости музыки.
Формат команды:
'''fademusic <громкость>, <время в миллисекундах>'''
громкость – целевая громкость музыки.

время в миллисекундах – время, в течении которого громкость достигнет целевого значения.

Предположим, что мы хотим сделать красивое и удобное включение и выключение музыки в нашей игре. Для этого используем [[инвентарь]] '''URQ'''. Игрок в любой момент сможет через пункт меню инвентаря включить и выключить музыку, а мы постараемся, чтобы это было плавно. На самом деле выключать музыку совсем мы не будем, а будем только понижать громкость до нуля, но зато нам не придется задаваться вопросом какой именно файл запускать при включении музыки.

В начале игры создадим элемент инвентаря “музыка” и присвоим ему наклейку “выключить музыку”:
'''inv+ музыка'''
'''idisp_музыка = "выключить музыку"'''
Запускаем любую музыку, в любом месте игры:
'''music music\Joe Hisaishi - Пылью на твоих руках.mp3'''
Теперь, в локации, которая отвечает за наш элемент инвентаря “музыка” используем оператор '''fademusic''':
''':Use_музыка'''
'''if idisp_музыка == "включить музыку" then idisp_музыка = "выключить музыку" & fademusic 255, 1500 else idisp_музыка = "включить музыку" & fademusic 0, 1500'''
'''end'''
Теперь по нажатию на “выключить музыку” громкость будет плавно затихать до нуля за 1,5 секунды, а по нажатию на “включить музыку” - так же плавно возрастать.

=Функции=

==Случайное значение Rnd==

Иногда полезно - особенно, если не злоупотреблять этим, ввести в квест элемент случайности, непредсказуемости. Именно для этого был введен механизм случайности: Rnd[x] - системная переменная (только для чтения) которая при пустом значении x хранит в себе случайное значение от 0 до 1, включая 1, а при целом x (к примеру, X=6) выдает выдает целые значения (от 1 до 6 включительно в нашем случае). При каждом обращении к переменной она принимает другое значение.

'''случай1 = rnd''' ;В результате переменная случай1 равна, например, 0.78

'''случай2 = rnd4''' ;В результате переменная случай2 равна, например, 3

==Ввод текста INPUT==

В урке есть возможность ввести строку, значение которой будет потом присвоено указанной переменной.

При необходимости ввести с клавиатуры русский текст через оператор '''input''' в строковую переменную ее следует предварительно объявить выражением:
'''строка = ""'''; Данное выражение создает строковую переменную нулевой длины.

'''pln Введите строку: & input строка'''

На экране мы увидим:
'''Введите строку:'''

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

FireURQ:Руководство пользователя

2017-03-21T12:32:52Z

Ajenta: /* Шрифт */

=Метки=

Метка - одно из важнейших понятий URQL. Она служит для выделения места в квесте, куда затем предстоит перейти. Любые перемещения в квесте могут быть либо на следующий оператор, либо на метку. Все метки имеют имена, чтобы потом можно было указывать, куда вы хотите перейти.
Определяется метка при помощи двоеточия. Все, что правее этого символа, до разделителя, которым является символ конец абзаца (Enter) или '&' - имя метки:

''':Имя_метки'''

Метка и следующий за ней оператор end являются принятой единицей измерения игры - локацией. Между ними обычно пишется описание локации и переходы из неё в другие локации.

''':начало'''
'''end'''

Например, допустимыми именами меток являются:

''':1'''
''':01'''
''':а'''
''':кот1'''
''':@(a)%^Очень_Длинная_и_Запутанная_метка_какими-лучше-не-пользоваться!!!!!_horror_так_как_сами_потом_забудете_как_она_называется!Или_сделаете_ошибку!'''
'''Вы_же_можете_сделать_маленькую_ошибку_в таком_длинном_названии?'''
''':house_flat1'''

'''''Примечание:''''' метка должна начинаться с начала строки и отделяться от других операторов (Enter) или '&', регистр имени метки не важен.

:BIG
:bIG
:Big
:big
- все эти метки для интерпретатора совершенно одинаковы. Но лучше, в целях собственного удобства, придерживаться единого стиля.

В метке лучше не делать пробелов. Длина метки не ограничена, но для удобства автора квеста лучше не делать меток длиннее строки. В метке допускаются символы, обозначающие буквы русского и латинского алфавита, цифры, знак подчеркивания и знаки арифметических операций + и - (лучше не злоупотреблять странными названиями).

Недопустимы символы ''';''' '''/*''' '''*/''' '''&'''

Грамотное использование имен меток способно серьезно облегчить работу автора.

=Текст=
==Вывод текста==

Поскольку мы имеем дело с текстовыми играми, важнейшим для нас является вывод текста. В FURQ существует несколько способов вывода текста.

===Текст на экране===

Простейший способ вывести текст это использовать команды '''P''' и '''PLN'''. Советую освоить их, прежде чем переходить к другим способам вывода.

Формат команд:
'''p''' [текст]
'''pln''' [текст]

Регистр команд не имеет значения ('''pLn''' = '''PLN''' = '''Pln''').

На практике это выглядит так:
'''p''' Этот текст появится на экране.
или
'''pln''' Этот текст тоже появится на экране.

Каждая последующая команда '''P''' или '''PLN''' дописывает новый текст к тексту который уже есть на экране. Когда текста становится слишком много, появляется возможность его прокрутить.

Разница этих двух команд в следующем - '''P''' просто добавляет новый текст, а '''PLN''' добавляет текст и делает переход на новую строку (создает абзац).

Например:
'''p''' А
'''p''' Б

Выдаст “АБ”, тогда как

'''pln''' А
'''pln''' Б

Выдаст:
А
Б

Чаще всего пользуются командой '''pln''', однако и '''p''' может быть полезна, например, когда строчка текста, которую мы хотим вывести на экран, состоит из нескольких частей и зависит от каких-либо переменных или условий.

Команды '''P''' и '''PLN''' могут напрямую выводить любые символы (кроме символа комментария '''“;”'''), переменные и ссылки.

===Вывод переменных===

Вывод переменных возможен в двух вариантах - числовом и текстовом. Для того чтобы их вывести, нужно заключить имена переменных в соответствующие скобки:
'''pln''' '''#%'''имя_текстовой_переменной'''$''' '''#'''имя_числовой_переменной'''$'''
Несмотря на внешнее сходство, они отличаются содержанием и символом '''%'''. Если в числовые скобки попадет текстовая переменная, то на выводе окажется не текст, а количество символов в этой переменной. И наоборот, если числовая переменная попадет в текстовые скобки, то на выводе окажется пустота.

Выведем оба типа переменных на экран:

'''текстовая_переменная="Геннадий"'''
'''числовая_переменная=42'''
'''pln''' Крокодил схватил вас за ногу и сказал:
'''pln''' - Меня зовут '''#%текстовая_переменная$'''.
'''pln''' Затем крокодил схватил вас за другую ногу и сказал:
'''pln''' - Мне '''#числовая_переменная$''' года. Давай, ты станешь моим близким другом.

Результат:
Крокодил схватил вас за ногу и сказал:
- Меня зовут Геннадий.
Затем крокодил схватил вас за другую ногу и сказал:
- Мне 42 года. Давай, ты станешь моим близким другом.

Кроме того, в '''URQL''' есть специальные обозначения для вывода символа пробела - '''#$''', вывода символа переноса строки - '''#/$''' и вывода символа по ascii-коду - '''##'''ascii-код'''$'''.

Так, например, символ комментария можно вывести на экран, через его ascii-код:
'''pln''' Моя грамотность была на исходе'''##59$''' но, несмотря на это, я поставил точку с запятой в предложении.

Результат:
Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.

Хочу напомнить, что если бы мы написали в коде просто:
'''pln''' Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.
То получили бы на экране:
Моя грамотность была на исходе
Потому что символ ";" и все что после него идет было бы обработано как комментарий.

'''Примечание:'''
Вывод строковой переменной, как числа '''#текстовая_переменная$''' даст нам количество символов в строке.

==Оформление текста==

В 21 веке в '''FURQ''' текст это не просто набор символов, но еще и набор гарнитур, цвет, выравнивание и местоположение.

===Местоположение===
Область экрана, куда выводят текст команды '''p''' и '''pln''' можно двигать, делать шире, уже, выше и т.д. Для этого служат системные переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height''', которые описывают некий прямоугольник куда и выводится текст. По умолчанию он занимает почти весь экран. Это числовые переменные, которые содержат значения в пикселях.

Давайте, используя полученные нами знания, выведем значения этих переменных на экран:
'''pln''' Левая граница='''#textpane_left$''', Верхняя граница='''#textpane_top$''', Ширина='''#textpane_width$''', Высота='''#textpane_height$'''

Результат:
Левая граница=20, Верхняя граница=55, Ширина=760, Высота=525

Вы можете изменять значения этих переменных как угодно в любом месте игры. Например, вы хотите вывести справа от текста картинку: измените ширину ('''textpane_width''') так чтобы текст не мешал. А когда картинка больше не нужна измените ширину обратно. Экспериментируйте.

===Выравнивание текста===

За выравнивание текста отвечает команда числовая системная переменная textalign. Она сообщает FURQ как должен быть расположен текст относительно области его вывода.

Лучше всего это понять на примере:
'''textalign = 1'''
'''pln''' текст выравнивается влево
'''textalign = 2'''
'''pln''' текст выравнивается вправо
'''textalign = 3'''
'''pln''' текст выравнивается по центру

''; Главное теперь не забыть, поменять переменную обратно на '''1''', если вы не хотите, чтобы текст всей игры был выравнен по центру.''

===Цвет===

Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате '''0xAARRGGBB'''. То есть четыре составляющих: альфа, красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.

Встроенная функция '''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255''' (т.е. полностью видимый цвет).

Пример:
'''proc''' _color(x+15, 10, 255, 60)
'''textcolor = _result'''

===Шрифт===

Для определения шрифта, которым будет выводиться текст, используется переменная '''textfont'''. В нее в виде строкового значения следует записать имя файла шрифта.

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

'''FireURQ''' имеет встроенные шрифты с засечками (serif) и без засечек (sans) во всех начертаниях — полужирном (bold), наклонном (italic) и полужирном наклонном (bold-italic).
Чтобы использовать эти шрифты в игре, достаточно написать '''textfont = «serif-italic[25]»''' и у вас будет наклонный шрифт 25-го размера с засечками.

Формат использования шрифта такой:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]'''

*'''size''' – размер шрифта(по умолчанию '''19'''), а точнее высота строки в пикселях
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')

Допустим, мы хотим вывести текст шрифтом Georgia.

Для этого пишем:
'''textfont = "georgia.ttf"'''
И сразу же проверяем результат, при помощи оператора вывода текста '''pln''', который мы уже освоили в совершенстве:
'''pln Крокодил зарылся в ил, крокодила ил манил'''

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

Меняем размер на 42:
'''textfont = "georgia.ttf[42]"'''

Остальные параметры команды нужны, чтобы текст, который будет выведен на экран выглядел еще более красиво (например, при стандартных параметрах текст может выглядеть не слишком хорошо на светлом фоне). В параметре '''bgcolor''', конечно, лучше задать цвет фона, на котором будет выведен текст. Другие параметры подбираются скорее на глаз, чем по науке.

Примеры:
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

Чтобы, после манипуляций с текстом, вернуться к шрифту по умолчанию, следует выполнить:
'''textfont = "_sysfont"'''

'''FireURQ''' может использовать и растровые шрифты формата '''HGE Font''' (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат '''HGE Font''', входит в дистрибутив (папка '''fonted''').

Пример использования HGE шрифта
'''textfont = "myfont.fnt"'''

===Команда CLS===

Часто бывает так, что экран, на который уже выведен текст нужно очистить. Для того чтобы удалить весь текст, выведенный при помощи команд '''P''' и '''PLN''', существует команда '''CLS'''. У нее нет никаких параметров.

Пример:
'''pln Уйма текста.'''
'''cls'''

Результат:
 

===Другие способы вывода текста===

Иногда оказывается недостаточно команд, описанных выше. Например, вы хотите чтобы в верхнем правом углу экрана всегда отображалось количество очков, которые игрок заработал на протяжении игры. Или состояние здоровья персонажа. Или название комнаты, в которой он находится. Или все это одновременно в разных местах экрана. Тогда на помощь автору приходят текстовые [[декораторы]].

===Текст в заголовке===

Для того чтобы вывести название игры или другой текст в заголовок окна FURQ нужно поместить этот текст в системную текстовую переменную gametitle. Если переменная пуста, то в заголовке будет отображаться название файла игры.

Пример:
'''gametitle = “Крокодил”'''

Результат:

[[Изображение:Furq_titlebar.png]]

''; Иногда эту переменную удобно использовать при отладке игры, временно выводя в нее, к примеру, значения других переменных.''

= Переходы =

Любой текстовый квест можно разбить на локации с текстом и переходы между ними. Из каждой локации к другим локациям обычно ведет несколько переходов, которые обозначают некоторые альтернативные варианты действий. В этой главе мы рассмотрим способы, которыми URQL позволяет сделать переходы в игре.

==Переход по кнопкам (оператор BTN)==

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

Общее обозначение: btn <локация>, <надпись на кнопке>]

Где <локация> - имя метки, на которую будет совершен переход, <надпись на кнопке> - надпись на кнопке, которая отображается на экране. В случае если <надпись на кнопке> не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
'''btn лес,Войти в лес'''
Эта команда выведет на экран кнопку с текстом '''Войти в лес''', ведующую на локацию '''лес'''

'''''Примечание 1: пробелы до и после надписи на кнопке игнорируются.'''''

'''''Примечание 2: если локация не найдена, то кнопка выводится с пометкой // phantom.'''''

'''''Примечание 3: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

У кнопок есть так называемое "эхо". Это сообщение, выводящееся на экран о том, что вы перешли по кнопке. Чтобы оно не выводилось, следует использовать переменную '''hide_btn_echo'''. Если установить её в единицу, то сообщения показываться не будут.

'''''Пример:'''''
'''hide_btn_echo = 1'''

===Команда CLSB===

Бывает так, что нам не нужно очищать весь экран, а нужно стереть только кнопки действий. Для того чтобы удалить кнопки выведенные командой '''BTN''', существует команда '''CLSB'''. У нее нет никаких параметров.

Пример:
'''btn север, Идти на Север'''
'''clsb'''
'''btn юг, Идти на Юг'''

Результат (текст на выведенной кнопке):
'''Идти на Юг'''
 

===Оформление кнопок в Fireurq===

Оформление кнопок делается в файле skin.xml
Описание можно найти в статье [[FireURQ:Скины|FireURQ:Скины]].

==Переход по ссылке==

FireURQ позволяет использовать в тексте (и декораторах) ссылки.

'''''Формат ссылок:'''''
'''<nowiki>[[текст ссылки|название локации]]</nowiki>'''

'''''Пример:'''''
'''pln Вы стоите рядом с покосившимся <nowiki>[[домиком|домик_осмотреть]]</nowiki>. Вокруг раскинулись <nowiki>[[клумбы с аромантными цветами|клумбы_осмотреть]]</nowiki>.'''

Здесь '''домик_осмотреть''' и '''клумбы_осмотреть''' - названия локаций, на которые будут осуществляться переходы при нажатии на ссылку.

Цвет ссылок задаётся переменными linkcolor и linkhcolor. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши.

'''''Пример:'''''
'''linkcolor = 0xffffff'''
'''linkhcolor = 0x0000ff'''
В данном примере цвет ссылок в тексте будет белым, а при наведении станет синим.

Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

'''''Упрощенный формат вывода ссылок такой:'''''
'''<nowiki>[[текст ссылки]]</nowiki>'''

В данном случае ссылка будет вести на метку под названием "текст ссылки".

'''''Пример:'''''
'''pln На волнах раскачивается деревянная <nowiki>[[лодка]]</nowiki>.'''

Здесь, при клике на ссылку произойдет переход на метку "лодка".

'''''Замечание: не рекомендуется называть метки именами с пробелами, соответственно не стоит использовать ссылки типа <nowiki>[[деревянная лодка]]</nowiki>, которые ведут на локации с такими именами.'''''

У ссылок, как и у btn есть "эхо", то есть в окне игры пишется, что вы перешли по ссылке. Чтобы его отключить, следует использовать переменную '''hide_link_echo'''. Если установить её в 1, то "эхо" выводиться не будет.

'''''Пример:'''''
'''hide_link_echo = 1'''

'''''Примечание: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

==Переход по оператору GOTO==

'''''Синтаксис:'''''
'''GoTo Метка'''

После выполнения оператора '''goto''' происходит мгновенное перемещение на указанную метку. При наличии локации common (см. ниже) операторы на локации common при переходе по '''goto''' НЕ ВЫПОЛНЯЮТСЯ. Это сделано специально и умышленно - чтобы можно было делать переходы внутри локации.

Примечание: в случае не нахождения метки, goto просто игнорируется.

'''''Пример:'''''
'''goto лес'''
Этот код произведёт перемещение на локацию с названием ''''лес'''.

==Переход по оператору PROC==

'''''Синтаксис:'''''
'''Proc Метка'''

При вызове данного оператора происходит переход на указанную метку и выполнение программы, до встречи первого end, потом управление передается оператору, следующему непосредственно за '''proc''', откуда команда была вызвана. Допустима любая вложенность '''proc'''-вызовов (вплоть до использования рекурсии!).

Нормально обрабатываются последовательные переходы по '''proc''' - цепочка ведется до тех пор, пока не встретится первый end. При этом кнопки во всех пройденных локациях накапливаются(!), но при обнаружении end'а происходит не опрос пользователя, а возврат к предыдущему proc'у и так до самого начала цепочки.

'''''Пример:'''''
''':берег_реки'''
'''pln Вы стоите на берегу реки, позади вас Туманный лес.'''
'''proc лес'''
'''pln Отсюда только одна дорога - на запад.'''
'''end'''
''';----------'''
''':лес'''
'''pln Из леса на вас поглядывают волки.'''
'''end'''

При выполнении этот код выведет на экран следующее:

Вы стоите на берегу реки, позади вас Туманный лес.
Из леса на вас поглядывают волки.
Отсюда только одна дорога - на запад.

То есть, после выполнения по '''proc''' локации '''лес''', мы вернёмся в локацию '''берег_реки''' и продолжим с того места, на котором был вызов команды '''proc'''.

'''''Важно:''''' При наличии локации common (см. ниже) операторы на локации common при переходе по '''proc''' НЕ ВЫПОЛНЯЮТСЯ и системная переменная '''current_loc''' не меняется.

'''Примечание:''' Часто из метки вызванной с помощью '''proc''' ведёт вызов '''goto''' и далее. В таком случае, если мы не хотим возврата к первой локации, нужно использовать оператор '''forget_procs'''

==Переход по декораторам TEXTBUTTON и IMGBUTTON==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Декораторы'''.

==Контекстное меню==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Выпадающие меню'''.

==Параметры при переходах==

Локальные параметры при переходах возможно передать параметры.

Общее обозначение: <метка>(param1, param2, ...)

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные <метка>_1, <метка>_2 и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).

Важное замечание: при использовании параметров в операторе btn подстановки (#...$ и #%...$) раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.

'''''Пример:'''''
'''btn лес(1,"опушка"),Войти в лес'''
На локации '''лес''', переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''

то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''

Параметры при переходах очень удобны для организации проверок внутри локации.

'''''Замечание:''''' Если вы передаёте параметры метке, то её название не должно начинаться с цифры, то есть исключены названия вроде '''25''' или '''40метро'''. Если вы хотите использовать цифры в названии, то ставьте их после букв, к примеру - '''метро40'''.

= Музыка и звук =

В '''FURQ''' есть целый ряд команд для воспроизведения аудио. Оно может быть всевозможных форматов: WAV, AIFF, MP3, MP2, MP1, OGG, MIDXM, IT, S3M, MOD, MTM, UMX. Есть возможность тонкого регулирования громкости звука.

Для начала запасемся на ресурсах, где свободно распространяют звуки (например, www.freesound.org) или запишем сами материала для проигрывания.

==Play==

Команда '''Play''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''play [loop|stop] [<имя файла>[, <громкость>]]'''

Чтобы просто запустить звук на проигрывание с помощью play напишите после команды имя файла. Например, нужно проиграть некий звук крокодила ''alligator.ogg''. Для этого пишем:
'''play alligator.ogg'''

Если файл alligator.ogg лежит рядом с файлом игры, то мы услышим нечто. Но если мы для удобства положим все звуки в отдельную папку sounds, то придется написать так:
'''play sounds/alligator.ogg'''

В нашем примере звук крокодила будет звучать всего один раз, однако, при помощи параметра '''loop''' мы сможем заставить крокодила двигаться и звучать бесконечно:
'''play loop sounds/alligator.ogg'''

Теперь звук будет повторяться снова и снова. Остановить его сможет только параметр '''stop''':
'''play stop sounds/alligator.ogg'''

При помощи '''Play''' можно одновременно проигрывать несколько звуков. Кроме того, можно регулировать громкость звука, добавив к команде play через запятую значение от '''0''' (полная тишина) до '''255''' (максимальная громкость). По умолчанию, '''play''' играет аудио с максимальной громкостью.

К примеру, мы хотим, одновременно наслаждаться звуком крокодила и чмоканием болота, но так, чтобы крокодил был слышен громче:
'''play loop sounds/alligator.ogg'''
'''play loop sounds/swamp.wav, 100'''

Чтобы остановить сразу все звуки, запущенные командой '''play''', мы применим такую на первый взгляд абсурдную команду как:
'''play stop'''

''; Важно помнить, что звуки запущенные на одной локации через '''play''' с параметром '''loop''' без новой команды с параметром '''stop''' сами собой не прекратятся, даже если вы перешли на другую локацию. И если вы вдруг оттуда вернетесь на прежнюю локацию, то те же самые звуки запустятся еще раз. Добро пожаловать в какафонию.''

==Voice==

Команда '''Voice''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''voice <имя файла>'''
'''voice stop'''

Команда предназначена специально для озвучивания игры голосом. Например, ей удобно запускать записи реплик персонажей или рассказчика. Во многом она аналогична команде '''play''', но с несколькими важными особенностями:
Проигрывать можно только одну реплику/звук одновременно(запуск другой озвучки через команду voice останавливает предыдущую).

Переход на другую локацию по кнопке ('''btn''') останавливает озвучку.

Громкость здесь регулируется числовой переменной '''voice_volume''' (от '''0''' до '''255''').

Остановить проигрывание файла можно при помощи команды '''voice stop'''.

Если вам необходимо чтобы прозвучало несколько реплик на одной локации, то достаточно удобно использовать команду voice в связке с командой '''anykey'''. Прослушав реплику, игрок будет нажимать на любую клавишу и слушать следующую.

Например:

'''voice_volume=200'''
'''pln - Еще раз здравствуй. - сказал крокодил и придвинулся поближе.'''
'''voice sounds/helloagain.ogg'''
'''anykey'''
'''pln Вам стало не по себе.'''
'''voice sounds/SCREAM.wav'''

==Music==

Кроме форматов аудиофайлов, которые воспроизводят команды '''play''' и '''voice''', команда '''music''' проигрывает еще и трекерную музыку (XM, IT, S3M, MOD, MTM, UMX), MIDI-файлы (MID) и MO3.

Формат команды:
'''music <имя файла>|stop[, <время в миллисекундах>]'''

Зацикливание проигрывания устанавливается в переменной music_looped ('''0''' - играть один раз, '''1''' - играть бесконечно). По умолчанию, вот отличие от команд '''play''' и '''voice''', здесь музыка зациклена.

''; некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.

''Громкость воспроизведения регулируется переменной music_volume (от '''0''' до '''255''').

С помощью команды '''music''' можно проигрывать только один файл одновременно, однако, можно задавать время, в течении которого громкость следующего аудиофайла будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект '''crossfade''' – старый трек будет угасать, а новый – нарастать по громкости.

Так “'''music stop'''” останавливает воспроизведение музыки. А если указать в качестве параметра время, то воспроизведение остановится через заданный промежуток.
'''music stop, 1500 ''; остановить музыку через 1,5 секунды'''''

===fademusic===

С помощью команды '''fademusic''' можно добиться плавного и красивого изменения громкости музыки.
Формат команды:
'''fademusic <громкость>, <время в миллисекундах>'''
громкость – целевая громкость музыки.

время в миллисекундах – время, в течении которого громкость достигнет целевого значения.

Предположим, что мы хотим сделать красивое и удобное включение и выключение музыки в нашей игре. Для этого используем [[инвентарь]] '''URQ'''. Игрок в любой момент сможет через пункт меню инвентаря включить и выключить музыку, а мы постараемся, чтобы это было плавно. На самом деле выключать музыку совсем мы не будем, а будем только понижать громкость до нуля, но зато нам не придется задаваться вопросом какой именно файл запускать при включении музыки.

В начале игры создадим элемент инвентаря “музыка” и присвоим ему наклейку “выключить музыку”:
'''inv+ музыка'''
'''idisp_музыка = "выключить музыку"'''
Запускаем любую музыку, в любом месте игры:
'''music music\Joe Hisaishi - Пылью на твоих руках.mp3'''
Теперь, в локации, которая отвечает за наш элемент инвентаря “музыка” используем оператор '''fademusic''':
''':Use_музыка'''
'''if idisp_музыка == "включить музыку" then idisp_музыка = "выключить музыку" & fademusic 255, 1500 else idisp_музыка = "включить музыку" & fademusic 0, 1500'''
'''end'''
Теперь по нажатию на “выключить музыку” громкость будет плавно затихать до нуля за 1,5 секунды, а по нажатию на “включить музыку” - так же плавно возрастать.

=Функции=

==Случайное значение Rnd==

Иногда полезно - особенно, если не злоупотреблять этим, ввести в квест элемент случайности, непредсказуемости. Именно для этого был введен механизм случайности: Rnd[x] - системная переменная (только для чтения) которая при пустом значении x хранит в себе случайное значение от 0 до 1, включая 1, а при целом x (к примеру, X=6) выдает выдает целые значения (от 1 до 6 включительно в нашем случае). При каждом обращении к переменной она принимает другое значение.

'''случай1 = rnd''' ;В результате переменная случай1 равна, например, 0.78

'''случай2 = rnd4''' ;В результате переменная случай2 равна, например, 3

==Ввод текста INPUT==

В урке есть возможность ввести строку, значение которой будет потом присвоено указанной переменной.

При необходимости ввести с клавиатуры русский текст через оператор '''input''' в строковую переменную ее следует предварительно объявить выражением:
'''строка = ""'''; Данное выражение создает строковую переменную нулевой длины.

'''pln Введите строку: & input строка'''

На экране мы увидим:
'''Введите строку:'''

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

FireURQ:Особенности реализации URQL

2017-03-21T12:27:59Z

Ajenta: /* Предопределенные функции */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://www.ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) ищутся сначала в папке игры (в архиве '''QSZ'''), а если их там нет, то в системной папке со шрифтами Windows. Т.е. если это системный шрифт, прикладывать его к игре не нужно.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль.
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительного команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, существует возможность конвертации квеста в формате QSZ в исполняемый файл. Для этого следует использовать утилиту '''QSZ2EXE''', которая входит в комплект поставки. Эта консольная утилита находится в папке на диске, которую вы выбрали при инсталляции '''FireURQ'''.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, n)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.
== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логии прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

FireURQ:Особенности реализации URQL

2017-03-21T12:27:17Z

Ajenta: /* Предопределенные функции */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://www.ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) ищутся сначала в папке игры (в архиве '''QSZ'''), а если их там нет, то в системной папке со шрифтами Windows. Т.е. если это системный шрифт, прикладывать его к игре не нужно.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль.
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительного команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, существует возможность конвертации квеста в формате QSZ в исполняемый файл. Для этого следует использовать утилиту '''QSZ2EXE''', которая входит в комплект поставки. Эта консольная утилита находится в папке на диске, которую вы выбрали при инсталляции '''FireURQ'''.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.
'''_arcsin''', '''_arccos''', '''_arctan''' и '''_sqrt''' - вычисляют арксинус, арккосинус, арктангенс и извлечение квадратного корня

'''_power(w, y)''' - вычисление степени числа. Здесь два параметра — основа и значение степени. Если оставить только x, он будет возведён в квадрат. Также, вспомнив школьный курс алгебры, с помощью '''_power''' можно извлекать корни любой степени.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.
== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логии прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

FireURQ:Особенности реализации URQL

2017-03-21T12:20:49Z

Ajenta: /* Другое */

== Операции ==

* Есть оператор '''<>''' (не равно).
* Можно производить операцию сложения над строками. Т.е. можно сделать '''zz = xx + "urq"''' – и это будет работать, при условии, что '''xx''' — строковая переменная.
* Числовое представление строки — всегда число: длина этой строки. Это касается всех арифметических операций. Строковое представление числовой переменной — пустая строка (как в досурке).

==Подстановки (#...$ и #%...$)==
Работают только в пределах одного оператора. Т.е. вставить if с помощью подстановки — не получится, т.к. '''if...then...else''' — это конструкция языка, а не оператор.

Подстановка #...$ работает для числовых значений переменных, тогда как #%...$ для текстовых. Для подробностей см. [http://www.ifwiki.ru/FireURQ:%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#.D0.92.D1.8B.D0.B2.D0.BE.D0.B4_.D0.BF.D0.B5.D1.80.D0.B5.D0.BC.D0.B5.D0.BD.D0.BD.D1.8B.D1.85 руководство].

==Параметры при переходах==
При переходах (операторы '''proc''', '''btn''' и '''goto''') возможно передать параметры на метку, на которую происходит переход.
''Синтаксис:''
'''goto <метка>[(param1, param2, ...)]'''
'''proc <метка>[(param1, param2, ...)]'''
'''btn <метка>[(param1, param2, ...)], <текст на кнопке>'''

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные '''<метка>_1''', '''<метка>_2''' и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).
Возможен максимум - 50 параметров.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> при использовании параметров в операторе btn подстановки ('''#...$''' и '''#%...$''') раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.</div>

''Пример:''
'''btn mylabel(2+2, "четыре"), Кнопка с параметрами'''
При нажатии на эту кнопку переменная '''mylabel_1''' примет числовое значение '''4''', а переменная '''mylabel_2''' — строковое значение '''"четыре"'''.

==Локальные действия==
Локальные действия, это действия не уводящие с локации. Т.е. можно сделать такую кнопку или ссылку, при нажатии на которую:
* не будут очищены кнопки
* не изменится переменная '''current_loc'''
* не выполнится '''common'''-локация

Локальные действия ведут себя, в целом, так же, как действия над предметами инвентаря.

Для того, чтобы создать локальное действие, надо перед названием локации в кнопке или ссылке поставить ''восклицательный знак'':

'''btn''' '''!'''local, Эта кнопка не уведёт с локации
'''pln''' Эта '''<nowiki>[[</nowiki>'''ссылка|'''!'''local_location''']]''' тоже не уведёт с локации...

==Инклюды==
Начиная с версии 1.8 в FURQ есть возможность «собирать» код игры из нескольких файлов. Для этого следует использовать макрос '''%include <имя_файла.qst>'''.
При этом действуют следующие правила:
* Макрос инклюда должен быть один на строке.
* Инклюды обрабатываются при загрузке квеста, поэтому подстановки там не действуют.
* Каждый файл включается один раз. Другими словами, '''%include''' не вставляет код из файла в то место, где он был вызван, а просто указывает, что этот код должен присутствовать в квесте.
* Имена меток и переменных сквозные. Следите, чтобы метки в разных файлах назывались по-разному.
* Возможно использовать относительные пути, например '''%include inc\mylib.qst''', при этом путь указывается относительно того файла, в котором вызывается макрос. Т.е. если вы в вышеприведённом '''mylib.qst''' вызовете '''%include more\lowlevel.qst''', то '''lowlevel.qst''' должен лежать в папке '''inc\more\''', относительно главного файла квеста.
* Все ресурсы игры (картинки, музыка, шрифты) вызываются относительно главного файла квеста, в каких бы инклюдах и папках не находился код, их вызывающий.
* При упаковке в '''QSZ''' главный файл квеста должен называться''' main.qst''' или '''game.qst''' (qs1, qs2), чтобы интерпретатор понял, с чего начинать. Если FireURQ не найдёт такого файла в архиве, то вызовет первый попавшийся.

==Музыка и звук==
'''FireURQ''' поддерживает множество форматов музыки и звука. Командой '''play''' можно воспроизводить звуки. Музыка воспроизводится командой '''music'''.
===Звуки===

'''play [loop|stop] [<имя файла>[, <громкость>]]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG

'''громкость''' – может принимать значения от '''0''' до '''255'''

Если указать параметр '''loop''', то воспроизведение звука будет зациклено (полезно, если нужно реализовать фоновый эмбиентный звук). Если указан параметр '''stop''', то конкретный звук (все его «ипостаси», если воспроизведение конкретного звука было запущено несколько раз) будет остановлен. Если указать stop и не указать имя файла, то будут остановлены все звуки.

===Музыка===

'''music <имя файла>|stop[, <время в миллисекундах>]'''
'''имя файла''' – это имя файла формата WAV/AIFF/MP3/MP2/MP1/OGG, плюс форматы трекерной музыки: XM, IT, S3M, MOD, MTM, UMX. Кроме того, воспроизводится и MIDI-музыка (файлы MID). Также поддерживается формат MO3 (трекерная музыка с OGG-упакованными семплами). Конвертер для превращения любого трекерного формата в MO3 можно скачать с сайта http://un4seen.com/.

Если требуется остановить воспроизведение, то вместо имени файла указывается '''stop'''.

'''время в миллисекундах''' – время, в течении которого громкость музыки будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект crossfade – старый трек будет угасать, а новый – нарастать по громкости.

Для регулировки громкости музыки используется переменная '''music_volume''', которая может принимать значения от '''0''' до '''255'''.

Возможно плавное изменение громкости музыки командой '''fademusic''':
'''fademusic <громкость>, <время в миллисекундах>'''

'''громкость''' – целевая громкость музыки.

'''время в миллисекундах''' – время, в течении которого громкость достигнет целевого значения.
Кроме того, для музыки поддерживается переменная '''music_looped''', которая принимает два значения: '''1''' и '''0'''. Эта переменная указывает, будет ли воспроизводимая музыка зациклена или проиграет один раз и остановится. По умолчанию равна '''1''' (музыка зацикливается).

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.</div>

===Озвучка локаций===

'''voice <имя файла>'''
'''voice stop'''
С помощью команды '''voice''' можно удобно озвучивать локации в квестах. Действие этой команды аналогично действию команды '''play''' – проигрывается звук, указанный в качестве параметра, за несколькими исключениями:
* Озвучка может быть только одна в любой момент времени. Каждая следующая команда '''voice''' останавливает предыдущую;
* Переход по кнопке ('''btn''') также останавливает озвучку.
* Громкость озвучки регулируется с помощью переменной '''voice_volume''', а не указывается напрямую в команде.

==Изображения==

'''FireURQ''' позволяет вставлять изображения в текст квеста. Для этого служит команда '''image'''.
'''Синтаксис:'''
'''image <имя файла>[, X, Y, ширина, высота]'''
* '''имя файла''' – это имя файла изображения в формате JPEG, PNG или TGA.
* Дополнительные параметры позволяют вывести не все изображение, а его часть. При этом '''X''' и '''Y''' задают верхний левый угол окна, а ширина и высота – размеры «вырезаемого» кусочка.

Изображение вставляются в текст и ведут себя как обычные буквы. Альфа для вставляемого изображения берется из цвета текста (переменная '''textcolor ''' – см. ниже).
==Текст==
===Выравнивание текста===

'''FireURQ''' позволяет выравнивать текст влево, вправо или по центру. Для установки нужного режима выравнивания текста служит переменная '''textalign'''. Она может принимать следующие значения:
* '''1''' – текст выравнивается влево
* '''2''' – текст выравнивается вправо
* '''3''' – текст выравнивается по центру
Естественно, выравнивание работает лишь внутри одного «абзаца». Если вы выводили текст командой '''print''' (без переноса), затем сменили выравнивание и попытались что-то вывести в той же строке, то текст с другим выравниванием будет перенесен на другую строку автоматически.
Переменная '''btnalign''' позволяет выровнять кнопки действия. А '''btntxtalign''' – текст внутри кнопок (т.е. надписи на кнопках). Следует отметить, что выравнивание кнопок работает только для всех кнопок скопом. Т.е. не получится выровнять одну кнопу вправо, а другую – влево.

Расстояние между строками и параграфами определяется следующими системными переменными:
* '''linespacing''' – вертикальное расстояние между строк текста (по умолчанию '''3''')
* '''paraspacing''' – вертикальное расстояние между параграфами (по умолчанию '''3''')

'''''Пример:'''''
'''textalign = 1'''
'''btnalign = 3'''
'''btntxtalign = 3'''
Этот код выведет последующий текст с выравниванием влево, а кнопки - посередине, так же посередине будет располагаться и текст в кнопках.

===Цвет текста===
Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате 0xAARRGGBB. То есть четыре составляющих: альфа(прозрачность), красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.
'''''Пример:'''''
'''textcolor = 0xFF990000'''
Этот код изменит цвет последующего текста на оттенок красного.
Текст будет непрозрачен.

===Шрифт текста===

Для определения шрифта, которым будет выводиться текст, используется переменная textfont. В нее в виде строкового значения следует записать имя файла шрифта. FireURQ может использовать растровые шрифты формата HGE Font (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат HGE Font, входит в дистрибутив (папка '''fonted''').

Чтобы вернуться к шрифту по умолчанию, следует выполнить '''textfont = "_sysfont"'''.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> вполне возможно писать разными шрифтами внутри одного абзаца текста. Но этого не рекомендуется делать со шрифтами разных размеров. Формат HGE Font не предусматривает такое понятие, как «базовая линия». Поэтому, куски текста, написанные разными шрифтами, будут «прыгать» относительно друг друга.</div>

TrueType шрифты используются так:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]"'''
*'''size''' – размер шрифта(по умолчанию '''19''')
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')
Параметры можно опускать.

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> Поскольку из TTF генерится битмапный шрифт и края должны "подходить" к фону, на котором потом выводится текст, то для идеального отображения шрифта можно подставить соответствующий цвет в '''bgcolor'''. '''Gamma''' и '''weight''' по умолчанию подобраны для шрифтов на чёрном фоне. Возможно, для светлого фона их нужно немного поменять.</div>

'''''Примеры:'''''
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

'''''Пример использования в игре:'''''
'''textfont = "georgia.ttf[18, 1.0, 0.1, 0x000000]"'''
Такой шрифт идеально подойдёт для светлых фонов

Файлы TrueType шрифтов (.ttf) ищутся сначала в папке игры (в архиве '''QSZ'''), а если их там нет, то в системной папке со шрифтами Windows. Т.е. если это системный шрифт, прикладывать его к игре не нужно.

Шрифты таким образом можно использовать как в коде игры, так и в [[FireURQ:Скины|скинах]].

=== Кнопки ===
'''FireURQ''' позволяет использовать в тексте кнопки. Кнопки всегда расположены после выведенного текста и используются для переходов по меткам.
Начиная с версии 1.9.1, формат кнопок таков:
'''btn''' <локация>[(param1, param2, ...)][, <надпись на кнопке>]
Где '''<локация>''' - имя метки, на которую будет совершен переход, '''param1''', '''param1''' и т.д. - параметры, передаваемые в эту локацию, '''<надпись на кнопке>''' - надпись на кнопке, которая отображается на экране. В случае если '''<надпись на кнопке>''' не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
Можно написать без параметров:
'''btn лес,Войти в лес'''
а можно добавить параметры:
'''btn лес(1,"опушка"),Войти в лес'''
В обоих случаях этот код сделает кнопку с надписью '''Войти в лес''', ведущую на локацию '''лес'''
но во втором варианте, на локации лес, переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''
то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''
Это очень удобно для организации проверок внутри локации.

===Ссылки===

'''FireURQ''' позволяет использовать в тексте (и декораторах) ссылки.

Формат ссылок:
<nowiki>[[текст ссылки|название локации]]</nowiki>

Пример:
'''pln''' Вы стоите на берегу реки. Вдоль берега вьётся небольшая <nowiki>[[тропинка|trop]]</nowiki>...

Здесь '''trop''' - название локации, на которую будет осуществлён переход при нажатию на ссылку. Разумеется, как и в '''btn''', можно использовать параметры локации.

Цвет ссылок задаётся переменными '''linkcolor''' и '''linkhcolor'''. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши. Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

Упрощенный формат вывода ссылок такой:
<nowiki>[[текст ссылки]]</nowiki>
В данном случае ссылка будет вести на метку по названием "текст ссылки".

Пример:
'''pln''' Вдоль берега вьётся <nowiki>[[тропинка]]</nowiki>...

Здесь, при клике на ссылку произойдет переход на метку "тропинка". Можно добавлять модификаторы, например '''<nowiki>[[%меню]]</nowiki>''' — модификатор на экран не выводится.

В ссылках есть возможность использовать [http://ifwiki.ru/index.php?title=FireURQ:%D0%9E%D1%81%D0%BE%D0%B1%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D0%B8_%D1%80%D0%B5%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8_URQL#.D0.9B.D0.BE.D0.BA.D0.B0.D0.BB.D1.8C.D0.BD.D1.8B.D0.B5_.D0.B4.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B8.D1.8F локальные действия] (действия, которые не уводят на другую локацию).

===Выпадающие меню===
Начиная с версии 1.6 в '''FireURQ''' появилась возможность использовать меню, выпадающие при клике на ссылку или на кнопку . Меню формируются точно так же как обычные ссылки или кнопки с использованием символа '''%''' и могут быть любого уровня вложенности.

Общий синтаксис такой:
btn '''%'''<Название локации>, <Текст на кнопке>
[[ <Текст ссылки> | '''%'''<Название локации>]]

'''Пример'''
'''btn''' '''%'''menu, По этой кнопке будет меню

''':menu'''
'''btn''' someloc, Первый пункт меню
'''btn''' anotherloc, Второй пункт меню
'''btn''' yetonemoreloc, Третий пункт меню
'''end'''

Все кнопки в меню-локации превращаются в пункты меню. В меню-локациях не разрешается использовать практически ничего, кроме конструкций '''if..then..else'''', '''goto''', '''proc''', '''btn''' и работы с переменными, которые можно назначать и проверять. Все фантомные '''btn''' (ведущие на несуществующую локацию) становятся неактивными пунктами меню.

Если в качестве имени кнопки использовать "-" (дефис), то в меню будет вставлена полоска-разделитель.

Переменные для оформления меню (их тоже можно указывать прямо в меню-локации):

'''menu_textfont''' - шрифт меню
'''menu_bgcolor''' - цвет фона (можно делать и полупрозрачным)
'''menu_bordercolor''' - цвет рамки
'''menu_textcolor''' - цвет пунктов меню
'''menu_hindent''' - отбивка по горизонтали
'''menu_vindent''' - отбивка по вертикали
'''menu_selectioncolor''' - цвет фона выбранного элемента
'''menu_seltextcolor''' - цвет шрифта выбранного элемента
'''menu_disabledcolor''' - цвет шрифта неактивного элемента

С версии 2.0 появилась возможность задавать положение пользовательского меню относительно кнопки, ссылки и кнопок или ссылок в декораторах.

*'''bmenualign''' отвечает за положение меню относительно кнопок '''btn'''
*'''lmenualign''' отвечает за положение меню относительно ссылки.
*'''decor_имя_menualign''' отвечает за положение меню относительно декоратора.

Эти переменные содержат строку из двух букв. Первая буква — это положение относительно объекта (кнопки или ссылки), вторая — выравнивание.

'''Пример'''
'''bmenualign = «RB»'''
меню относительно кнопок будет справа (Right) и выровнено по нижнему (Bottom) краю.

Значение для меню берётся из сочетаний первых букв положений: Top (верх), Bottom (низ), Center (центр), Left (лево), Right (право).

Значения по умолчани.
* для кнопок - «TL»
* для ссылок — «RL»

===Вывод в текстовый файл===

С версии 1.9 '''FURQ''' поддерживает вывод текста в текстовый файл. Делается это при помощи команд '''fp''' и '''fpln''' (аналог '''p''' и '''pln''', но только для записи текста в файл).

Синтаксис:
'''fprint <текст>''' или '''fp <текст>'''
Оператор дописывает '''текст''' в файл, имя которого содержится в переменной '''fp_filename'''.
'''fprintln <текст>''' или '''fpln <текст>'''
Оператор сохраняет '''текст''' и перевод строки в файл, имя которого содержится в переменной '''fp_filename'''.

Все файлы, в которые ведется запись, должны иметь расширение *.txt. Файлы создаются в той же папке, что и файл игры. В переменной '''fp_filename''' учитывается только имя файла, любой путь автоматически игнорируется.

Для работы с переменной '''fp_filename''' существует команда '''newfile''':
'''newfile <имя файла>'''
Команда присваивает переменной '''fp_filename''' имя файла и стирает этот файл. Если же просто присвоить переменную '''fp_filename''', то новые записи будут добавляться к уже существующему файлу.

==Декораторы==
Декораторы – это небольшие кусочки текста или графические объекты, которые можно поместить в любое место на экране. Декораторами можно управлять, например плавно перемещать или менять оттенок цвета. Графическим декоратором можно дополнительно изменять масштаб, угол наклона, скорость вращения и другие параметры. С помощью декораторов автор может лучше оформить квест, вывести дополнительные параметры или добавить анимационные эффекты.

===Создание декораторов===

Общий синтаксис для добавления декоратора следующий:

'''decoradd <имя> (<x>,<y>[, <z>]) <тип декоратора> <параметры>'''

*'''имя''' – имя декоратора, состоящее из цифр, букв и знаков подчеркивания. Пробелы в имени не допускаются.
*'''x''', '''y''' и '''z''' – координаты декоратора на экране. Параметр '''z''' используется для определения «глубины» декоратора. Чем меньше '''z''', тем «ближе» декоратор к игроку. Все декораторы с '''z''' от 0 и больше располагаются «за» интерфейсом (кнопки управления и текстовое поле), а с '''z''' меньше 0 – «перед» ним. Если '''z''' не указан, то он принимается равным 0.
*тип декоратора может быть '''TEXT''', '''RECT''', '''IMAGE''', '''ANIMATION''', '''GIF''', '''TEXTBUTTON''', '''IMGBUTTON''' и '''CLICKAREA'''.
*'''параметры''' – разные, в зависимости от типа декоратора.
Команда '''decoradd''' позволяет задать от одного до трёх цветов для текстового декоратора.

Теперь более подробно по типам.

Тип '''TEXT''' позволяет добавить декоратор-кусочек текста:

'''decoradd <имя> (<x>,<y>[, <z>]) TEXT "собственно, текст" [, цвет[,"шрифт"]]'''

Если '''цвет''' или '''шрифт''' не указаны, то они принимаются равными цвету и шрифту основного текста.

'''''Пример:'''''
'''decoradd добро_пожаловать (0,0, -1) TEXT "Добро пожаловать в игру", 0xFF990033, "georgiab.ttf[22]"'''
этот декоратор выведет текст - '''Добро пожаловать в игру''' с позиции '''0,0''' в окне,
с непрозрачным цветом '''990033''' и шрифтом '''georgia''' жирный '''22''' размера,
располагающийся перед основным текстом и перекрывающий его

Тип '''TEXTBUTTON''' - декоратор «текстовая кнопка»:

'''decoradd <имя> (x, y[, z]) TEXTBUTTON ["рамка", ] "текст", "целевая локация"'''

''Целевая локация''' — имя локации для перехода в кавычках. '''Текст''' — надпись на кнопке. Надпись на текстовой кнопке можно менять при помощи переменной '''decor_<имя>_text'''.
''''Рамка''' — это название рамки, которая должна быть определена в скине. Рамка применяется если нужно сделать много разных кнопок с разным оформлением. Рамки текстовых кнопок определяются в скине в разделе ресурсов. Если рамку не указать, то кнопка будет по умолчанию с тем же оформлением, что и btn-кнопки.

Чтобы декоратор данного типа был активен, в переменной ''decor_<имя>_enabled'' должна стоять 1.

'''''Пример:'''''
'''decoradd кнопка (10,100, -1) TEXTBUTTON "mybutton", "Благодарности", "об_игре"'''
в данном примере мы имеем кнопку с определённой в скине рамкой '''mybutton''', с надписью '''Благодарности''',
расположенную в позиции '''10,100''' экрана и ведущую в локацию '''об_игре''',
располагающуюся перед основным текстом и перекрывающую его

Тип '''RECT''' – это просто цветной прямоугольник:

'''decoradd <имя> (<x>,<y>[, <z>]) RECT ширина, высота [, цвет]'''

Если '''цвет''' не указан, то он принимается равным цвету основного текста.

'''''Пример:'''''
'''decoradd квадрат (10,10, -1) RECT 300, 300, 0xFF990033'''
этот декоратор нарисует квадрат с позиции '''10,10''' в окне, шириной и высотой в '''300''' пикселей
с непрозрачным цветом '''990033''', располагающийся перед основным текстом и перекрывающий его

Тип '''CLICKAREA''' – это невидимый прямоугольник, который реагирует на нажатия мыши (клики):

'''decoradd <имя> (x, y[, z]) CLICKAREA ширина, высота, "целевая локация"'''

'''Целевая локация''' — имя локации в кавычках. Декоратор поддерживает модификаторы (см. раздел о ссылках), т.е. можно сделать выпадающее меню, переход или локальное действие.

'''''Пример:'''''
'''decoradd область_клика (50,50, -1) CLICKAREA 200, 50, "переход"'''
этот декоратор выведет прямоугольную область на экране в позиции '''50,50''' окна, шириной '''250''' и высотой '''50''',
располагающуюся перед основным текстом и перекрывающую его, кликнув на которую, мы попадём в локацию '''переход'''

Тип '''IMAGE''' – это декоратор-картинка. Параметры этого декоратора очень похожи на параметры оператора '''image''' (см. выше) :

'''decoradd <имя> (<x>,<y>[, <z>]) IMAGE "имя_файла"[, X, Y, ширина, высота]'''

Как и в операторе '''image''' , дополнительные параметры позволяют вывести лишь часть картинки. Если у вас много аниматоров-картинок, то, в целях быстродействия, рекомендуется размещать их на одном «полотне», а не загружать из разных файлов.

'''''Пример:'''''
'''decoradd бэкграунд (0,0, 2) IMAGE "back.png", 0, 0, 1024, 768'''
этот декоратор выведет картинку из файла '''back.png''' на экран в позиции '''0,0''' окна, шириной '''1024''' и высотой '''768''',
располагающуюся за основным текстом

Тип '''IMGBUTTON''' - декоратор «кнопка-картинка»:

'''decoradd <имя> (x, y[, z]) IMGBUTTON "файл-текстура", [tx, ty, ширина, высота,] "целевая локация"'''

'''файл-текстура''' — это полноцветный PNG с прозрачностью,
'''tx''', '''ty''' — это координаты верхнего левого угла В ПРОСТРАНСТВЕ ТЕКСТУРЫ,
'''ширина''' и '''высота''' — это ширина и высота одного КАДРА.

'''''Пример:'''''
'''decoradd моя_кнопка (50,50, -1) IMGBUTTON "button.png", 0, 0, 100, 50, "лес"'''
этот декоратор выведет на экран внопку в позиции '''50,50''' с текстурой из файла '''button.pn''',
определив начальную картинку из текстуры с позиции '''0,0''' шириной '''100''' и высотой '''50''' пикселей,
располагающуюся перед основным текстом. При нажатии на кнопку осуществится переход на локацию с названием '''лес'''.

Кадры должны идти друг за другом в такой последовательности — нормальная, неактивная (disabled), в фокусе, нажатая.

Если '''tx''', '''ty''', '''ширина''' и '''высота''' не указаны, то вся текстура просто делится на четыре кадра по горизонтали. Это удобно, но слишком много текстур вредят скорости работы FURQ. Поэтому, если у вас много кнопок, лучше всё-таки разместить их на одну текстуру.

Декоратор-анимация добавляется с помощью типа '''ANIMATION''' :

'''decoradd <имя> (<x>,<y>[, <z>]) ANIMATION "имя_файла", X, Y, ширина, высота, N'''

'''Х''' и '''Y''' это координаты первого кадра анимации (левый верхний угол). Параметры похожи на параметры типа '''IMAGE''', за исключением того, что здесь параметры, определяющие кадр, опускать нельзя. '''N''' определяет количество кадров в анимации. Кадры должны располагаться на картинке один за другим, слева направо и сверху вниз (если они не помещаются на картинке в одну строку).

'''''Пример:'''''
'''decoradd анимация_героя (50,50, -2) ANIMATION "anime.png", 0, 0, 200, 400, 20'''
этот декоратор покажет на экране анимацию из файла текстуры '''anime.png''', в позиции '''50,50''' окна,
шириной кадра '''200''' и высотой '''400''', состоящую из '''20''' кадров и располагающуюся перед основным текстом

Декоратор-GIF можно создать с помощью типа '''GIF''':

'''decoradd <имя> (<x>,<y>[, <z>]) GIF "имя_gif-файла"'''

<div style="background-color:LavenderBlush;padding:5px;border:1px solid Brown;"><font color="maroon">'''Важное замечание:'''</font> В декораторах типа '''IMAGE''' можно использовать gif-изображения, но они будут статичными (первый кадр в анимированных gif-ах). Для анимированных gif-ов используйте декоратор с типом '''GIF'''. </div>

'''''Пример:'''''
'''decoradd гиф_картинка (50,50, -1) GIF "anime.gif"'''
этот декоратор покажет анимированную gif картинку из файла '''anime.gif''' на экране в позиции '''50,50''',
располагающуюся перед основным текстом

===Управление декораторами===

Для управления декораторами применяются следующие команды:

'''decormov <имя> X, Y[, время]'''
Позволяет переместить декоратор в точку с координатами '''X''' и '''Y'''. Если указано '''время''' (в миллисекундах), то перемещение будет плавным и займет как раз указанное время.

'''decorcol <имя> цвет[, время]'''
Позволяет установить цвет декоратора. Если указано '''время''', то изменение цвета будет плавным. Если после имени декоратора задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''decorrot <имя> угол[, время]'''
Позволяет повернуть декоратор на определенный '''угол''' (в градусах). Важно помнить, что угол в этой команде задается ''относительно текущего''. Это позволяет поворачивать декоратор в обе стороны. Если указано '''время''', то поворот будет плавным. Эта команда не работает с декораторами типа '''TEXT'''.

'''decordel [<имя1>, <имя2>, …]'''
Удаляет перечисленные в параметрах декораторы. Без параметров удаляет все декораторы.

'''decorscl <имя> масштаб[, время]'''
Позволяет установить '''масштаб''' декоратора. Масштаб задаётся дробным числом. Масштаб, равный 2 - это двойной размер декоратора, а 0.5 - половинный. Если указано '''время''', то изменение масштаба будет плавным.

'''decorscr <имя> "скрипт"'''
Назначает декоратору скрипт.

===Маски имён===
Во всех командах управления декораторами в качестве параметра '''имя''' можно передавать маску имён с использованием символов '''*''' (замещает любое количество символов) и '''?''' (замещает один символ). Например, команда
'''decorrot sas* 90, 2000'''
повернёт все декораторы, имя которых начинается с "sas", на 90 градусов по часовой стрелке за две секунды.

===Переменные декораторов===
Разнообразные параметры декораторов можно устанавливать с помощью специальных переменных. Эти переменные начинаются на decor_ , после чего следует имя декоратора. Переменные бывают следующих типов:
*'''decor_имя_x, decor_имя_y и decor_имя_z''' – позволяют задать координаты декоратора.
*'''decor_имя_color''' – позволяет задать цвет декоратора.
*'''decor_имя_linkcolor''' − позволяет задать цвет ссылок в декораторе.
*'''decor_имя_linkhcolor''' − позволяет задать цвет подсветки ссылки в декораторе.
*'''decor_имя_hide''' – если установлен в 1, то декоратор скрыт.
*'''decor_имя_enabled''' – если установлен в 0, то декоратор-кнопка типа TEXTBUTTON или IMGBUTTON неактивен (нельзя нажать). Для декораторов типа TEXT, если равен 0, отключает все ссылки находящиеся в них.
*'''decor_имя_target''' - позволяет устанавливать имя "целевой локации", если такая используется в декораторе
*'''decor_имя_text''' – устанавливает текст декоратора (только для типа '''TEXT''')
*'''decor_имя_align''' – устанавливает тип выравнивание текста внутри декоратора аналогично переменной '''textalign''' (только для типа '''TEXT'''), по умолчанию равна 1
*'''decor_имя_width''' – возвращает ширину декоратора (масштабируется по ширине текста в нём), устанавливает ширину текстового декоратора, по которой текст будет переноситься на другую строку (только для типа '''TEXT'''). Чтобы вернуться к автомасштабированию, достаточно присвоить переменной decor_имя_width значение ноль.
*'''decor_имя_height''' - возвращает высоту декоратора (в пикселях).
*'''decor_имя_hotx''' и '''decor_имя_hoty''' – позволяют задать «горячую точку» для декоратора (кроме типа '''TEXT'''). Горячая точка задается в пространстве самого декоратора (по умолчанию – 0,0) и служит для привязки. Предположим, у вас изображение размером 25х25 пикселей. Если вы установите горячую точку в (13, 13), то, при вращении декоратора, вращение будет происходить вокруг центра картинки. Так же и при позиционировании на экране привязка будет за центр картинки.
*'''decor_имя_flipx''' и '''decor_имя_flipy''' - позволяет задать горизонтальный и вертикальный флип (зеркальное отображение) для декораторов-картинок. Если переменные равны 1, то картинка отображается зеркально по оси x или y соответственно.
*'''decor_имя_angle''' – позволяет задать угол поворота декоратора (кроме типа '''TEXT'''). Угол задается в градусах.
*'''decor_имя_rotspeed''' – позволяет задать постоянную скорость вращения декоратора (кроме типа '''TEXT'''). Скорость задается в градусах в секунду и может иметь как положительное, так и отрицательное значение.
*'''decor_имя_scale''' – позволяет задать масштаб декоратора (кроме типа '''TEXT'''). По умолчанию равна 1.
*'''decor_имя_frame''' – позволяет задать текущий кадр анимации (только для типов '''ANIMATION''' и '''GIF'''). Процесс анимации при этом останавливается.
*'''decor_имя_anispeed''' – позволяет задать скорость анимации (только для типов '''ANIMATION''' и '''GIF'''). Для разных типов поведение различается:
**Для типа '''ANIMATION''' . Если анимация остановлена, то равна 0. Обозначает задержку в миллисекундах между сменой кадров. Может принимать как положительное, так и отрицательное значение. По умолчанию имеет значение 250;
**Для типа '''GIF''' . Если анимация остановлена, то равна 0. Обозначает процент от скорости, записанной в самом GIF-файле. Может принимать значения от 0 до 1000. По умолчанию имеет значение 100.
*'''decor_имя_anitype''' – позволяет задать тип анимации (только для типа '''ANIMATION'''). Может принимать следующие значения:
**'''0''' – анимация проигрывается один раз и останавливается;
**'''1''' – анимация зациклена (с последнего кадра перескакивает обратно на первый);
**'''2''' – анимация зациклена в режиме «пинг-понг» (при достижении граничного кадра меняется направление анимации).
*'''decor_имя_script''' – позволяет задать скрипт декоратора. Прочитать значение переменной скрипта нельзя, его можно только назначить.
*'''decor_name_linespacing''' - вертикальное расстояние между строк текста (только для '''TEXT'''). По умолчанию равно системному '''linespacing'''.
*'''decor_name_paraspacing''' - вертикальное расстояние между параграфами (только для '''TEXT'''). По умолчанию равно системному '''paraspacing'''.

===Скрипты декораторов===
Скрипты позволяют "запрограммировать" декоратор. Другими словами, назначить ему последовательность команд по перемещению, вращению, изменению масштаба и т.д., которые декоратор будет выполнять самостоятельно, не требуя дополнительного команд в коде игры. Эта функция удобна, когда вам надо реализовать системы частиц (снежинки, дым) для оформления вашей игры, или просто добавить визуальных эффектов.

Скрипты декораторам назначаются с помощью команды '''decorscr''' или переменной '''decor_имя_script''' и представляют собой строку, содержащую последовательность команд, разделённых символом косой черты ('''/''').

'''''Команды'''''

'''mov x, y [, time]''' - перемещение в точку '''x''', '''y''' (опционально - за время '''time''')

'''mvr''' - то же самое, но координаты задаются относительные

'''movx''' и '''mvrx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

'''pau <time>''' - пауза на время '''time'''

'''col <цвет>[, time]''' - изменение цвета декоратора (опционально - за время '''time''')

'''col <A, R, G, B>[, time]''' - то же самое, но компоненты цвета задаются отдельными параметрами

'''colx''' - то же самое, но следующая команда выполнится немедленно (не будет паузы на время '''time''')

Для команд col/colx, как и для '''decorcol''', если задан один параметр — это цвет текста. Если два — это цвет текста и период времени, за который его надо поменять. Если три — это цвет текста, ссылки и подсветки. Если четыре — это три цвета и время, за которое они меняются.

'''ang <угол>''' - задать абсолютный угол поворота декоратора (в градусах)

'''rot <угол>[, time]''' - поворот декоратора на угол (относительное значение, опционально - за время '''time''')

'''rotx''' - без паузы

'''rsp <скорость вращения>''' - позволяет задать скорость вращения (положительную или отрицательную, в углах в секунду)

'''scl <масштаб>[, time]''' - задать масштаб декоратора (опционально - за время '''time''')

'''sclx''' - то же самое без паузы

'''rst''' - запустить скрипт с начала

'''del''' - уничтожить декоратор

'''''Случайные параметры'''''

Любой из параметров можно определить как '''R(min,max)''', таким образом, при исполнении команды будет вычислено случайное значение от '''min''' до '''max'''.

'''''Пример'''''
'''decorscr star "mvr 50, 0, 1000/rot R(-90,90), 1500/rst"'''
Декоратор с именем '''star''' переместится вправо на 50 пикселей за одну секунду, затем повернётся на случайный угол от -90 до 90 градусов (т.е. вправо или влево) за полторы секунды и начнёт выполнять скрипт сначала, то есть будет продолжать двигаться вправо и поворачиваться, уезжая за правую границу экрана.

==Скины==

Скин игры - это файл с описанием того, как должен выглядеть интерпретатор FireURQ при проигрывании вашего квеста. Изменение внешнего вида интерпретатора - это тема повышенной сложности, поэтом она раскрыта в [[FireURQ:Скины|отдельном разделе]].

== Формат квестов QSZ==

'''FireURQ''' поддерживает свой собственный формат квеста – упакованный квест ('''QST Zipped'''). '''QSZ'''-файл – это, по сути, zip-архив, в котором лежит сам файл квеста ('''qst''', '''qs1''' или '''qs2''') и все ресурсы, необходимые для работы игры (изображения и музыка). Данный формат очень удобен, если ваша игра использует мультимедиа.

Также, существует возможность конвертации квеста в формате QSZ в исполняемый файл. Для этого следует использовать утилиту '''QSZ2EXE''', которая входит в комплект поставки. Эта консольная утилита находится в папке на диске, которую вы выбрали при инсталляции '''FireURQ'''.

== Режим отладки ==

Режим отладки включается с помощью ключа '''-d''' в командной строке. При включенном режиме отладки все ошибки в коде квеста выводятся прямо в текст. Кроме того, в режиме отладки работает полезная комбинация '''Ctrl+R''', позволяющая перезагрузить исходный текст квеста с диска. Происходит сохранение игры, перезагрузка исходного текста и загрузка сохраненного состояния с переходом на ту же локацию, что и до перезагрузки. Это позволяет править исходный текст и сразу же смотреть результаты изменений.

==Инвентарь==

Существует возможность скрывать действия над предметами. Для этого необходимо использовать специальные переменные. Имя переменной формируется как имя локации-действия над предметом инвентаря, плюс «'''_hide'''». Например, если выполнить '''Use_Топор_Рубить дерево_hide = 1''', то действие “Рубить дерево» у предмета инвентаря «Топор» будет скрыто до тех пор, пока вы не присвоите этой же переменной значение '''0'''.

С помощью такого приема можно скрывать действия над предметами на тех локациях, на которых их по сюжету невозможно выполнить.

Также возможно поменять отображение предмета в списке инвентаря. Для этого используются переменные вида '''idisp_предмет''', например:
'''idisp_Бутылка = "Бутылка с водой"'''
При этом важно понимать, что '''idisp_-переменные''' влияют только на отображение предмета в списке инвентаря. В операторах '''inv+''' и '''inv-''', а также при обращении к счетчикам предметов через '''inv_-переменные''', следует использовать изначальное название («Бутылка» в примере):
'''inv- Бутылка'''
'''if inv_Бутылка > 1 then pln У вас несколько бутылок…'''

==Предопределенные функции==

В '''FireURQ''' предусмотрены предопределенные функции, которые вызываются с помощью оператора proc. Результат возвращается в переменной '''_result'''. Существуют следующие предопределенные функции:

Функция '''_int''' отбрасывает дробную часть числа. Если вызвать, например, proc _int(3.14), то в переменной _result окажется 3.

Функция '''_trim''' обрезает пробелы с начала и в конце строки, вызывается как proc _trim(str), где str — строка (строковая переменная или строка в кавычках).

Функция '''_scopy''' копирует кусочек строки, вызывается как proc _scopy(str, start[, len]), где str — строка, start — номер символа в строке, с которого начинать копировать и len — количество копируемых символов. Если параметр len опущен, то строка копируется до конца.

'''_sin(x)''', '''_cos(x)''' и '''_tan(x)''' – позволяют вычислить соответственно синус, косинус и тангенс числа x, представленного в радианах.

'''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255'''(т.е. полностью видимый цвет).

'''''Пример:'''''
'''proc _color(x+15, 10, 255, 60)'''
'''textcolor = _result'''

==Anykey==

'''anykey [<переменная>[, <pause>]]'''

По команде '''anykey''' игра приостанавливается и ждёт нажатия на клавишу. Если указана переменная, то код клавиши будет записан в неё. При нажатии на функциональную клавишу в '''anykey''' возвращается скан-код этой клавиши, а переменная '''is_syskey''' устанавливается в '''1'''. Состояние клавиш '''Shift''', '''Ctrl''' и '''Alt''' на скан-коде функциональной клавиши не отражаются.

Также, у команды '''anykey''' существует возможность задавать таймаут. Например, по команде '''anykey z, 1000''' игра секунду будет ожидать нажатия кнопки, а если за секунду кнопка нажата не будет, то игра продолжит выполнение, а в переменную '''z''' будет записан ноль.

При использовании команды '''anykey''' нажатия на кнопку мыши тоже расцениваются как нажатия на клавишу, при этом в переданную переменную записываются коды '''256''', '''257''' и '''258''' для левой, правой и средней кнопок соответственно, а в переменные '''mouse_x''' и '''mouse_y''' – координаты, в которых был сделан клик.

'''''Пример:'''''
'''anykey z, 1000'''

==Time==

С версии 2.0 появилась переменная '''time''', которая хранит в себе количество миллисекунд, прошедших с момента загрузки Windows. Это удобно, если надо засечь время реакции игрока.

==Mousecursor==

С версии 2.0 появилась возможность кастомизировать курсор. Им теперь может служить любой декоратор. Достаточно присвоить имя этого декоратора переменной '''mousecursor'''. При этом точка привязки декоратора становится точкой указания для мыши. Чтобы вернуться к системному курсору, нужно присвоить переменной '''mousecursor''' пустое значение. При этом декоратор тоже нужно уничтожить, иначе он останется на экране.

'''''Пример:'''''
'''decoradd cursor (0,0, 50) IMAGE "arrow.png"'''
'''mousecursor = "cursor"'''

==Сохранение игры и оператор SAVE==

В '''FURQ''' предусмотрено сохранение состояния игры в слоты ('''7''' обычных слотов и слот “автосохранения”).

'''save <локация>''' - записывает сохранение в слот автосохранения.

'''save <локация>, "имя сохранения"''' - запускает интерфейс со слотами, дает выбрать слот сохранения (кроме слота “автосейва”) и записывает в него сохранение с указанным именем.

'''save <локация>, "имя сохранения", <номер слота>''' - запишет сохранение в указанный слот, где номер слота - число от '''0''' до '''7''' ('''0''' - слот автосохранения).

'''''Пример:'''''

'''save location; записать в слот автосохранения'''
'''save location, “Сохранение”; записать в любой слот, который выберет игрок'''
'''save location, “Мой автосейв”, 0; записать в слот автосохранения'''
'''save location, “Утро, Румыния, 17-й век”, 5; записать в пятый слот'''

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

С версии 2.0 '''FURQ''' сохраняет полное состояние игры на момент сохранения и способна вернуться в ту точку кода, где была вызвана команда SAVE. То есть, после загрузки, выполнение продолжится с команды, следующей за командой SAVE. Чтобы воспользоваться новыми возможностями, просто не указывайте первый параметр (локацию) при вызове SAVE. Например:

'''''Пример:'''''
'''save «В лесу»''' ;вызовет интерфейс сохранения с выбором слота
'''save «В лесу», 2''' ;запишет сохранение во второй слот
'''save''' ;просто сохранит игру в нулевой слот без вызова интерфейса

Если же в команде будет указана локация сохранения, то после загрузки произойдёт переход на указанную локацию.

==Загрузка игры через оператор LOAD==

Оператор LOAD инициирует загрузку ранее сохранённой игры. Команда дублирует пункт меню «Загрузить сохранение».
Если использовались слоты сохранений, то данная команда вызовет интерфейс выбора из слотов. Если же сохранение было системным, то просто загрузит игру.
== Другое ==

* '''count_...''' — переменные счетчики обновляются ТОЛЬКО при переходах по '''btn'''. Старое поведение '''URQ_DOS''', когда '''count_...''' увеличивается и по '''proc''' и по '''goto''', можно включить, установив переменную dosurq_count в '''1'''.
* Переход по действиям в инвентаре не перезапускает локацию заново при возврате. Если действие было вызвано во время '''end''' — то происходит безусловный переход ('''goto''') на локацию-действие. Если же вы решили использовать инвентарь во время pause, то локация-действие вызывается как '''proc''' с возвратом на оператор, следующий за pause. Долго думал над этим поведением и решил, что так будет правильнее всего.
* Есть переменная '''gametitle''' — позволяет вывести название игры в заголовок окна. По умолчанию там имя файла, из которого игра была загружена.
* Ключ '''-l''' командной строки позволяет направить весь вывод в файл, т.е. создавать логии прохождений. Файлы логов будут называться '''имяквеста.000.log''', '''имяквеста.001.log''' и т.д.
* Клавиатурные шорткаты для системного меню и инвентаря – клавиши ['''Esc'''] и ['''I'''], соответственно.
* Имеется возможность включить полноэкранный режим, нажав сочетание клавиш '''Alt+Enter'''. Повторное нажатие Alt+Enter выключает полноэкранный режим.
* Можно прокручивать экран с помощью клавиш '''PgUp''' и '''PgDown''', а также колесом мыши. Если держать '''Ctrl''', то колесо мыши прокручивает экран маленькими порциями.
* В оператор '''tokens''' можно передавать не только строковую переменную, но и просто строку, заключенную в кавычки или строковое выражение.
* Индикацию состояний ожидания (мигающая иконка в углу экрана) при выполнении операторов anykey, pause и при требуемой прокрутке текста можно отменить с помощью переменных '''hide_anykey_indicator''', '''hide_pause_indicator''' и '''hide_more_indicator''', присвоив им значение '''1'''.
* Есть возможность изменять положение и размер главного текстового поля. Для этого служат переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height'''.
* Скрыть «эхо» выполняемых действий при нажатии кнопки, использовании инвентаря и сохранении игры возможно с помощью переменных '''hide_btn_echo''', '''hide_inv_echo''' и '''hide_save_echo''', соответственно, установив их в '''1'''.
* Переменная '''hide_link_echo''' скрывает «эхо» от ссылок, если её установить в '''1'''.
* Переменная '''hide_local_echo''' скывает «эхо» от локальных действий, если её установить в '''1'''. По умолчанию равна '''1'''.
* При сохранении игры командой '''SAVE''' переменная '''save_success''' устанавливается в '''1''' при успешном сохранении и в '''0''', если сохранение по каким-то причинам не удалось.
* Если установить переменную '''numbuttons''' в '''1''', то кнопки действий будут пронумерованы, а нажатие цифровых клавиш на клавиатуре будет приводить к нажатию соответствующей кнопки.
* Переменные '''mouse_x''' и '''mouse_y''' возвращают текущие координаты мыши на момент вызова.
* При нажатии '''Ctrl+C''' в буфер обмена будет помещён текст последней локации.
* Команда '''CLSL''' делает неактивными все ссылки в тексте.
* Переменная '''inventory_enabled''' (по умолчанию '''1''') отвечает за доступность инвентаря, при значении '''0''' инвентарь недоступен и наоборот.
* Переменная '''fp_filename''' содержит имя файла, с которым работают команды '''fp''', '''fpln''' и '''newfile'''.
[[Категория:Документация FireURQ]]
* Команда '''QUIT''' закрывает плеер с игрой.
* Системная переменная '''fullscreen''' отвечает за развёртывание игры на полный экран и возврат в оконный режим. Установка её в 1 переводит игру в полноэкранный режим, 0 - переводит обратно в оконный.

FireURQ:Руководство пользователя

2017-03-02T14:14:44Z

Ajenta:

=Метки=

Метка - одно из важнейших понятий URQL. Она служит для выделения места в квесте, куда затем предстоит перейти. Любые перемещения в квесте могут быть либо на следующий оператор, либо на метку. Все метки имеют имена, чтобы потом можно было указывать, куда вы хотите перейти.
Определяется метка при помощи двоеточия. Все, что правее этого символа, до разделителя, которым является символ конец абзаца (Enter) или '&' - имя метки:

''':Имя_метки'''

Метка и следующий за ней оператор end являются принятой единицей измерения игры - локацией. Между ними обычно пишется описание локации и переходы из неё в другие локации.

''':начало'''
'''end'''

Например, допустимыми именами меток являются:

''':1'''
''':01'''
''':а'''
''':кот1'''
''':@(a)%^Очень_Длинная_и_Запутанная_метка_какими-лучше-не-пользоваться!!!!!_horror_так_как_сами_потом_забудете_как_она_называется!Или_сделаете_ошибку!'''
'''Вы_же_можете_сделать_маленькую_ошибку_в таком_длинном_названии?'''
''':house_flat1'''

'''''Примечание:''''' метка должна начинаться с начала строки и отделяться от других операторов (Enter) или '&', регистр имени метки не важен.

:BIG
:bIG
:Big
:big
- все эти метки для интерпретатора совершенно одинаковы. Но лучше, в целях собственного удобства, придерживаться единого стиля.

В метке лучше не делать пробелов. Длина метки не ограничена, но для удобства автора квеста лучше не делать меток длиннее строки. В метке допускаются символы, обозначающие буквы русского и латинского алфавита, цифры, знак подчеркивания и знаки арифметических операций + и - (лучше не злоупотреблять странными названиями).

Недопустимы символы ''';''' '''/*''' '''*/''' '''&'''

Грамотное использование имен меток способно серьезно облегчить работу автора.

=Текст=
==Вывод текста==

Поскольку мы имеем дело с текстовыми играми, важнейшим для нас является вывод текста. В FURQ существует несколько способов вывода текста.

===Текст на экране===

Простейший способ вывести текст это использовать команды '''P''' и '''PLN'''. Советую освоить их, прежде чем переходить к другим способам вывода.

Формат команд:
'''p''' [текст]
'''pln''' [текст]

Регистр команд не имеет значения ('''pLn''' = '''PLN''' = '''Pln''').

На практике это выглядит так:
'''p''' Этот текст появится на экране.
или
'''pln''' Этот текст тоже появится на экране.

Каждая последующая команда '''P''' или '''PLN''' дописывает новый текст к тексту который уже есть на экране. Когда текста становится слишком много, появляется возможность его прокрутить.

Разница этих двух команд в следующем - '''P''' просто добавляет новый текст, а '''PLN''' добавляет текст и делает переход на новую строку (создает абзац).

Например:
'''p''' А
'''p''' Б

Выдаст “АБ”, тогда как

'''pln''' А
'''pln''' Б

Выдаст:
А
Б

Чаще всего пользуются командой '''pln''', однако и '''p''' может быть полезна, например, когда строчка текста, которую мы хотим вывести на экран, состоит из нескольких частей и зависит от каких-либо переменных или условий.

Команды '''P''' и '''PLN''' могут напрямую выводить любые символы (кроме символа комментария '''“;”'''), переменные и ссылки.

===Вывод переменных===

Вывод переменных возможен в двух вариантах - числовом и текстовом. Для того чтобы их вывести, нужно заключить имена переменных в соответствующие скобки:
'''pln''' '''#%'''имя_текстовой_переменной'''$''' '''#'''имя_числовой_переменной'''$'''
Несмотря на внешнее сходство, они отличаются содержанием и символом '''%'''. Если в числовые скобки попадет текстовая переменная, то на выводе окажется не текст, а количество символов в этой переменной. И наоборот, если числовая переменная попадет в текстовые скобки, то на выводе окажется пустота.

Выведем оба типа переменных на экран:

'''текстовая_переменная="Геннадий"'''
'''числовая_переменная=42'''
'''pln''' Крокодил схватил вас за ногу и сказал:
'''pln''' - Меня зовут '''#%текстовая_переменная$'''.
'''pln''' Затем крокодил схватил вас за другую ногу и сказал:
'''pln''' - Мне '''#числовая_переменная$''' года. Давай, ты станешь моим близким другом.

Результат:
Крокодил схватил вас за ногу и сказал:
- Меня зовут Геннадий.
Затем крокодил схватил вас за другую ногу и сказал:
- Мне 42 года. Давай, ты станешь моим близким другом.

Кроме того, в '''URQL''' есть специальные обозначения для вывода символа пробела - '''#$''', вывода символа переноса строки - '''#/$''' и вывода символа по ascii-коду - '''##'''ascii-код'''$'''.

Так, например, символ комментария можно вывести на экран, через его ascii-код:
'''pln''' Моя грамотность была на исходе'''##59$''' но, несмотря на это, я поставил точку с запятой в предложении.

Результат:
Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.

Хочу напомнить, что если бы мы написали в коде просто:
'''pln''' Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.
То получили бы на экране:
Моя грамотность была на исходе
Потому что символ ";" и все что после него идет было бы обработано как комментарий.

'''Примечание:'''
Вывод строковой переменной, как числа '''#текстовая_переменная$''' даст нам количество символов в строке.

==Оформление текста==

В 21 веке в '''FURQ''' текст это не просто набор символов, но еще и набор гарнитур, цвет, выравнивание и местоположение.

===Местоположение===
Область экрана, куда выводят текст команды '''p''' и '''pln''' можно двигать, делать шире, уже, выше и т.д. Для этого служат системные переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height''', которые описывают некий прямоугольник куда и выводится текст. По умолчанию он занимает почти весь экран. Это числовые переменные, которые содержат значения в пикселях.

Давайте, используя полученные нами знания, выведем значения этих переменных на экран:
'''pln''' Левая граница='''#textpane_left$''', Верхняя граница='''#textpane_top$''', Ширина='''#textpane_width$''', Высота='''#textpane_height$'''

Результат:
Левая граница=20, Верхняя граница=55, Ширина=760, Высота=525

Вы можете изменять значения этих переменных как угодно в любом месте игры. Например, вы хотите вывести справа от текста картинку: измените ширину ('''textpane_width''') так чтобы текст не мешал. А когда картинка больше не нужна измените ширину обратно. Экспериментируйте.

===Выравнивание текста===

За выравнивание текста отвечает команда числовая системная переменная textalign. Она сообщает FURQ как должен быть расположен текст относительно области его вывода.

Лучше всего это понять на примере:
'''textalign = 1'''
'''pln''' текст выравнивается влево
'''textalign = 2'''
'''pln''' текст выравнивается вправо
'''textalign = 3'''
'''pln''' текст выравнивается по центру

''; Главное теперь не забыть, поменять переменную обратно на '''1''', если вы не хотите, чтобы текст всей игры был выравнен по центру.''

===Цвет===

Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате '''0xAARRGGBB'''. То есть четыре составляющих: альфа, красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.

Встроенная функция '''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255''' (т.е. полностью видимый цвет).

Пример:
'''proc''' _color(x+15, 10, 255, 60)
'''textcolor = _result'''

===Шрифт===

Для определения шрифта, которым будет выводиться текст, используется переменная '''textfont'''. В нее в виде строкового значения следует записать имя файла шрифта.

'''FireURQ''' позволяет использовать обычные True Type шрифты Windows. Для этого шрифт должен быть либо установлен в системе, либо лежать в папке с игрой (архиве QSZ).

Формат использования шрифта такой:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]'''

*'''size''' – размер шрифта(по умолчанию '''19'''), а точнее высота строки в пикселях
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')

Допустим, мы хотим вывести текст шрифтом Georgia.

Для этого пишем:
'''textfont = "georgia.ttf"'''
И сразу же проверяем результат, при помощи оператора вывода текста '''pln''', который мы уже освоили в совершенстве:
'''pln Крокодил зарылся в ил, крокодила ил манил'''

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

Меняем размер на 42:
'''textfont = "georgia.ttf[42]"'''

Остальные параметры команды нужны, чтобы текст, который будет выведен на экран выглядел еще более красиво (например, при стандартных параметрах текст может выглядеть не слишком хорошо на светлом фоне). В параметре '''bgcolor''', конечно, лучше задать цвет фона, на котором будет выведен текст. Другие параметры подбираются скорее на глаз, чем по науке.

Примеры:
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

Чтобы, после манипуляций с текстом, вернуться к шрифту по умолчанию, следует выполнить:
'''textfont = "_sysfont"'''

'''FireURQ''' может использовать и растровые шрифты формата '''HGE Font''' (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат '''HGE Font''', входит в дистрибутив (папка '''fonted''').

Пример использования HGE шрифта
'''textfont = "myfont.fnt"'''

===Команда CLS===

Часто бывает так, что экран, на который уже выведен текст нужно очистить. Для того чтобы удалить весь текст, выведенный при помощи команд '''P''' и '''PLN''', существует команда '''CLS'''. У нее нет никаких параметров.

Пример:
'''pln Уйма текста.'''
'''cls'''

Результат:
 

===Другие способы вывода текста===

Иногда оказывается недостаточно команд, описанных выше. Например, вы хотите чтобы в верхнем правом углу экрана всегда отображалось количество очков, которые игрок заработал на протяжении игры. Или состояние здоровья персонажа. Или название комнаты, в которой он находится. Или все это одновременно в разных местах экрана. Тогда на помощь автору приходят текстовые [[декораторы]].

===Текст в заголовке===

Для того чтобы вывести название игры или другой текст в заголовок окна FURQ нужно поместить этот текст в системную текстовую переменную gametitle. Если переменная пуста, то в заголовке будет отображаться название файла игры.

Пример:
'''gametitle = “Крокодил”'''

Результат:

[[Изображение:Furq_titlebar.png]]

''; Иногда эту переменную удобно использовать при отладке игры, временно выводя в нее, к примеру, значения других переменных.''

= Переходы =

Любой текстовый квест можно разбить на локации с текстом и переходы между ними. Из каждой локации к другим локациям обычно ведет несколько переходов, которые обозначают некоторые альтернативные варианты действий. В этой главе мы рассмотрим способы, которыми URQL позволяет сделать переходы в игре.

==Переход по кнопкам (оператор BTN)==

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

Общее обозначение: btn <локация>, <надпись на кнопке>]

Где <локация> - имя метки, на которую будет совершен переход, <надпись на кнопке> - надпись на кнопке, которая отображается на экране. В случае если <надпись на кнопке> не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
'''btn лес,Войти в лес'''
Эта команда выведет на экран кнопку с текстом '''Войти в лес''', ведующую на локацию '''лес'''

'''''Примечание 1: пробелы до и после надписи на кнопке игнорируются.'''''

'''''Примечание 2: если локация не найдена, то кнопка выводится с пометкой // phantom.'''''

'''''Примечание 3: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

У кнопок есть так называемое "эхо". Это сообщение, выводящееся на экран о том, что вы перешли по кнопке. Чтобы оно не выводилось, следует использовать переменную '''hide_btn_echo'''. Если установить её в единицу, то сообщения показываться не будут.

'''''Пример:'''''
'''hide_btn_echo = 1'''

===Команда CLSB===

Бывает так, что нам не нужно очищать весь экран, а нужно стереть только кнопки действий. Для того чтобы удалить кнопки выведенные командой '''BTN''', существует команда '''CLSB'''. У нее нет никаких параметров.

Пример:
'''btn север, Идти на Север'''
'''clsb'''
'''btn юг, Идти на Юг'''

Результат (текст на выведенной кнопке):
'''Идти на Юг'''
 

===Оформление кнопок в Fireurq===

Оформление кнопок делается в файле skin.xml
Описание можно найти в статье [[FireURQ:Скины|FireURQ:Скины]].

==Переход по ссылке==

FireURQ позволяет использовать в тексте (и декораторах) ссылки.

'''''Формат ссылок:'''''
'''<nowiki>[[текст ссылки|название локации]]</nowiki>'''

'''''Пример:'''''
'''pln Вы стоите рядом с покосившимся <nowiki>[[домиком|домик_осмотреть]]</nowiki>. Вокруг раскинулись <nowiki>[[клумбы с аромантными цветами|клумбы_осмотреть]]</nowiki>.'''

Здесь '''домик_осмотреть''' и '''клумбы_осмотреть''' - названия локаций, на которые будут осуществляться переходы при нажатии на ссылку.

Цвет ссылок задаётся переменными linkcolor и linkhcolor. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши.

'''''Пример:'''''
'''linkcolor = 0xffffff'''
'''linkhcolor = 0x0000ff'''
В данном примере цвет ссылок в тексте будет белым, а при наведении станет синим.

Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

'''''Упрощенный формат вывода ссылок такой:'''''
'''<nowiki>[[текст ссылки]]</nowiki>'''

В данном случае ссылка будет вести на метку под названием "текст ссылки".

'''''Пример:'''''
'''pln На волнах раскачивается деревянная <nowiki>[[лодка]]</nowiki>.'''

Здесь, при клике на ссылку произойдет переход на метку "лодка".

'''''Замечание: не рекомендуется называть метки именами с пробелами, соответственно не стоит использовать ссылки типа <nowiki>[[деревянная лодка]]</nowiki>, которые ведут на локации с такими именами.'''''

У ссылок, как и у btn есть "эхо", то есть в окне игры пишется, что вы перешли по ссылке. Чтобы его отключить, следует использовать переменную '''hide_link_echo'''. Если установить её в 1, то "эхо" выводиться не будет.

'''''Пример:'''''
'''hide_link_echo = 1'''

'''''Примечание: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

==Переход по оператору GOTO==

'''''Синтаксис:'''''
'''GoTo Метка'''

После выполнения оператора '''goto''' происходит мгновенное перемещение на указанную метку. При наличии локации common (см. ниже) операторы на локации common при переходе по '''goto''' НЕ ВЫПОЛНЯЮТСЯ. Это сделано специально и умышленно - чтобы можно было делать переходы внутри локации.

Примечание: в случае не нахождения метки, goto просто игнорируется.

'''''Пример:'''''
'''goto лес'''
Этот код произведёт перемещение на локацию с названием ''''лес'''.

==Переход по оператору PROC==

'''''Синтаксис:'''''
'''Proc Метка'''

При вызове данного оператора происходит переход на указанную метку и выполнение программы, до встречи первого end, потом управление передается оператору, следующему непосредственно за '''proc''', откуда команда была вызвана. Допустима любая вложенность '''proc'''-вызовов (вплоть до использования рекурсии!).

Нормально обрабатываются последовательные переходы по '''proc''' - цепочка ведется до тех пор, пока не встретится первый end. При этом кнопки во всех пройденных локациях накапливаются(!), но при обнаружении end'а происходит не опрос пользователя, а возврат к предыдущему proc'у и так до самого начала цепочки.

'''''Пример:'''''
''':берег_реки'''
'''pln Вы стоите на берегу реки, позади вас Туманный лес.'''
'''proc лес'''
'''pln Отсюда только одна дорога - на запад.'''
'''end'''
''';----------'''
''':лес'''
'''pln Из леса на вас поглядывают волки.'''
'''end'''

При выполнении этот код выведет на экран следующее:

Вы стоите на берегу реки, позади вас Туманный лес.
Из леса на вас поглядывают волки.
Отсюда только одна дорога - на запад.

То есть, после выполнения по '''proc''' локации '''лес''', мы вернёмся в локацию '''берег_реки''' и продолжим с того места, на котором был вызов команды '''proc'''.

'''''Важно:''''' При наличии локации common (см. ниже) операторы на локации common при переходе по '''proc''' НЕ ВЫПОЛНЯЮТСЯ и системная переменная '''current_loc''' не меняется.

'''Примечание:''' Часто из метки вызванной с помощью '''proc''' ведёт вызов '''goto''' и далее. В таком случае, если мы не хотим возврата к первой локации, нужно использовать оператор '''forget_procs'''

==Переход по декораторам TEXTBUTTON и IMGBUTTON==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Декораторы'''.

==Контекстное меню==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Выпадающие меню'''.

==Параметры при переходах==

Локальные параметры при переходах возможно передать параметры.

Общее обозначение: <метка>(param1, param2, ...)

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные <метка>_1, <метка>_2 и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).

Важное замечание: при использовании параметров в операторе btn подстановки (#...$ и #%...$) раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.

'''''Пример:'''''
'''btn лес(1,"опушка"),Войти в лес'''
На локации '''лес''', переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''

то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''

Параметры при переходах очень удобны для организации проверок внутри локации.

'''''Замечание:''''' Если вы передаёте параметры метке, то её название не должно начинаться с цифры, то есть исключены названия вроде '''25''' или '''40метро'''. Если вы хотите использовать цифры в названии, то ставьте их после букв, к примеру - '''метро40'''.

= Музыка и звук =

В '''FURQ''' есть целый ряд команд для воспроизведения аудио. Оно может быть всевозможных форматов: WAV, AIFF, MP3, MP2, MP1, OGG, MIDXM, IT, S3M, MOD, MTM, UMX. Есть возможность тонкого регулирования громкости звука.

Для начала запасемся на ресурсах, где свободно распространяют звуки (например, www.freesound.org) или запишем сами материала для проигрывания.

==Play==

Команда '''Play''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''play [loop|stop] [<имя файла>[, <громкость>]]'''

Чтобы просто запустить звук на проигрывание с помощью play напишите после команды имя файла. Например, нужно проиграть некий звук крокодила ''alligator.ogg''. Для этого пишем:
'''play alligator.ogg'''

Если файл alligator.ogg лежит рядом с файлом игры, то мы услышим нечто. Но если мы для удобства положим все звуки в отдельную папку sounds, то придется написать так:
'''play sounds/alligator.ogg'''

В нашем примере звук крокодила будет звучать всего один раз, однако, при помощи параметра '''loop''' мы сможем заставить крокодила двигаться и звучать бесконечно:
'''play loop sounds/alligator.ogg'''

Теперь звук будет повторяться снова и снова. Остановить его сможет только параметр '''stop''':
'''play stop sounds/alligator.ogg'''

При помощи '''Play''' можно одновременно проигрывать несколько звуков. Кроме того, можно регулировать громкость звука, добавив к команде play через запятую значение от '''0''' (полная тишина) до '''255''' (максимальная громкость). По умолчанию, '''play''' играет аудио с максимальной громкостью.

К примеру, мы хотим, одновременно наслаждаться звуком крокодила и чмоканием болота, но так, чтобы крокодил был слышен громче:
'''play loop sounds/alligator.ogg'''
'''play loop sounds/swamp.wav, 100'''

Чтобы остановить сразу все звуки, запущенные командой '''play''', мы применим такую на первый взгляд абсурдную команду как:
'''play stop'''

''; Важно помнить, что звуки запущенные на одной локации через '''play''' с параметром '''loop''' без новой команды с параметром '''stop''' сами собой не прекратятся, даже если вы перешли на другую локацию. И если вы вдруг оттуда вернетесь на прежнюю локацию, то те же самые звуки запустятся еще раз. Добро пожаловать в какафонию.''

==Voice==

Команда '''Voice''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''voice <имя файла>'''
'''voice stop'''

Команда предназначена специально для озвучивания игры голосом. Например, ей удобно запускать записи реплик персонажей или рассказчика. Во многом она аналогична команде '''play''', но с несколькими важными особенностями:
Проигрывать можно только одну реплику/звук одновременно(запуск другой озвучки через команду voice останавливает предыдущую).

Переход на другую локацию по кнопке ('''btn''') останавливает озвучку.

Громкость здесь регулируется числовой переменной '''voice_volume''' (от '''0''' до '''255''').

Остановить проигрывание файла можно при помощи команды '''voice stop'''.

Если вам необходимо чтобы прозвучало несколько реплик на одной локации, то достаточно удобно использовать команду voice в связке с командой '''anykey'''. Прослушав реплику, игрок будет нажимать на любую клавишу и слушать следующую.

Например:

'''voice_volume=200'''
'''pln - Еще раз здравствуй. - сказал крокодил и придвинулся поближе.'''
'''voice sounds/helloagain.ogg'''
'''anykey'''
'''pln Вам стало не по себе.'''
'''voice sounds/SCREAM.wav'''

==Music==

Кроме форматов аудиофайлов, которые воспроизводят команды '''play''' и '''voice''', команда '''music''' проигрывает еще и трекерную музыку (XM, IT, S3M, MOD, MTM, UMX), MIDI-файлы (MID) и MO3.

Формат команды:
'''music <имя файла>|stop[, <время в миллисекундах>]'''

Зацикливание проигрывания устанавливается в переменной music_looped ('''0''' - играть один раз, '''1''' - играть бесконечно). По умолчанию, вот отличие от команд '''play''' и '''voice''', здесь музыка зациклена.

''; некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.

''Громкость воспроизведения регулируется переменной music_volume (от '''0''' до '''255''').

С помощью команды '''music''' можно проигрывать только один файл одновременно, однако, можно задавать время, в течении которого громкость следующего аудиофайла будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект '''crossfade''' – старый трек будет угасать, а новый – нарастать по громкости.

Так “'''music stop'''” останавливает воспроизведение музыки. А если указать в качестве параметра время, то воспроизведение остановится через заданный промежуток.
'''music stop, 1500 ''; остановить музыку через 1,5 секунды'''''

===fademusic===

С помощью команды '''fademusic''' можно добиться плавного и красивого изменения громкости музыки.
Формат команды:
'''fademusic <громкость>, <время в миллисекундах>'''
громкость – целевая громкость музыки.

время в миллисекундах – время, в течении которого громкость достигнет целевого значения.

Предположим, что мы хотим сделать красивое и удобное включение и выключение музыки в нашей игре. Для этого используем [[инвентарь]] '''URQ'''. Игрок в любой момент сможет через пункт меню инвентаря включить и выключить музыку, а мы постараемся, чтобы это было плавно. На самом деле выключать музыку совсем мы не будем, а будем только понижать громкость до нуля, но зато нам не придется задаваться вопросом какой именно файл запускать при включении музыки.

В начале игры создадим элемент инвентаря “музыка” и присвоим ему наклейку “выключить музыку”:
'''inv+ музыка'''
'''idisp_музыка = "выключить музыку"'''
Запускаем любую музыку, в любом месте игры:
'''music music\Joe Hisaishi - Пылью на твоих руках.mp3'''
Теперь, в локации, которая отвечает за наш элемент инвентаря “музыка” используем оператор '''fademusic''':
''':Use_музыка'''
'''if idisp_музыка == "включить музыку" then idisp_музыка = "выключить музыку" & fademusic 255, 1500 else idisp_музыка = "включить музыку" & fademusic 0, 1500'''
'''end'''
Теперь по нажатию на “выключить музыку” громкость будет плавно затихать до нуля за 1,5 секунды, а по нажатию на “включить музыку” - так же плавно возрастать.

=Функции=

==Случайное значение Rnd==

Иногда полезно - особенно, если не злоупотреблять этим, ввести в квест элемент случайности, непредсказуемости. Именно для этого был введен механизм случайности: Rnd[x] - системная переменная (только для чтения) которая при пустом значении x хранит в себе случайное значение от 0 до 1, включая 1, а при целом x (к примеру, X=6) выдает выдает целые значения (от 1 до 6 включительно в нашем случае). При каждом обращении к переменной она принимает другое значение.

'''случай1 = rnd''' ;В результате переменная случай1 равна, например, 0.78

'''случай2 = rnd4''' ;В результате переменная случай2 равна, например, 3

==Ввод текста INPUT==

В урке есть возможность ввести строку, значение которой будет потом присвоено указанной переменной.

При необходимости ввести с клавиатуры русский текст через оператор '''input''' в строковую переменную ее следует предварительно объявить выражением:
'''строка = ""'''; Данное выражение создает строковую переменную нулевой длины.

'''pln Введите строку: & input строка'''

На экране мы увидим:
'''Введите строку:'''

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

FireURQ:Руководство пользователя

2017-03-02T14:08:03Z

Ajenta:

=Метки=

Метка - одно из важнейших понятий URQL. Она служит для выделения места в квесте, куда затем предстоит перейти. Любые перемещения в квесте могут быть либо на следующий оператор, либо на метку. Все метки имеют имена, чтобы потом можно было указывать, куда вы хотите перейти.
Определяется метка при помощи двоеточия. Все, что правее этого символа, до разделителя, которым является символ конец абзаца (Enter) или '&' - имя метки:

''':Имя_метки'''

Метка и следующий за ней оператор end являются принятой единицей измерения игры - локацией. Между ними обычно пишется описание локации и переходы из неё в другие локации.

''':начало'''
'''end'''

Например, допустимыми именами меток являются:

''':1'''
''':01'''
''':а'''
''':кот1'''
''':@(a)%^Очень_Длинная_и_Запутанная_метка_какими-лучше-не-пользоваться!!!!!_horror_так_как_сами_потом_забудете_как_она_называется!Или_сделаете_ошибку!'''
'''Вы_же_можете_сделать_маленькую_ошибку_в таком_длинном_названии?'''
''':house_flat1'''

'''''Примечание:''''' метка должна начинаться с начала строки и отделяться от других операторов (Enter) или '&', регистр имени метки не важен.

:BIG
:bIG
:Big
:big
- все эти метки для интерпретатора совершенно одинаковы. Но лучше, в целях собственного удобства, придерживаться единого стиля.

В метке лучше не делать пробелов. Длина метки не ограничена, но для удобства автора квеста лучше не делать меток длиннее строки. В метке допускаются символы, обозначающие буквы русского и латинского алфавита, цифры, знак подчеркивания и знаки арифметических операций + и - (лучше не злоупотреблять странными названиями).

Недопустимы символы ''';''' '''/*''' '''*/''' '''&'''

Грамотное использование имен меток способно серьезно облегчить работу автора.

=Текст=
==Вывод текста==

Поскольку мы имеем дело с текстовыми играми, важнейшим для нас является вывод текста. В FURQ существует несколько способов вывода текста.

===Текст на экране===

Простейший способ вывести текст это использовать команды '''P''' и '''PLN'''. Советую освоить их, прежде чем переходить к другим способам вывода.

Формат команд:
'''p''' [текст]
'''pln''' [текст]

Регистр команд не имеет значения ('''pLn''' = '''PLN''' = '''Pln''').

На практике это выглядит так:
'''p''' Этот текст появится на экране.
или
'''pln''' Этот текст тоже появится на экране.

Каждая последующая команда '''P''' или '''PLN''' дописывает новый текст к тексту который уже есть на экране. Когда текста становится слишком много, появляется возможность его прокрутить.

Разница этих двух команд в следующем - '''P''' просто добавляет новый текст, а '''PLN''' добавляет текст и делает переход на новую строку (создает абзац).

Например:
'''p''' А
'''p''' Б

Выдаст “АБ”, тогда как

'''pln''' А
'''pln''' Б

Выдаст:
А
Б

Чаще всего пользуются командой '''pln''', однако и '''p''' может быть полезна, например, когда строчка текста, которую мы хотим вывести на экран, состоит из нескольких частей и зависит от каких-либо переменных или условий.

Команды '''P''' и '''PLN''' могут напрямую выводить любые символы (кроме символа комментария '''“;”'''), переменные и ссылки.

===Вывод переменных===

Вывод переменных возможен в двух вариантах - числовом и текстовом. Для того чтобы их вывести, нужно заключить имена переменных в соответствующие скобки:
'''pln''' '''#%'''имя_текстовой_переменной'''$''' '''#'''имя_числовой_переменной'''$'''
Несмотря на внешнее сходство, они отличаются содержанием и символом '''%'''. Если в числовые скобки попадет текстовая переменная, то на выводе окажется не текст, а количество символов в этой переменной. И наоборот, если числовая переменная попадет в текстовые скобки, то на выводе окажется пустота.

Выведем оба типа переменных на экран:

'''текстовая_переменная="Геннадий"'''
'''числовая_переменная=42'''
'''pln''' Крокодил схватил вас за ногу и сказал:
'''pln''' - Меня зовут '''#%текстовая_переменная$'''.
'''pln''' Затем крокодил схватил вас за другую ногу и сказал:
'''pln''' - Мне '''#числовая_переменная$''' года. Давай, ты станешь моим близким другом.

Результат:
Крокодил схватил вас за ногу и сказал:
- Меня зовут Геннадий.
Затем крокодил схватил вас за другую ногу и сказал:
- Мне 42 года. Давай, ты станешь моим близким другом.

Кроме того, в '''URQL''' есть специальные обозначения для вывода символа пробела - '''#$''', вывода символа переноса строки - '''#/$''' и вывода символа по ascii-коду - '''##'''ascii-код'''$'''.

Так, например, символ комментария можно вывести на экран, через его ascii-код:
'''pln''' Моя грамотность была на исходе'''##59$''' но, несмотря на это, я поставил точку с запятой в предложении.

Результат:
Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.

Хочу напомнить, что если бы мы написали в коде просто:
'''pln''' Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.
То получили бы на экране:
Моя грамотность была на исходе
Потому что символ ";" и все что после него идет было бы обработано как комментарий.

'''Примечание:'''
Вывод строковой переменной, как числа '''#текстовая_переменная$''' даст нам количество символов в строке.

==Оформление текста==

В 21 веке в '''FURQ''' текст это не просто набор символов, но еще и набор гарнитур, цвет, выравнивание и местоположение.

===Местоположение===
Область экрана, куда выводят текст команды '''p''' и '''pln''' можно двигать, делать шире, уже, выше и т.д. Для этого служат системные переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height''', которые описывают некий прямоугольник куда и выводится текст. По умолчанию он занимает почти весь экран. Это числовые переменные, которые содержат значения в пикселях.

Давайте, используя полученные нами знания, выведем значения этих переменных на экран:
'''pln''' Левая граница='''#textpane_left$''', Верхняя граница='''#textpane_top$''', Ширина='''#textpane_width$''', Высота='''#textpane_height$'''

Результат:
Левая граница=20, Верхняя граница=55, Ширина=760, Высота=525

Вы можете изменять значения этих переменных как угодно в любом месте игры. Например, вы хотите вывести справа от текста картинку: измените ширину ('''textpane_width''') так чтобы текст не мешал. А когда картинка больше не нужна измените ширину обратно. Экспериментируйте.

===Выравнивание текста===

За выравнивание текста отвечает команда числовая системная переменная textalign. Она сообщает FURQ как должен быть расположен текст относительно области его вывода.

Лучше всего это понять на примере:
'''textalign = 1'''
'''pln''' текст выравнивается влево
'''textalign = 2'''
'''pln''' текст выравнивается вправо
'''textalign = 3'''
'''pln''' текст выравнивается по центру

''; Главное теперь не забыть, поменять переменную обратно на '''1''', если вы не хотите, чтобы текст всей игры был выравнен по центру.''

===Цвет===

Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате '''0xAARRGGBB'''. То есть четыре составляющих: альфа, красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.

Встроенная функция '''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255''' (т.е. полностью видимый цвет).

Пример:
'''proc''' _color(x+15, 10, 255, 60)
'''textcolor = _result'''

===Шрифт===

Для определения шрифта, которым будет выводиться текст, используется переменная '''textfont'''. В нее в виде строкового значения следует записать имя файла шрифта.

'''FireURQ''' позволяет использовать обычные True Type шрифты Windows. Для этого шрифт должен быть либо установлен в системе, либо лежать в папке с игрой (архиве QSZ).

Формат использования шрифта такой:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]'''

*'''size''' – размер шрифта(по умолчанию '''19'''), а точнее высота строки в пикселях
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')

Допустим, мы хотим вывести текст шрифтом Georgia.

Для этого пишем:
'''textfont = "georgia.ttf"'''
И сразу же проверяем результат, при помощи оператора вывода текста '''pln''', который мы уже освоили в совершенстве:
'''pln Крокодил зарылся в ил, крокодила ил манил'''

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

Меняем размер на 42:
'''textfont = "georgia.ttf[42]"'''

Остальные параметры команды нужны, чтобы текст, который будет выведен на экран выглядел еще более красиво (например, при стандартных параметрах текст может выглядеть не слишком хорошо на светлом фоне). В параметре '''bgcolor''', конечно, лучше задать цвет фона, на котором будет выведен текст. Другие параметры подбираются скорее на глаз, чем по науке.

Примеры:
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

Чтобы, после манипуляций с текстом, вернуться к шрифту по умолчанию, следует выполнить:
'''textfont = "_sysfont"'''

'''FireURQ''' может использовать и растровые шрифты формата '''HGE Font''' (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат '''HGE Font''', входит в дистрибутив (папка '''fonted''').

Пример использования HGE шрифта
'''textfont = "myfont.fnt"'''

===Команда CLS===

Часто бывает так, что экран, на который уже выведен текст нужно очистить. Для того чтобы удалить весь текст, выведенный при помощи команд '''P''' и '''PLN''', существует команда '''CLS'''. У нее нет никаких параметров.

Пример:
'''pln Уйма текста.'''
'''cls'''

Результат:
 

===Другие способы вывода текста===

Иногда оказывается недостаточно команд, описанных выше. Например, вы хотите чтобы в верхнем правом углу экрана всегда отображалось количество очков, которые игрок заработал на протяжении игры. Или состояние здоровья персонажа. Или название комнаты, в которой он находится. Или все это одновременно в разных местах экрана. Тогда на помощь автору приходят текстовые [[декораторы]].

===Текст в заголовке===

Для того чтобы вывести название игры или другой текст в заголовок окна FURQ нужно поместить этот текст в системную текстовую переменную gametitle. Если переменная пуста, то в заголовке будет отображаться название файла игры.

Пример:
'''gametitle = “Крокодил”'''

Результат:

[[Изображение:Furq_titlebar.png]]

''; Иногда эту переменную удобно использовать при отладке игры, временно выводя в нее, к примеру, значения других переменных.''

= Переходы =

Любой текстовый квест можно разбить на локации с текстом и переходы между ними. Из каждой локации к другим локациям обычно ведет несколько переходов, которые обозначают некоторые альтернативные варианты действий. В этой главе мы рассмотрим способы, которыми URQL позволяет сделать переходы в игре.

==Переход по кнопкам (оператор BTN)==

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

Общее обозначение: btn <локация>, <надпись на кнопке>]

Где <локация> - имя метки, на которую будет совершен переход, <надпись на кнопке> - надпись на кнопке, которая отображается на экране. В случае если <надпись на кнопке> не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
'''btn лес,Войти в лес'''
Эта команда выведет на экран кнопку с текстом '''Войти в лес''', ведующую на локацию '''лес'''

'''''Примечание 1: пробелы до и после надписи на кнопке игнорируются.'''''

'''''Примечание 2: если локация не найдена, то кнопка выводится с пометкой // phantom.'''''

'''''Примечание 3: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

У кнопок есть так называемое "эхо". Это сообщение, выводящееся на экран о том, что вы перешли по кнопке. Чтобы оно не выводилось, следует использовать переменную '''hide_btn_echo'''. Если установить её в единицу, то сообщения показываться не будут.

'''''Пример:'''''
'''hide_btn_echo = 1'''

===Команда CLSB===

Бывает так, что нам не нужно очищать весь экран, а нужно стереть только кнопки действий. Для того чтобы удалить кнопки выведенные командой '''BTN''', существует команда '''CLSB'''. У нее нет никаких параметров.

Пример:
'''btn север, Идти на Север'''
'''clsb'''
'''btn юг, Идти на Юг'''

Результат (текст на выведенной кнопке):
'''Идти на Юг'''
 

===Оформление кнопок в Fireurq===

Оформление кнопок делается в файле skin.xml
Описание можно найти в статье [[FireURQ:Скины|FireURQ:Скины]].

==Переход по ссылке==

FireURQ позволяет использовать в тексте (и декораторах) ссылки.

'''''Формат ссылок:'''''
'''<nowiki>[[текст ссылки|название локации]]</nowiki>'''

'''''Пример:'''''
'''pln Вы стоите рядом с покосившимся <nowiki>[[домиком|домик_осмотреть]]</nowiki>. Вокруг раскинулись <nowiki>[[клумбы с аромантными цветами|клумбы_осмотреть]]</nowiki>.'''

Здесь '''домик_осмотреть''' и '''клумбы_осмотреть''' - названия локаций, на которые будут осуществляться переходы при нажатии на ссылку.

Цвет ссылок задаётся переменными linkcolor и linkhcolor. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши.

'''''Пример:'''''
'''linkcolor = 0xffffff'''
'''linkhcolor = 0x0000ff'''
В данном примере цвет ссылок в тексте будет белым, а при наведении станет синим.

Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

'''''Упрощенный формат вывода ссылок такой:'''''
'''<nowiki>[[текст ссылки]]</nowiki>'''

В данном случае ссылка будет вести на метку под названием "текст ссылки".

'''''Пример:'''''
'''pln На волнах раскачивается деревянная <nowiki>[[лодка]]</nowiki>.'''

Здесь, при клике на ссылку произойдет переход на метку "лодка".

'''''Замечание: не рекомендуется называть метки именами с пробелами, соответственно не стоит использовать ссылки типа <nowiki>[[деревянная лодка]]</nowiki>, которые ведут на локации с такими именами.'''''

У ссылок, как и у btn есть "эхо", то есть в окне игры пишется, что вы перешли по ссылке. Чтобы его отключить, следует использовать переменную '''hide_link_echo'''. Если установить её в 1, то "эхо" выводиться не будет.

'''''Пример:'''''
'''hide_link_echo = 1'''

'''''Примечание: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

==Переход по оператору GOTO==

'''''Синтаксис:'''''
'''GoTo Метка'''

После выполнения оператора '''goto''' происходит мгновенное перемещение на указанную метку. При наличии локации common (см. ниже) операторы на локации common при переходе по '''goto''' НЕ ВЫПОЛНЯЮТСЯ. Это сделано специально и умышленно - чтобы можно было делать переходы внутри локации.

Примечание: в случае не нахождения метки, goto просто игнорируется.

'''''Пример:'''''
'''goto лес'''
Этот код произведёт перемещение на локацию с названием ''''лес'''.

==Переход по оператору PROC==

'''''Синтаксис:'''''
'''Proc Метка'''

При вызове данного оператора происходит переход на указанную метку и выполнение программы, до встречи первого end, потом управление передается оператору, следующему непосредственно за '''proc''', откуда команда была вызвана. Допустима любая вложенность '''proc'''-вызовов (вплоть до использования рекурсии!).

Нормально обрабатываются последовательные переходы по '''proc''' - цепочка ведется до тех пор, пока не встретится первый end. При этом кнопки во всех пройденных локациях накапливаются(!), но при обнаружении end'а происходит не опрос пользователя, а возврат к предыдущему proc'у и так до самого начала цепочки.

'''''Пример:'''''
''':берег_реки'''
'''pln Вы стоите на берегу реки, позади вас Туманный лес.'''
'''proc лес'''
'''pln Отсюда только одна дорога - на запад.'''
'''end'''
''';----------'''
''':лес'''
'''pln Из леса на вас поглядывают волки.'''
'''end'''

При выполнении этот код выведет на экран следующее:

Вы стоите на берегу реки, позади вас Туманный лес.
Из леса на вас поглядывают волки.
Отсюда только одна дорога - на запад.

То есть, после выполнения по '''proc''' локации '''лес''', мы вернёмся в локацию '''берег_реки''' и продолжим с того места, на котором был вызов команды '''proc'''.

'''''Важно:''''' При наличии локации common (см. ниже) операторы на локации common при переходе по '''proc''' НЕ ВЫПОЛНЯЮТСЯ и системная переменная '''current_loc''' не меняется.

'''Примечание:''' Часто из метки вызванной с помощью '''proc''' ведёт вызов '''goto''' и далее. В таком случае, если мы не хотим возврата к первой локации, нужно использовать оператор '''forget_procs'''

==Переход по декораторам TEXTBUTTON и IMGBUTTON==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Декораторы'''.

==Контекстное меню==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Выпадающие меню'''.

==Параметры при переходах==

Локальные параметры при переходах возможно передать параметры.

Общее обозначение: <метка>(param1, param2, ...)

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные <метка>_1, <метка>_2 и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).

Важное замечание: при использовании параметров в операторе btn подстановки (#...$ и #%...$) раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.

'''''Пример:'''''
'''btn лес(1,"опушка"),Войти в лес'''
На локации '''лес''', переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''

то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''

Параметры при переходах очень удобны для организации проверок внутри локации.

'''''Замечание:''''' Если вы передаёте параметры метке, то её название не должно начинаться с цифры, то есть исключены названия вроде '''25''' или '''40метро'''. Если вы хотите использовать цифры в названии, то ставьте их после букв, к примеру - '''метро40'''.

= Музыка и звук =

В '''FURQ''' есть целый ряд команд для воспроизведения аудио. Оно может быть всевозможных форматов: WAV, AIFF, MP3, MP2, MP1, OGG, MIDXM, IT, S3M, MOD, MTM, UMX. Есть возможность тонкого регулирования громкости звука.

Для начала запасемся на ресурсах, где свободно распространяют звуки (например, www.freesound.org) или запишем сами материала для проигрывания.

==Play==

Команда '''Play''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''play [loop|stop] [<имя файла>[, <громкость>]]'''

Чтобы просто запустить звук на проигрывание с помощью play напишите после команды имя файла. Например, нужно проиграть некий звук крокодила ''alligator.ogg''. Для этого пишем:
'''play alligator.ogg'''

Если файл alligator.ogg лежит рядом с файлом игры, то мы услышим нечто. Но если мы для удобства положим все звуки в отдельную папку sounds, то придется написать так:
'''play sounds/alligator.ogg'''

В нашем примере звук крокодила будет звучать всего один раз, однако, при помощи параметра '''loop''' мы сможем заставить крокодила двигаться и звучать бесконечно:
'''play loop sounds/alligator.ogg'''

Теперь звук будет повторяться снова и снова. Остановить его сможет только параметр '''stop''':
'''play stop sounds/alligator.ogg'''

При помощи '''Play''' можно одновременно проигрывать несколько звуков. Кроме того, можно регулировать громкость звука, добавив к команде play через запятую значение от '''0''' (полная тишина) до '''255''' (максимальная громкость). По умолчанию, '''play''' играет аудио с максимальной громкостью.

К примеру, мы хотим, одновременно наслаждаться звуком крокодила и чмоканием болота, но так, чтобы крокодил был слышен громче:
'''play loop sounds/alligator.ogg'''
'''play loop sounds/swamp.wav, 100'''

Чтобы остановить сразу все звуки, запущенные командой '''play''', мы применим такую на первый взгляд абсурдную команду как:
'''play stop'''

''; Важно помнить, что звуки запущенные на одной локации через '''play''' с параметром '''loop''' без новой команды с параметром '''stop''' сами собой не прекратятся, даже если вы перешли на другую локацию. И если вы вдруг оттуда вернетесь на прежнюю локацию, то те же самые звуки запустятся еще раз. Добро пожаловать в какафонию.''

==Voice==

Команда '''Voice''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''voice <имя файла>'''
'''voice stop'''

Команда предназначена специально для озвучивания игры голосом. Например, ей удобно запускать записи реплик персонажей или рассказчика. Во многом она аналогична команде '''play''', но с несколькими важными особенностями:
Проигрывать можно только одну реплику/звук одновременно(запуск другой озвучки через команду voice останавливает предыдущую).

Переход на другую локацию по кнопке ('''btn''') останавливает озвучку.

Громкость здесь регулируется числовой переменной '''voice_volume''' (от '''0''' до '''255''').

Остановить проигрывание файла можно при помощи команды '''voice stop'''.

Если вам необходимо чтобы прозвучало несколько реплик на одной локации, то достаточно удобно использовать команду voice в связке с командой '''anykey'''. Прослушав реплику, игрок будет нажимать на любую клавишу и слушать следующую.

Например:

'''voice_volume=200'''
'''pln - Еще раз здравствуй. - сказал крокодил и придвинулся поближе.'''
'''voice sounds/helloagain.ogg'''
'''anykey'''
'''pln Вам стало не по себе.'''
'''voice sounds/SCREAM.wav'''

==Music==

Кроме форматов аудиофайлов, которые воспроизводят команды '''play''' и '''voice''', команда '''music''' проигрывает еще и трекерную музыку (XM, IT, S3M, MOD, MTM, UMX), MIDI-файлы (MID) и MO3.

Формат команды:
'''music <имя файла>|stop[, <время в миллисекундах>]'''

Зацикливание проигрывания устанавливается в переменной music_looped ('''0''' - играть один раз, '''1''' - играть бесконечно). По умолчанию, вот отличие от команд '''play''' и '''voice''', здесь музыка зациклена.

''; некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.

''Громкость воспроизведения регулируется переменной music_volume (от '''0''' до '''255''').

С помощью команды '''music''' можно проигрывать только один файл одновременно, однако, можно задавать время, в течении которого громкость следующего аудиофайла будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект '''crossfade''' – старый трек будет угасать, а новый – нарастать по громкости.

Так “'''music stop'''” останавливает воспроизведение музыки. А если указать в качестве параметра время, то воспроизведение остановится через заданный промежуток.
'''music stop, 1500 ''; остановить музыку через 1,5 секунды'''''

===fademusic===

С помощью команды '''fademusic''' можно добиться плавного и красивого изменения громкости музыки.
Формат команды:
'''fademusic <громкость>, <время в миллисекундах>'''
громкость – целевая громкость музыки.

время в миллисекундах – время, в течении которого громкость достигнет целевого значения.

Предположим, что мы хотим сделать красивое и удобное включение и выключение музыки в нашей игре. Для этого используем [[инвентарь]] '''URQ'''. Игрок в любой момент сможет через пункт меню инвентаря включить и выключить музыку, а мы постараемся, чтобы это было плавно. На самом деле выключать музыку совсем мы не будем, а будем только понижать громкость до нуля, но зато нам не придется задаваться вопросом какой именно файл запускать при включении музыки.

В начале игры создадим элемент инвентаря “музыка” и присвоим ему наклейку “выключить музыку”:
'''inv+ музыка'''
'''idisp_музыка = "выключить музыку"'''
Запускаем любую музыку, в любом месте игры:
'''music music\Joe Hisaishi - Пылью на твоих руках.mp3'''
Теперь, в локации, которая отвечает за наш элемент инвентаря “музыка” используем оператор '''fademusic''':
''':Use_музыка'''
'''if idisp_музыка == "включить музыку" then idisp_музыка = "выключить музыку" & fademusic 255, 1500 else idisp_музыка = "включить музыку" & fademusic 0, 1500'''
'''end'''
Теперь по нажатию на “выключить музыку” громкость будет плавно затихать до нуля за 1,5 секунды, а по нажатию на “включить музыку” - так же плавно возрастать.

=Функции=

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

FireURQ:Руководство пользователя

2017-03-02T14:02:42Z

Ajenta: /* Переход по оператору PROC */

=Метки=

Метка - одно из важнейших понятий URQL. Она служит для выделения места в квесте, куда затем предстоит перейти. Любые перемещения в квесте могут быть либо на следующий оператор, либо на метку. Все метки имеют имена, чтобы потом можно было указывать, куда вы хотите перейти.
Определяется метка при помощи двоеточия. Все, что правее этого символа, до разделителя, которым является символ конец абзаца (Enter) или '&' - имя метки:

''':Имя_метки'''

Метка и следующий за ней оператор end являются принятой единицей измерения игры - локацией. Между ними обычно пишется описание локации и переходы из неё в другие локации.

''':начало'''
'''end'''

Например, допустимыми именами меток являются:

''':1'''
''':01'''
''':а'''
''':кот1'''
''':@(a)%^Очень_Длинная_и_Запутанная_метка_какими-лучше-не-пользоваться!!!!!_horror_так_как_сами_потом_забудете_как_она_называется!Или_сделаете_ошибку!'''
'''Вы_же_можете_сделать_маленькую_ошибку_в таком_длинном_названии?'''
''':house_flat1'''

'''''Примечание:''''' метка должна начинаться с начала строки и отделяться от других операторов (Enter) или '&', регистр имени метки не важен.

:BIG
:bIG
:Big
:big
- все эти метки для интерпретатора совершенно одинаковы. Но лучше, в целях собственного удобства, придерживаться единого стиля.

В метке лучше не делать пробелов. Длина метки не ограничена, но для удобства автора квеста лучше не делать меток длиннее строки. В метке допускаются символы, обозначающие буквы русского и латинского алфавита, цифры, знак подчеркивания и знаки арифметических операций + и - (лучше не злоупотреблять странными названиями).

Недопустимы символы ''';''' '''/*''' '''*/''' '''&'''

Грамотное использование имен меток способно серьезно облегчить работу автора.

=Текст=
==Вывод текста==

Поскольку мы имеем дело с текстовыми играми, важнейшим для нас является вывод текста. В FURQ существует несколько способов вывода текста.

===Текст на экране===

Простейший способ вывести текст это использовать команды '''P''' и '''PLN'''. Советую освоить их, прежде чем переходить к другим способам вывода.

Формат команд:
'''p''' [текст]
'''pln''' [текст]

Регистр команд не имеет значения ('''pLn''' = '''PLN''' = '''Pln''').

На практике это выглядит так:
'''p''' Этот текст появится на экране.
или
'''pln''' Этот текст тоже появится на экране.

Каждая последующая команда '''P''' или '''PLN''' дописывает новый текст к тексту который уже есть на экране. Когда текста становится слишком много, появляется возможность его прокрутить.

Разница этих двух команд в следующем - '''P''' просто добавляет новый текст, а '''PLN''' добавляет текст и делает переход на новую строку (создает абзац).

Например:
'''p''' А
'''p''' Б

Выдаст “АБ”, тогда как

'''pln''' А
'''pln''' Б

Выдаст:
А
Б

Чаще всего пользуются командой '''pln''', однако и '''p''' может быть полезна, например, когда строчка текста, которую мы хотим вывести на экран, состоит из нескольких частей и зависит от каких-либо переменных или условий.

Команды '''P''' и '''PLN''' могут напрямую выводить любые символы (кроме символа комментария '''“;”'''), переменные и ссылки.

===Вывод переменных===

Вывод переменных возможен в двух вариантах - числовом и текстовом. Для того чтобы их вывести, нужно заключить имена переменных в соответствующие скобки:
'''pln''' '''#%'''имя_текстовой_переменной'''$''' '''#'''имя_числовой_переменной'''$'''
Несмотря на внешнее сходство, они отличаются содержанием и символом '''%'''. Если в числовые скобки попадет текстовая переменная, то на выводе окажется не текст, а количество символов в этой переменной. И наоборот, если числовая переменная попадет в текстовые скобки, то на выводе окажется пустота.

Выведем оба типа переменных на экран:

'''текстовая_переменная="Геннадий"'''
'''числовая_переменная=42'''
'''pln''' Крокодил схватил вас за ногу и сказал:
'''pln''' - Меня зовут '''#%текстовая_переменная$'''.
'''pln''' Затем крокодил схватил вас за другую ногу и сказал:
'''pln''' - Мне '''#числовая_переменная$''' года. Давай, ты станешь моим близким другом.

Результат:
Крокодил схватил вас за ногу и сказал:
- Меня зовут Геннадий.
Затем крокодил схватил вас за другую ногу и сказал:
- Мне 42 года. Давай, ты станешь моим близким другом.

Кроме того, в '''URQL''' есть специальные обозначения для вывода символа пробела - '''#$''', вывода символа переноса строки - '''#/$''' и вывода символа по ascii-коду - '''##'''ascii-код'''$'''.

Так, например, символ комментария можно вывести на экран, через его ascii-код:
'''pln''' Моя грамотность была на исходе'''##59$''' но, несмотря на это, я поставил точку с запятой в предложении.

Результат:
Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.

Хочу напомнить, что если бы мы написали в коде просто:
'''pln''' Моя грамотность была на исходе; но, несмотря на это, я поставил точку с запятой в предложении.
То получили бы на экране:
Моя грамотность была на исходе
Потому что символ ";" и все что после него идет было бы обработано как комментарий.

'''Примечание:'''
Вывод строковой переменной, как числа '''#текстовая_переменная$''' даст нам количество символов в строке.

==Оформление текста==

В 21 веке в '''FURQ''' текст это не просто набор символов, но еще и набор гарнитур, цвет, выравнивание и местоположение.

===Местоположение===
Область экрана, куда выводят текст команды '''p''' и '''pln''' можно двигать, делать шире, уже, выше и т.д. Для этого служат системные переменные '''textpane_left''', '''textpane_top''', '''textpane_width''' и '''textpane_height''', которые описывают некий прямоугольник куда и выводится текст. По умолчанию он занимает почти весь экран. Это числовые переменные, которые содержат значения в пикселях.

Давайте, используя полученные нами знания, выведем значения этих переменных на экран:
'''pln''' Левая граница='''#textpane_left$''', Верхняя граница='''#textpane_top$''', Ширина='''#textpane_width$''', Высота='''#textpane_height$'''

Результат:
Левая граница=20, Верхняя граница=55, Ширина=760, Высота=525

Вы можете изменять значения этих переменных как угодно в любом месте игры. Например, вы хотите вывести справа от текста картинку: измените ширину ('''textpane_width''') так чтобы текст не мешал. А когда картинка больше не нужна измените ширину обратно. Экспериментируйте.

===Выравнивание текста===

За выравнивание текста отвечает команда числовая системная переменная textalign. Она сообщает FURQ как должен быть расположен текст относительно области его вывода.

Лучше всего это понять на примере:
'''textalign = 1'''
'''pln''' текст выравнивается влево
'''textalign = 2'''
'''pln''' текст выравнивается вправо
'''textalign = 3'''
'''pln''' текст выравнивается по центру

''; Главное теперь не забыть, поменять переменную обратно на '''1''', если вы не хотите, чтобы текст всей игры был выравнен по центру.''

===Цвет===

Для определения цвета выводимого текста служит переменная '''textcolor'''. Цвет в '''FireURQ''' задается шестнадцатиричным числом в формате '''0xAARRGGBB'''. То есть четыре составляющих: альфа, красный, зеленый и синий. При этом альфу можно опускать, т.е. цвет '''0xFF7F05BB''' и '''0x7F05BB''' – равнозначны. Также, для обратной совместимости поддерживается переменная '''Style_dos_textcolor''', которая работает так же, как и в '''DOS_URQ'''. Цвет фона менять нельзя, только цвет букв.

Встроенная функция '''_color([a,] r, g, b)''' – позволяет получить значение цвета из его составляющих. Если составляющая прозрачности ('''a''') не указана, то она принимается равной '''255''' (т.е. полностью видимый цвет).

Пример:
'''proc''' _color(x+15, 10, 255, 60)
'''textcolor = _result'''

===Шрифт===

Для определения шрифта, которым будет выводиться текст, используется переменная '''textfont'''. В нее в виде строкового значения следует записать имя файла шрифта.

'''FireURQ''' позволяет использовать обычные True Type шрифты Windows. Для этого шрифт должен быть либо установлен в системе, либо лежать в папке с игрой (архиве QSZ).

Формат использования шрифта такой:
'''textfont = "file.ttf[<size>, <gamma>, <weight>, <bgcolor>]'''

*'''size''' – размер шрифта(по умолчанию '''19'''), а точнее высота строки в пикселях
*'''gamma''' – гамма, т.е. "светлость" границ шрифта(по умолчанию '''1.0''')
*'''weight''' – толщина(по умолчанию '''0.6''')
*'''bgcolor''' – цвет подложки (по умолчанию '''0x808080''')

Допустим, мы хотим вывести текст шрифтом Georgia.

Для этого пишем:
'''textfont = "georgia.ttf"'''
И сразу же проверяем результат, при помощи оператора вывода текста '''pln''', который мы уже освоили в совершенстве:
'''pln Крокодил зарылся в ил, крокодила ил манил'''

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

Меняем размер на 42:
'''textfont = "georgia.ttf[42]"'''

Остальные параметры команды нужны, чтобы текст, который будет выведен на экран выглядел еще более красиво (например, при стандартных параметрах текст может выглядеть не слишком хорошо на светлом фоне). В параметре '''bgcolor''', конечно, лучше задать цвет фона, на котором будет выведен текст. Другие параметры подбираются скорее на глаз, чем по науке.

Примеры:
'''textfont = "georgia.ttf[20,1.1]"'''
'''textfont = "verdana.ttf[10,,,0xFFFFFF]"'''
'''textfont = "timesi.ttf[32,,1.3]"'''

Чтобы, после манипуляций с текстом, вернуться к шрифту по умолчанию, следует выполнить:
'''textfont = "_sysfont"'''

'''FireURQ''' может использовать и растровые шрифты формата '''HGE Font''' (заимствовано из библиотеки HGE). Редактор, позволяющий конвертировать шрифты, установленные в Windows, в формат '''HGE Font''', входит в дистрибутив (папка '''fonted''').

Пример использования HGE шрифта
'''textfont = "myfont.fnt"'''

===Команда CLS===

Часто бывает так, что экран, на который уже выведен текст нужно очистить. Для того чтобы удалить весь текст, выведенный при помощи команд '''P''' и '''PLN''', существует команда '''CLS'''. У нее нет никаких параметров.

Пример:
'''pln Уйма текста.'''
'''cls'''

Результат:
 

===Другие способы вывода текста===

Иногда оказывается недостаточно команд, описанных выше. Например, вы хотите чтобы в верхнем правом углу экрана всегда отображалось количество очков, которые игрок заработал на протяжении игры. Или состояние здоровья персонажа. Или название комнаты, в которой он находится. Или все это одновременно в разных местах экрана. Тогда на помощь автору приходят текстовые [[декораторы]].

===Текст в заголовке===

Для того чтобы вывести название игры или другой текст в заголовок окна FURQ нужно поместить этот текст в системную текстовую переменную gametitle. Если переменная пуста, то в заголовке будет отображаться название файла игры.

Пример:
'''gametitle = “Крокодил”'''

Результат:

[[Изображение:Furq_titlebar.png]]

''; Иногда эту переменную удобно использовать при отладке игры, временно выводя в нее, к примеру, значения других переменных.''

= Переходы =

Любой текстовый квест можно разбить на локации с текстом и переходы между ними. Из каждой локации к другим локациям обычно ведет несколько переходов, которые обозначают некоторые альтернативные варианты действий. В этой главе мы рассмотрим способы, которыми URQL позволяет сделать переходы в игре.

==Переход по кнопкам (оператор BTN)==

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

Общее обозначение: btn <локация>, <надпись на кнопке>]

Где <локация> - имя метки, на которую будет совершен переход, <надпись на кнопке> - надпись на кнопке, которая отображается на экране. В случае если <надпись на кнопке> не указана, в качестве надписи используется название метки, куда ведет кнопка.

'''''Пример:'''''
'''btn лес,Войти в лес'''
Эта команда выведет на экран кнопку с текстом '''Войти в лес''', ведующую на локацию '''лес'''

'''''Примечание 1: пробелы до и после надписи на кнопке игнорируются.'''''

'''''Примечание 2: если локация не найдена, то кнопка выводится с пометкой // phantom.'''''

'''''Примечание 3: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

У кнопок есть так называемое "эхо". Это сообщение, выводящееся на экран о том, что вы перешли по кнопке. Чтобы оно не выводилось, следует использовать переменную '''hide_btn_echo'''. Если установить её в единицу, то сообщения показываться не будут.

'''''Пример:'''''
'''hide_btn_echo = 1'''

===Команда CLSB===

Бывает так, что нам не нужно очищать весь экран, а нужно стереть только кнопки действий. Для того чтобы удалить кнопки выведенные командой '''BTN''', существует команда '''CLSB'''. У нее нет никаких параметров.

Пример:
'''btn север, Идти на Север'''
'''clsb'''
'''btn юг, Идти на Юг'''

Результат (текст на выведенной кнопке):
'''Идти на Юг'''
 

===Оформление кнопок в Fireurq===

Оформление кнопок делается в файле skin.xml
Описание можно найти в статье [[FireURQ:Скины|FireURQ:Скины]].

==Переход по ссылке==

FireURQ позволяет использовать в тексте (и декораторах) ссылки.

'''''Формат ссылок:'''''
'''<nowiki>[[текст ссылки|название локации]]</nowiki>'''

'''''Пример:'''''
'''pln Вы стоите рядом с покосившимся <nowiki>[[домиком|домик_осмотреть]]</nowiki>. Вокруг раскинулись <nowiki>[[клумбы с аромантными цветами|клумбы_осмотреть]]</nowiki>.'''

Здесь '''домик_осмотреть''' и '''клумбы_осмотреть''' - названия локаций, на которые будут осуществляться переходы при нажатии на ссылку.

Цвет ссылок задаётся переменными linkcolor и linkhcolor. Первая отвечает за цвет ссылки в тексте, а вторая - за цвет ссылки при наведении мыши.

'''''Пример:'''''
'''linkcolor = 0xffffff'''
'''linkhcolor = 0x0000ff'''
В данном примере цвет ссылок в тексте будет белым, а при наведении станет синим.

Невалидные ссылки (указывающие на несуществующую локацию) всегда подсвечены красным цветом.

'''''Упрощенный формат вывода ссылок такой:'''''
'''<nowiki>[[текст ссылки]]</nowiki>'''

В данном случае ссылка будет вести на метку под названием "текст ссылки".

'''''Пример:'''''
'''pln На волнах раскачивается деревянная <nowiki>[[лодка]]</nowiki>.'''

Здесь, при клике на ссылку произойдет переход на метку "лодка".

'''''Замечание: не рекомендуется называть метки именами с пробелами, соответственно не стоит использовать ссылки типа <nowiki>[[деревянная лодка]]</nowiki>, которые ведут на локации с такими именами.'''''

У ссылок, как и у btn есть "эхо", то есть в окне игры пишется, что вы перешли по ссылке. Чтобы его отключить, следует использовать переменную '''hide_link_echo'''. Если установить её в 1, то "эхо" выводиться не будет.

'''''Пример:'''''
'''hide_link_echo = 1'''

'''''Примечание: при наличии локации common (см. ниже) сначала выполняются операторы на локации common, потом осуществляется переход на метку локации.'''''

==Переход по оператору GOTO==

'''''Синтаксис:'''''
'''GoTo Метка'''

После выполнения оператора '''goto''' происходит мгновенное перемещение на указанную метку. При наличии локации common (см. ниже) операторы на локации common при переходе по '''goto''' НЕ ВЫПОЛНЯЮТСЯ. Это сделано специально и умышленно - чтобы можно было делать переходы внутри локации.

Примечание: в случае не нахождения метки, goto просто игнорируется.

'''''Пример:'''''
'''goto лес'''
Этот код произведёт перемещение на локацию с названием ''''лес'''.

==Переход по оператору PROC==

'''''Синтаксис:'''''
'''Proc Метка'''

При вызове данного оператора происходит переход на указанную метку и выполнение программы, до встречи первого end, потом управление передается оператору, следующему непосредственно за '''proc''', откуда команда была вызвана. Допустима любая вложенность '''proc'''-вызовов (вплоть до использования рекурсии!).

Нормально обрабатываются последовательные переходы по '''proc''' - цепочка ведется до тех пор, пока не встретится первый end. При этом кнопки во всех пройденных локациях накапливаются(!), но при обнаружении end'а происходит не опрос пользователя, а возврат к предыдущему proc'у и так до самого начала цепочки.

'''''Пример:'''''
''':берег_реки'''
'''pln Вы стоите на берегу реки, позади вас Туманный лес.'''
'''proc лес'''
'''pln Отсюда только одна дорога - на запад.'''
'''end'''
''';----------'''
''':лес'''
'''pln Из леса на вас поглядывают волки.'''
'''end'''

При выполнении этот код выведет на экран следующее:

Вы стоите на берегу реки, позади вас Туманный лес.
Из леса на вас поглядывают волки.
Отсюда только одна дорога - на запад.

То есть, после выполнения по '''proc''' локации '''лес''', мы вернёмся в локацию '''берег_реки''' и продолжим с того места, на котором был вызов команды '''proc'''.

'''''Важно:''''' При наличии локации common (см. ниже) операторы на локации common при переходе по '''proc''' НЕ ВЫПОЛНЯЮТСЯ и системная переменная '''current_loc''' не меняется.

'''Примечание:''' Часто из метки вызванной с помощью '''proc''' ведёт вызов '''goto''' и далее. В таком случае, если мы не хотим возврата к первой локации, нужно использовать оператор '''forget_procs'''

==Переход по декораторам TEXTBUTTON и IMGBUTTON==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Декораторы'''.

==Контекстное меню==

Описание можно найти в статье [[FireURQ:Особенности_реализации_URQL|FireURQ:Особенности_реализации_URQL]]. В разделе '''Выпадающие меню'''.

==Параметры при переходах==

Локальные параметры при переходах возможно передать параметры.

Общее обозначение: <метка>(param1, param2, ...)

В качестве параметров могут быть использованы любые выражения. Параметры при этом попадают в переменные <метка>_1, <метка>_2 и так далее. Все старые значения "переменных с параметрами" — удаляются (даже если в прошлый раз было больше параметров).

Важное замечание: при использовании параметров в операторе btn подстановки (#...$ и #%...$) раскрываются ПРИ ДОБАВЛЕНИИ КНОПКИ, а вычисление выражений в параметрах производится ПРИ НАЖАТИИ НА КНОПКУ.

'''''Пример:'''''
'''btn лес(1,"опушка"),Войти в лес'''
На локации '''лес''', переменные '''лес_1''' и '''лес_2''' будут соответссвенно равны '''1''' и '''опушка'''

то есть, если мы напишем код:
''':лес'''
'''pln #лес_1$ и #%лес_2$'''
'''end'''
то в результате, при переходе по кнопке, увидим на экране:
'''1 и опушка'''

Параметры при переходах очень удобны для организации проверок внутри локации.

'''''Замечание:''''' Если вы передаёте параметры метке, то её название не должно начинаться с цифры, то есть исключены названия вроде '''25''' или '''40метро'''. Если вы хотите использовать цифры в названии, то ставьте их после букв, к примеру - '''метро40'''.

= Музыка и звук =

В '''FURQ''' есть целый ряд команд для воспроизведения аудио. Оно может быть всевозможных форматов: WAV, AIFF, MP3, MP2, MP1, OGG, MIDXM, IT, S3M, MOD, MTM, UMX. Есть возможность тонкого регулирования громкости звука.

Для начала запасемся на ресурсах, где свободно распространяют звуки (например, www.freesound.org) или запишем сами материала для проигрывания.

==Play==

Команда '''Play''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''play [loop|stop] [<имя файла>[, <громкость>]]'''

Чтобы просто запустить звук на проигрывание с помощью play напишите после команды имя файла. Например, нужно проиграть некий звук крокодила ''alligator.ogg''. Для этого пишем:
'''play alligator.ogg'''

Если файл alligator.ogg лежит рядом с файлом игры, то мы услышим нечто. Но если мы для удобства положим все звуки в отдельную папку sounds, то придется написать так:
'''play sounds/alligator.ogg'''

В нашем примере звук крокодила будет звучать всего один раз, однако, при помощи параметра '''loop''' мы сможем заставить крокодила двигаться и звучать бесконечно:
'''play loop sounds/alligator.ogg'''

Теперь звук будет повторяться снова и снова. Остановить его сможет только параметр '''stop''':
'''play stop sounds/alligator.ogg'''

При помощи '''Play''' можно одновременно проигрывать несколько звуков. Кроме того, можно регулировать громкость звука, добавив к команде play через запятую значение от '''0''' (полная тишина) до '''255''' (максимальная громкость). По умолчанию, '''play''' играет аудио с максимальной громкостью.

К примеру, мы хотим, одновременно наслаждаться звуком крокодила и чмоканием болота, но так, чтобы крокодил был слышен громче:
'''play loop sounds/alligator.ogg'''
'''play loop sounds/swamp.wav, 100'''

Чтобы остановить сразу все звуки, запущенные командой '''play''', мы применим такую на первый взгляд абсурдную команду как:
'''play stop'''

''; Важно помнить, что звуки запущенные на одной локации через '''play''' с параметром '''loop''' без новой команды с параметром '''stop''' сами собой не прекратятся, даже если вы перешли на другую локацию. И если вы вдруг оттуда вернетесь на прежнюю локацию, то те же самые звуки запустятся еще раз. Добро пожаловать в какафонию.''

==Voice==

Команда '''Voice''' используется для проигрывания аудиофайлов формата WAV/AIFF/MP3/MP2/MP1/OGG

Формат команды:
'''voice <имя файла>'''
'''voice stop'''

Команда предназначена специально для озвучивания игры голосом. Например, ей удобно запускать записи реплик персонажей или рассказчика. Во многом она аналогична команде '''play''', но с несколькими важными особенностями:
Проигрывать можно только одну реплику/звук одновременно(запуск другой озвучки через команду voice останавливает предыдущую).

Переход на другую локацию по кнопке ('''btn''') останавливает озвучку.

Громкость здесь регулируется числовой переменной '''voice_volume''' (от '''0''' до '''255''').

Остановить проигрывание файла можно при помощи команды '''voice stop'''.

Если вам необходимо чтобы прозвучало несколько реплик на одной локации, то достаточно удобно использовать команду voice в связке с командой '''anykey'''. Прослушав реплику, игрок будет нажимать на любую клавишу и слушать следующую.

Например:

'''voice_volume=200'''
'''pln - Еще раз здравствуй. - сказал крокодил и придвинулся поближе.'''
'''voice sounds/helloagain.ogg'''
'''anykey'''
'''pln Вам стало не по себе.'''
'''voice sounds/SCREAM.wav'''

==Music==

Кроме форматов аудиофайлов, которые воспроизводят команды '''play''' и '''voice''', команда '''music''' проигрывает еще и трекерную музыку (XM, IT, S3M, MOD, MTM, UMX), MIDI-файлы (MID) и MO3.

Формат команды:
'''music <имя файла>|stop[, <время в миллисекундах>]'''

Зацикливание проигрывания устанавливается в переменной music_looped ('''0''' - играть один раз, '''1''' - играть бесконечно). По умолчанию, вот отличие от команд '''play''' и '''voice''', здесь музыка зациклена.

''; некоторые файлы трекерной музыки зациклены сами по себе, с помощью внутренних команд формата. Такие файлы будут играть по кругу вне зависимости от переменной '''music_looped'''.

''Громкость воспроизведения регулируется переменной music_volume (от '''0''' до '''255''').

С помощью команды '''music''' можно проигрывать только один файл одновременно, однако, можно задавать время, в течении которого громкость следующего аудиофайла будет нарастать (или угасать – в зависимости от того, включаем мы воспроизведение, или выключаем). Если музыка уже звучит и мы запускаем новый трек с указанием времени нарастания громкости, то будет исполнен эффект '''crossfade''' – старый трек будет угасать, а новый – нарастать по громкости.

Так “'''music stop'''” останавливает воспроизведение музыки. А если указать в качестве параметра время, то воспроизведение остановится через заданный промежуток.
'''music stop, 1500 ''; остановить музыку через 1,5 секунды'''''

===fademusic===

С помощью команды '''fademusic''' можно добиться плавного и красивого изменения громкости музыки.
Формат команды:
'''fademusic <громкость>, <время в миллисекундах>'''
громкость – целевая громкость музыки.

время в миллисекундах – время, в течении которого громкость достигнет целевого значения.

Предположим, что мы хотим сделать красивое и удобное включение и выключение музыки в нашей игре. Для этого используем [[инвентарь]] '''URQ'''. Игрок в любой момент сможет через пункт меню инвентаря включить и выключить музыку, а мы постараемся, чтобы это было плавно. На самом деле выключать музыку совсем мы не будем, а будем только понижать громкость до нуля, но зато нам не придется задаваться вопросом какой именно файл запускать при включении музыки.

В начале игры создадим элемент инвентаря “музыка” и присвоим ему наклейку “выключить музыку”:
'''inv+ музыка'''
'''idisp_музыка = "выключить музыку"'''
Запускаем любую музыку, в любом месте игры:
'''music music\Joe Hisaishi - Пылью на твоих руках.mp3'''
Теперь, в локации, которая отвечает за наш элемент инвентаря “музыка” используем оператор '''fademusic''':
''':Use_музыка'''
'''if idisp_музыка == "включить музыку" then idisp_музыка = "выключить музыку" & fademusic 255, 1500 else idisp_музыка = "включить музыку" & fademusic 0, 1500'''
'''end'''
Теперь по нажатию на “выключить музыку” громкость будет плавно затихать до нуля за 1,5 секунды, а по нажатию на “включить музыку” - так же плавно возрастать.

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