Cпавн через скрипт
Материал из Mod Wiki.
Скриптовый спавн
В скриптах есть одна единственная функция, отвечающая за спавн объектов:
alife():create(section,position,levelvertex,gamevertex)
Первый параметр - секция в конфигурациях, описывающая объект, например "bolt","med_kit" - это простые секции, простых объектов а есть объекты, которые переходят в онлайн/оффлайн, это неписи, монстры и так далее, например mil_killer_respawn_2 - спавнится снайпер группировки киллеров.
С позицией, думаю объяснять не надо, только существует нюанс - высота это Y, а не Z. Задать позицию можно такой конструкцией vector():set(x,y,z), где x, y и z - координаты точки на уровне, где спавним объект.
Дальше сложнее, так как сам толком сформулировать не могу.
Начнем от простого к сложному. На каждом уровне много объектов, все объекты состоят из полигонов, у каждого полигона есть вершины – вертексы.
Именно они и должны здесь указываться, зачем - не особо понимаю, скорее всего для точного позиционирования объекта. Например, можно получить вертекс ближайший к актору - db.actor:level_vertex()
Дальше идет гораздо более интересный параметр game_vertex, это почти то же самое, что и level_vertex, но (!) это глобальные величины! Если level_vertex считается для уровня, то game_vertex - для всей игры, и нужен он для того, чтобы указать на какой карте спавнить объект (более вразумительного объяснения я не нашел).
Соответственно, чтобы заспавнить что-нибудь на другой карте, достаточно указать game_vertex в четвертом параметре Например:
db.actor:game_vertex()
Итак, чтобы, например, заспавнить болт под ногами актора, пишем:
alife():create("bolt",db.actor():position(),1,db.actor:game_verte())
Почему 1, а не level_vertex? Проверено - разницы особой нет, какой level_vertex, хотя в некоторых случаях надо прописывать валидный вертекс, а то предмет может просто заспавнится не там, где планировалось... Но по большей части все проходит нормально и с единицей.
А вот game_vertex решает все - он указывает на каком уровне спавнить предмет, поэтому его надо указывать. Теоретически можно просто найти для каждого уровня по одному game_vertex'у и использовать их в скриптах.
Кроме того - есть еще один параметр - ID объекта, если указать ID NPC или актора - то предмет заспавнится у него в инвентаре.
Пример (спавним артефакт Медуза в инвентаре у актора):
alife():create("af_medusa", db.actor():position(), 1, db.actor:game_vertex(), db.actor:id())
Функция спавна возвращает серверный объект, то есть ни NPC, ни монстра ни что-либо еще.
Просто минимальный набор - координаты, ID, секция,а из него (серверного объекта) обычно нужен только ID, так как по ID можно получить этот самый серверный объект:
(alife():object(id))
Его можно использовать, чтобы поставить метку, например, но я его лично использую для других целей - спавн сложных объектов, конкретно – NPC.
Например надо решить следующую задачу - надо создать наемника, сменить ему группировку и изменить его инвентарь, ну и в нагрузку - сделать другом для игрока.
В определенный момент заспавненый объект переходит онлайн, в этот момент вызывается callback - net_spawn.
Что мы делаем? Сверяем ID онлайн объекта с сохраненным ID!
Если они совпадают, например так:
if obj:id()==saved_id then ...
Важно то, что у серверного объекта ID - это параметр, а у онлайнового объекта ID получается с помощью функции. Это важно, а то можно прогореть.
Итак, мы поймали нашего киллера по ID.
Далее все очень просто - вызываем команды для спавна гаусса и патронов к нему в инвентаре NPC (см. выше), меняем группировку специальной функцией, и делаем его другом.
Зачем такие сложности? Просто в оффлайне NPC как бы не существует, есть только косвенное упоминание о нем, и, плюс, все эти функции работают именно с объектом типа "NPC", а не с серверными объектами.
Скриптовый спавн на практике
1. Чтобы не повторяться в описании создания нового квеста, просто изучите статью «Создание квестов» от Fr3nzy – лучшей статьи на эту тему я просто не видел :) Мы просто свяжем все воедино и научимся спавнить объекты из скрипта.
Небольшое отступление: почему предпочтительнее делать спавн скриптом, а не через тот-же xSpawner? Программа xSpawner при всех своих достоинствах, обладает одним недостатком, а именно – она изменяет файл all.spawn и, установив очередной мод, затрагивающий данный файл, игру приходится начинать сначала, ИМХО, это ОЧЕНЬ НЕУДОБНО, не говорю уже о полной несовместимости таких модов. При спавне через скрипт ситуация иная, в подавляющем большинстве случаев, ранее сохраненные игры будут работать, что не может не радовать :)
Итак, определимся с квестом. Задача: после разговора с Сидоровичем спавним зомби на территории фабрики в первой локации. Для того, чтобы не повредить оригинальный сюжет игры, задание будет выдаваться ПОСЛЕ прохождения квеста с флешкой Шустрого, так как появись там зомби одновременно с бандитами и Шустрым…. я думаю, исход боя предрешен :)
Реализация: Постараюсь описать все действия максимально подробно, буквально по шагам. Первым делом запустите игру :) В консоли введите команду
rs_stats on или rs_stats 1
тем самым мы включаем вывод информации на экран. Далее вводим еще одну команду
demo_record 1
и «летим» на фабрику. Нам нужно выбрать место для спавна объектов и данный режим как нельзя лучше подходит для реализации задуманного. Помещаем камеру в точке предполагаемого спавна и записываем координаты - у меня получились 115, -6, -16.
Для выхода из режима demo_record нажимаем Esc, в консоли пишем rs_stats off или rs_stats 0 (убираем вывод информации).
Выходим из игры, идем в папку с установленной игрой и создаем каталог gamedata (предполагается, что «лепим» свой «мод» на «чистую» игру, без установленных модов, и имеем распакованные ресурсы игры в папке, скажем, gamedata_source). В папке gamedata создаем папку config, а в ней - папку creatures. Скопируем из оригинальной папки файл m_zombie.ltx и откроем его на редактирование.
Еще отступление: В файлах игры присутствуют 5 моделей гражданских зомби,
файлы zombi_1.ogf, zombi_1_ghost.ogf, zombi_2.ogf, zombi_trup.ogf, zombi_trup_2.ogf.
Вернем в игру их всех :)
Уже имеются секции
[zombie_weak]:m_zombie_e, [zombie_normal]:m_zombie_e, [zombie_strong]:m_zombie_e и [zombie_immortal]:zombie_strong.
Два последних типа используют одну и ту же модель zombi_trup.ogf, хм… непорядок, исправляем. Последняя секция выглядит теперь так:
[zombie_immortal]:zombie_strong $spawn = "monsters\zombies\zombie_immortal" visual = monsters\zombi\zombi_trup_2 panic_threshold = 0.05
Добавим пятую модель.
Для этого в конце файла создадим секцию:
[zombie_ghost]:zombie_strong
Это означает, что наш пятый зомби наследует все параметры zombie_strong, мы добавим лишь визуальное представление.
Пишем дальше:
$spawn = "monsters\zombies\zombie_ghost" visual = monsters\zombi\zombi_1_ghost
Все. Сохраняем изменения и закрываем файл.
2. Пишем скрипт спавна. В папке gamedata создаем новую папку scripts, в ней создаем новый текстовый документ и называем его esc_zombie.script.
Отступление третье: При написании статьи использовался оригинальный скрипт zombie_story.script из horror-mod’а. Концепция спавна перенесена практически без изменений, поэтому на авторство этого способа спавна я никоим образом не претендую :)
Итак, открываем наш пустой файл на редактирование, первой строкой объявляем переменную, в которой хранятся наши зомби
local zombie_types = {"zombie_weak", "zombie_normal", "zombie_strong", "zombie_immortal", "zombie_ghost"}
Далее пишем функцию
function spawn_zombies( position, total ) local zombie_index -- тип зомби из массива zombie_types local new_pos, x_offset, z_offset -- объявляем переменные for zombie_index=1, total do -- крутим цикл столько раз, сколько задает переменная total x_offset = math.random(5) -- случайное (рандомное) x от 1 до 5 z_offset = math.random(5) -- случайное (рандомное) z от 1 до 5 new_pos = position -- передаем координаты в функцию new_pos.x = new_pos.x + x_offset -- прибавляем к указанной нами координате x полученное выше рандомное x new_pos.z = new_pos.z + z_offset -- прибавляем к указанной нами координате z полученное выше рандомное z -- Ниже, собственно и вызывается функция спавна случайного типа зомби zombie_types[math.random(5)] привязанного к нашим координатам alife():create(zombie_types[math.random(5)],new_pos,db.actor:level_vertex_id(),db.actor:game_vertex_id()) end end
И последнее
function zomby_story_1( actor, npc ) -- 10 зомби на фабрике (Кордон) local spawn_point = vector():set( 115, -6, -16 ) -- здесь указываем координаты, выбранные нами для спавна, когда «летали» камерой :) spawn_zombies( spawn_point, 10 ) -- собственно вызов предыдущей функции с передачей ей координат и количества объектов end
Все. Сохраняем и закрываем файл.
Продолжаем разговор :) Для того, чтобы игра не вылетала после того, как мы добавили новый тип монстров, их нужно добавить в файл xr_statistic.script. Итак, скопируем этот файл из папки игры scripts в нашу папку к файлу esc_zombie.script и откроем на редактирование.
Добавим в local killCountProps к монстрам строчку:
zombie_weak = 1, zombie_normal = 2, zombie_strong = 3
В local sect_alias строчку:
zombie_weak = "zombie_weak", zombie_normal = "zombie_normal", zombie_strong = "zombie_strong"
А ниже в monster_classes строчку:
[clsid.zombie_s ] = "zombie"
В функцию getNpcType(npc) добавляем конструкцию:
elseif npc:character_community() == "zombie" then community = "zombie"
Сохраняем изменения и закрываем файл.
Все будет работать на ура, пока мы не попробуем обыскать убитого зомби. Как только мы это сделаем, игра вылетит с примерно такой ошибкой
Expression : fatal error Function : CInifile::r_string File : D:\xray-svn\xrCore\Xr_ini.cpp Line : 351 Description : <no expression> Arguments : Can't find variable icon in [zombie_weak]
Все верно – игра не знает какую иконку нам показывать для зомби. Иконки монстров хранятся в файле ui_npc_monster.dds. Здесь есть два варианта – а) если дружите с Фотошопом, отредактировать этот файл (нарисовать, добавить иконки); б) взять готовый из любого мода, естественно, с разрешения авторов мода. Сейчас мы пропустим данный аспект и присвоим нашим зомби иконки контролера :)
Вернемся к файлу m_zombie.ltx и в секцию [m_zombie_e]:monster_base впишем параметр
icon = ui_npc_monster_kontroler
Все. Вылетов не будет.
3. Тема данной статьи не предусматривает подробного описания того, как сделать новый диалог. В начале статьи я упомянул источник, где можно найти исчерпывающую информацию по созданию диалогов, могу также привести в пример статью «Создание диалогов» от BAC9-FLCL Нам нужно просто проверить работоспособность скриптового спавна, поэтому я приведу просто собственно сам измененный диалог из файла dialogs_escape.xml
<dialog id="escape_trader_talk_info">
………
<phrase id="999">
<text>escape_trader_talk_info_999</text>
<next>7770</next>
<next>9991</next>
<next>9992</next>
<next>9993</next>
<next>9994</next>
<next>9995</next>
<next>9996</next>
</phrase>
<phrase id="9992">
<text>escape_trader_talk_info_9992</text>
<next>99922</next>
</phrase>
<phrase id="99922">
<text>escape_trader_talk_info_99922</text>
<next>9996</next>
<next>9995</next>
</phrase>
<phrase id="9993">
<text>escape_trader_talk_info_9993</text>
<next>99933</next>
</phrase>
<phrase id="9995">
<text>escape_trader_talk_info_9995</text>
</phrase>
<phrase id="3121">
<text>escape_trader_talk_info_3121</text>
<next>9996</next>
<next>9995</next>
</phrase>
<phrase id="3131">
<text>escape_trader_talk_info_3131</text>
<next>9996</next>
<next>9995</next>
</phrase>
<phrase id="41">
<text>escape_trader_talk_info_41</text>
<next>9996</next>
<next>9995</next>
</phrase>
<!------Наш диалог Начало------->
<phrase id="7770">
<text>escape_trader_talk_info_7770</text>
<next>7771</next>
</phrase>
<phrase id="7771">
<text>escape_trader_talk_info_7771</text>
<next>7772</next>
<next>7773</next>
</phrase>
<phrase id="7772">
<text>escape_trader_talk_info_7772</text>
<next>7777</next>
</phrase>
<phrase id="7773">
<text>escape_trader_talk_info_7773</text>
<next>7779</next>
</phrase>
<phrase id="7779">
<text>escape_trader_talk_info_7779</text>
<next>9996</next>
<next>9995</next>
</phrase>
<phrase id="7777">
<text>escape_trader_talk_info_7777</text>
<action>esc_zombie.zombie_story_1</action>
<next>9996</next>
<next>9995</next>
</phrase>
<!------Наш диалог Конец------->
<phrase id="51">
<text>escape_trader_talk_info_51</text>
<next>9996</next>
<next>9995</next>
</phrase>
……
</dialog>
И также связанный с ним файл stable_dialogs_escape.xml
В самом начале файла пишем следующее
<string id="escape_trader_talk_info_7770"> <text>Происшествий никаких не было?</text> </string> <string id="escape_trader_talk_info_7771"> <text>Да знаешь... Вроде как тихо все у нас. Хотя, вот, вспомнил! Говорили мне на днях, что на фабрике, ну, там, где бандюки околачиваются постоянно, видели какиих-то то ли людей, то ли призраков... Мало ли что спьяну почудится - я и сказал этим паникерам, мол, закусывать надо! Хех, блин, алкаши...</text> </string> <string id="escape_trader_talk_info_7772"> <text>Дык мне по любому мимо фабрики топать - заодно и посмотрю на этих "людей-призраков".</text> </string> <string id="escape_trader_talk_info_7773"> <text>Да я как-то не собирался в ту сторону...</text> </string> <string id="escape_trader_talk_info_7779"> <text>Ну, смотри сам, все равно будь осторожен.</text> </string> <string id="escape_trader_talk_info_7777"> <text>Ага. Сходи, проветрись. Потом зайдешь, расскажешь, что там и как.</text> </string> <string id="esc_bridge_soldiers_start_11"> <text>Здесь проход воспрещён, сталкер.</text> </string>
Все. Можно запускать игру, идти на Кордон, после разговороа с Сидоровичем, в зависимости от выбранного Меченным решения, бежим на фабрику и … смотрим сами :)
Готовые файлы примера Spawn Lib
Домашнее задание - вернуть в игру 6-ой тип гражданского зомби :)
Продолжение следует…
Скриптовый спавн на практике (часть 2)
4. Сегодня мы закончим с зомби в полном объеме – добавим их описания в энциклопедию, добавим иконки, и разберемся с «домашним заданием»:) Думаю, что внимательно изучив эту статью, вы САМИ сможете через скриптовые функции восстановить любого персонажа, не вошедшего в финальный релиз игры. Если у кого хватит времени и желания, те могут даже написать что-то типа «Ночи живых мертвецов» :) - серию квестов, связанную своим собственным сюжетом. Итак, «домашнее задание» - добавляем в игру шестого зомби.
- Создаем в папке gamedata папку meshes, в ней папку monsters, а там – папку zombi. В папке meshes хранятся модели персонажей, объектов, окружения, присутствующих в игре. Как я уже говорил выше, в игре представлено 5 моделей гражданских зомби, а вот текстур – 6. Также немного смутила нумерация моделей – 1, 2, 4... А где третий? Наверное, сбежал :)
- Скопируем из папки с оригинальными файлами игры в созданную нами папку zombi файл zombi_2.ogf и переименуем его в zombi_3.ogf. Откроем файл нашей новой модели любым HexEditor’ом, я использую BiEd (Binary Editor 1.00). Так как данная статья рассчитана не только на «продвинутых юзеров», но и на «обычных чайников», которые, тем не менее, хотят «что-нить замутить» и при этом не сильно «парить моск», я не буду рассказывать здесь про адресацию, двухбайтовую запись и т.д., я просто наглядно покажу, где что поправить :)
Файл модели после редактирования
На скринах видно, что мы просто изменили для этой модели путь к текстуре. Все. БЕЗ использования 3D-редакторов и затраты кучи времени на обработку модели в них, мы получили абсолютно новую (на внешний вид) модель. :)
5. Теперь пропишем нашего нового зомби во все файлы, которые мы создали ранее. В файл m_zombie.ltx в самый конец добавляем секцию:
[zombie_old]:zombie_normal $spawn = "monsters\zombies\zombie_old" visual = monsters\zombi\zombi_3
в файле esc_zombie.script изменяем массив в первой строке:
local zombie_types = {"zombie_weak", "zombie_normal", "zombie_strong", "zombie_immortal",
"zombie_old", "zombie_ghost"}
В функции spawn_zombies изменяем строку спавна:
alife():create(zombie_types[math.random(6)],new_pos, db.actor:level_vertex_id(),db.actor:game_vertex_id())
в функции zombie_story_1 меняем число объектов на кратное 6-ти (необязательно):
spawn_zombies( spawn_point, 12 )
Всё. Сохраняем и закрываем.
6. Копируем в папку gamedata\config\gameplay\ файл encyclopedia_mutants.xml, добавляем описание зомби в энциклопедию:
<!-------------------------------- Zombieg ----------------------------->
<article id="mutant_zombieg_general" name="Zombieg" group="Mutants">
<texture>ui_npc_monster_zombieg</texture>
<text>enc_mutant_zombieg_general</text>
</article>
И в связанный с ним файл string_table_enc_mutants.xml в папке gamedata\config\text\rus\ добавляем:
<string id="Zombie"> <text>Зомби, гражданский</text> </string> <string id="Zombieg"> <text>Зомби-призрак, гражданский</text> </string> <string id="enc_mutant_zombieg_general"> <text>Зомби-привидение отличается от обычного зомби лишь тем, что воздействие Выжигателя мозгов полностью разрушило не только структуру личности, но и тело, поэтому зомби-призрак несколько более живуч по сравнению с обычным зомби.</text> </string> <string id="enc_mutant_zombie_general"> <text>Воздействие Выжигателя мозгов полностью разрушает структуру личности, оставляя только телесную оболочку.\n\n Побродив немного по Зоне, лишённые разума тела начинают превращаться в настоящих зомби. Из рефлексов у них остаются лишь самые примитивные, оружие и экипировка скоро приходят в негодность. В результате зомби становятся собой ни чем иным, как медлительными полутрупами, которых наличествуют лишь два эффективных раздражителя: еда и сон. Зомби совершенно неразборчивы в выборе пищи и питья, поэтому их тела буквально пропитаны радиацией и токсинами. Как правило, эти существа бесцельно бродят по Зоне или, словно трупы, валяются внутри заброшенных построек. Однако, лишь только зомби почует близкое присутствие живого человека, он сразу же пытается атаковать. Умудрённые опытом сталкеры стараются обходить эти неуклюжие опустошённые оболочки.</text> </string>
Копируем сюда же файл stable_statistic_caption.xml и изменяем в нем 3 строчки:
<string id="zombie_normal"> <text>зомбированный, гражданский</text> </string> <string id="zombie_strong"> <text>зомби-призрак, гражданский</text> </string> <string id="zombie_weak"> <text>зомби, гражданский</text> </string>
Сохраняем и закрываем.
7. И последнее – добавим иконки. Скажу сразу, воспользовался готовым файлом, уже содержащим иконки зомби и других «восстановленных монстров» (спасибо Fr3nzy). Поэтому просто скопируйте файл ui_npc_monster.dds из архива в папку gamedata\textures\ui\, а файл ui_npc_monster.xml – в папку gamedata\config\ui\. Если вы хотите сделать собственные - прочитайте урок по изменению текстур.
Вкратце, что описывает файл ui_npc_monster.xml: в нем задаются координаты иконок, расположенных в файле ui_npc_monster.dds, применительно к каждому типу монстров в игре.
Заключительный штрих. Откройте файл m_zombie.ltx и в первой секции замените строку
icon = ui_npc_monster_kontroler
На:
icon = ui_npc_monster_zombie
В секцию [zombie_ghost] добавьте строку:
icon = ui_npc_monster_zombieg
Сохраняйте изменения. Всё.
Вот готовые файлы примера. Удачи и спасибо за внимание :)
