герои 5 руководство по скриптам
Герои 5 руководство по скриптам
Heroes of Might & Magic V
Я не буду рассказывать, о:
1. Том, где искать редактор скриптов.
2. Не буду показывать все скрипты.
3. Не буду рассказывать о всех тригерах.
4. Не буду показывать, как делать регион.
Всё делать буду на своих примерах.
Приветствую, читатели.
В этой статье я расскажу о нескольких простых скриптах, а именно:
Сейчас рассмотрим MessageBox. Он выглядит, следующим образом:
Так как же его сделать?
Trigger(REGION_ENTER_AND_STOP_TRIGGER, «НазваниеВашегоРегиона», «message»);
В редакторе скриптов, он будет выглядить примерно вот так:
Чтобы сообщение показывалось, вам нужно положить txt файл, с вашим текстом внутри, в архив с картой (или создать файл в редакторе скриптов)
И теперь, всякий раз когда игрок вступает в указанный вами регион, будет работать скрипт.
Если вам нужно, чтобы скрипт работал только один раз, то в функции напишите:
Trigger(REGION_ENTER_AND_STOP_TRIGGER, «НазваниеВашегоРегиона», nil);
Сейчас я вам расскажу о том, как сделать так, что бы камера сама начала двигаться к указанному месту. Этот скрипт называется MoveCamera.
function movecamera()
MoveCamera(34, 56, 0);
end;
Trigger(REGION_ENTER_AND_STOP_TRIGGER, «НазваниеВашегоРегиона», «movecamera»);
Выглядеть в редакторе, он будет примерно так:
Узнать координаты x и y, можно в правом нижнем углу в редакторе:
Герои 5 руководство по скриптам
†G¤bli№†;102662
Я создал эту тему в надежде что найдёться человек и поможет мне с этим сложным языком и притом хочеться узнать возможности скриптов в РЕДАКТОРЕ КАРТ.
К примеру я хочу чтоб встав на указаное мною зарание место герой увидел сообщение. Как это зделать?
Я создал эту тему в надежде что найдёться человек и поможет мне с этим сложным языком и притом хочеться узнать возможности скриптов в РЕДАКТОРЕ КАРТ.
Night Nazgul;102669 ХЗ, но у мя вопрос: «А хде эти скрипты писать?»
__________________
✍ С уважением, Vlad
HeroesWorld: В контакте
HeroesWorld: В контакте
†G¤bli№†;103197 Я это читал, но блин я хочу чё нить нового. Типа потхожу к чёртику, а он говорит чё нить и теле партирует в указаную мной точку. (Если делаю карту).
__________________
✍ С уважением, Vlad
HeroesWorld: В контакте
HeroesWorld: В контакте
†G¤bli№†;103425 Может будем вместе находить их и записывать в один текстовый файл?
__________________
✍ С уважением, Vlad
HeroesWorld: В контакте
HeroesWorld: В контакте
__________________
✍ Играешь за Dungeon. Стань настоящим Тёмным эльфом, стань одним из нас. Dungeon’sRangers на HeroesWorld
Adun Toridas 
и это не конец. 
Играешь за Dungeon. Стань настоящим Тёмным эльфом, стань одним из нас. Dungeon’sRangers на HeroesWorld
Adun Toridas и это не конец.
Герои 5 руководство по скриптам
†G¤bli№†;102662
К примеру я хочу чтоб встав на указаное мною зарание место герой увидел сообщение. Как это зделать?
Night Nazgul;102669 ХЗ, но у мя вопрос: «А хде эти скрипты писать?»
__________________
✍ С уважением, Vlad
HeroesWorld: В контакте
HeroesWorld: В контакте
†G¤bli№†;103197 Я это читал, но блин я хочу чё нить нового. Типа потхожу к чёртику, а он говорит чё нить и теле партирует в указаную мной точку. (Если делаю карту).
__________________
✍ С уважением, Vlad
HeroesWorld: В контакте
HeroesWorld: В контакте
†G¤bli№†;103425 Может будем вместе находить их и записывать в один текстовый файл?
__________________
✍ С уважением, Vlad
HeroesWorld: В контакте
HeroesWorld: В контакте
__________________
✍ Играешь за Dungeon. Стань настоящим Тёмным эльфом, стань одним из нас. Dungeon’sRangers на HeroesWorld
Adun Toridas и это не конец.
Играешь за Dungeon. Стань настоящим Тёмным эльфом, стань одним из нас. Dungeon’sRangers на HeroesWorld
Adun Toridas и это не конец.
Герои 5 руководство по скриптам
Руководство по скриптам
(версия 1.0)
Автор: Novik65
Во первых строках письма спешу сообщить, что все ниже написанное является плодом вдумчивого изучения существующих скриптов, выполняемого файла, а так же результатами различных экспериментов над игрой версии 1.1. Т.е. может содержать (и, наверняка, содержит) ошибки. И всяко не претендует на полноту.
2. Немножко про LUA.
3. Реализация скрипт-системы в HoMMV.
Для начала несколько слов о нотации. В описании параметров и возвращаемых значений функций я буду использовать следующие э-э-э, обозначения:
если параметр начинается с буковки
— n – это число.
— s – строка
— sp – строка, представляющая собой путь к ресурсу игры.
— f – функция
— void – он и в Африке void, т.е. пусто.
— t – таблица. Т.к. игра по большей части использует регулярные таблицы (т.е. массивы) то возможны уточнения в виде
— ts – массив строк
— tn – массив чисел и т.п.
— v – переменная произвольного типа.
По ходу изложения я часто буду писать что-то вроде «соответствующие константы определены в таком-то lua файле». Следует понимать, что реальные значения констант содержатся в файле /types.xml, в lua они только дублируются, причем не всегда корректно. Просто в lua их смотреть проще. Исследований на предмет полного соответствия всего что можно я не проводил, но отдельные случаи непорядка таки есть.
Фактически, скрипт-систем в игре реализовано аж три. Для стратегического режима, для тактического режима и для интерфейса городов. Части эти пересекаются между собой крайне мало, как правило, скриптовые функции, которые могут использоваться в одной, в другой не доступны. Тем не менее, некоторая общая часть существует.
3.1. Функции, доступные везде.
number sqrt( number )
Возвращает корень квадратный из number.
number mod( number1, number2 )
Возвращает результат деления по модулю числа number1 на number2.
Возвращает рандомное число из интервала от 0 до nHi-1. Как следствие, nHi должен быть больше 0, иначе функция выдаст ошибку.
void sleep( nSegments )
Ожидать nSegments сегментов времени. 1 сегмент = 1/20 секунды. Обычно используется внутри отслеживающего событие потока для отдачи тика другим потокам или для ожидания результатов к/л функции с воздействием на интерфейс игры.
fProc parse( sToEval )
Возвращает функцию, которая занимается тем, что интерпретирует строку sToEval. Обращаю внимание – возвращается именно функция, а не ее результат. Пример: данный вызов выведет в консоль строку 123. Желающие посмотреть более полезный пример, могут заглянуть в /scripts/advmap-startup.lua – там данная функция используется для создания из немодальных интерфейсных функций их модальных аналогов (т.е. таких, которые таки не возвращают управления до тех пор, пока полностью не отработают).
Выводит свои аргументы в консоль.
Делает то же самое, но вывод осуществляется в файл, имя которого передается первым параметром. Если файл уже существует, то он будет дописываться. Если нет – файл будет создан. В случае если sFileName содержит только имя файла, то соотв. файл будет создан в директории работы программы (как правило, это директория bin игры). В случае если sFileName содержит путь на диске, соотв. обратные слеши в строке необходимо заменить на прямые. Таким образом, Вы можете соорудить славный мод, содержащий в своих дебрях что-либо вроде и подарить его другу. И с отдельными товарищами (правда, для описанного примера их будет маловато) эта забавная шутка даже сработает. В целом хочется поздравить коллектив разработчиков с включением в код такой вот крайне полезной функции.
sFileName create_file( sFileName )
Просто создает файл с именем sFileName. Если он уже был – обнуляет его.
sFileName open_file( sFileName )
Если файла с таким именем не было, создает его. В целом, для чего нужна – непонятно.
void _ERRORMESSAGE( sMsg )
Функция выдает в консоль сообщение об ошибке sMsg, эмулируя ошибку скрипта.
void errorHook( fCallback )
Позволяет установить перехватчик ошибки. По умолчанию при возникновении ошибки скрипта текущий поток завершает свою работу. Благодаря данной функции у Вас есть возможность откорректировать это поведение – перед остановом управление будет передано функции fCallback.
Пример: при возникновении ошибки в функции SetArtefactUntrans (например, требуемого артефакта у героя нет) в консоль будет выдана строка «Error occured «. Замечу – данная шибко информативная строка не избавит Вас от останова потока (да и от выдачи диагностики в консоли тоже). Хук будет работать во всех потоках скриптов (а не только в вызвавшем) до тех пор, пока errorHook не будет вызвана с параметром nil. Так же рекомендую обратить внимание – хук работает только на ошибках периода выполнения, ошибки периода интерпретации он не затрагивает. Что касается приведенного примера, то гораздо разумнее вместо использования хука проверять героя на предмет наличия должного артефакта.
Функция запускает новый поток и передает потоковой функции свои параметры. Пример (на стратегической карте): Приведенный фрагмент запускает поток, который периодически проверяет наличие у игрока артефакта. Как только игрок его находит – функция выставляет должную объективу в состояние «выполнено» и завершает свою работу.
void doFile( spFileLUA )
Загружает (и выполняет) файл скрипта, лежащий по указанному пути.
Возвращает уровень сложности игры. Это число от 0 до 3, соотв. константы DIFFICULTY_* прописаны в файле /scripts/common.lua.
void consoleCmd( sCmd )
Выполняет консольную команду sCmd. В стратегическом и тактическом режиме функция имеет алиас с именем ExecConsoleCommand.
void SetGameVar( sVarName, sValue )
string GetGameVar( sVarName, sDefaultVal = nil)
Функции осуществляют перенос информации между несколькими эпизодами одной кампании. SetGameVar устанавливает глобальную переменную, GetGameVar, соответственно, предоставляет способ добраться до ее значения. Если переменная не установлена, вернется sDefaultVal.
void Save( sSaveName )
void Load( sSaveName )
Сохранение, и, соответственно, загрузка игры. Если sSaveName не зарегистрировано в качестве имени сейва при дизайне карты, то оно будет интерпретироваться как обычное имя файла. Если зарегистрировано – то собственно имя файла и описание сейва (т.е. строка, которая показывается в меню) будет взято из соотв. xdb.
void TutorialSetBlink( sID, nOn )
void TutorialMessageBox( sID )
bool IsTutorialMessageBoxOpen()
Функции для работы с туториалом. На настоящий момент они не представляют для меня интереса, желающие могут поэкспериментировать самостоятельно. Разнообразные sID перечислены в файле /UI/uiconsts.(UIGameConstsH5).xdb в разделе /GameOptions/TutorialOptions/Hints/Item/ScriptID
3.2. Стратегический режим.
При старте стратегического режима игра делает следующее:
1) Загружает файл /scripts/advmap-startup.lua и все прописанные в нем с помощью doFile скрипты
2) Вызывает функцию createAdvmapAliases()
3) Приступает к интерпретации файла скрипта текущей карты.
Кроме перечисленных выше общих функций в данном режиме доступны следующие:
3.2.1 Общая работа с параметрами игрока.
nPlayerStateID GetPlayerState( nPlayerID )
Возвращает статус игрока nPlayerID. Бывает таким: number GetPlayerResource( nPlayerID, nResID )
Возвращает текущее количество ресурса nResID у игрока nPlayerID. ID ресурсов прописаны в /scripts/advmap-startup.lua и бывают такими: void SetPlayerResource( nPlayerID, nResID, nCount )
Установка текущего количества ресурса nResID в nCount для игрока nPlayerID. На основе данной функции в файле /scripts/advmap-startup.lua реализован примитив более высокого уровня – void SetPlayerStartResource( nPlayerID, nResID, nCount ) который распределяет игроку стартовые ресурсы в зависимости от уровня сложности.
tsHeroes GetPlayerHeroes( nPlayerID )
Возвращает таблицу, содержащую имена всех героев указанного игрока.
void SetPlayerHeroesCountNotForHire( nPlayerID, nCount )
Уменьшает количество героев, которых сможет нанять игрок, на nCount. Общее количество нанимаемых, полагаю, устанавливается при дизайне. Работу функции не проверял.
nPlayerID GetObjectOwner( sObjectName )
Возвращает ID игрока, которому принадлежит объект. В качестве объекта может выступать герой, город, строение, герой и т.п.
void SetObjectOwner( sObjectName, nPlayerID )
Устанавливает владельца объекта sObjectName в nPlayerID.
bool IsObjectVisible( nPlayerID, sObjectName )
Возвращает, виден ли игроку nPlayerID объект с именем sObjectName.
void OpenCircleFog( nX, nY, nFloorID, nRadius, nPlayerID )
Открывает для игрока nPlayerID туман войны в окружности с центром в указанных координатах и радиусом nRadius. Константы для nFloorID прописаны в /scripts/advmap-startup.lua и бывают такими: 3.2.2 Работа с объективами (или с обжективами – кому как).
nState GetObjectiveState( sObjectiveName, nPlayerID = PLAYER_1 )
Возвращает статус объективы sObjectiveName. Соотв. константы прописаны в /scripts/advmap-startup.lua и бывают такими: void SetObjectiveState( sObjectiveName, nState, nPlayerID = PLAYER_1 )
Устанавливает статус объективы с именем sObjectiveName. Следует понимать, что не у всех объектив статус можно установить вручную – можно или нельзя, определяется дизайном карты. Если таки нельзя, то вызов ни к чему, кроме выдачи ошибки в консоль, не приведет.
nProgress GetObjectiveProgress( sObjectiveName, nPlayerID = PLAYER_1 )
void SetObjectiveProgress( sObjectiveName, nProgress, nPlayerID = PLAYER_1 )
Возвращает и устанавливает степень прогресса в выполнении объективы sObjectiveName в случае, если дизайн это позволяет.
bool IsObjectiveVisible( sObjectiveName, nPlayerID = PLAYER_1 )
void SetObjectiveVisible( sObjectiveName, bVisible, nPlayerID = PLAYER_1 )
Функции возвращают и устанавливают видимость на интерфейсе объективы с именем sObjectiveName.
3.2.3 Работа с ключами.
bool HasBorderguardKey( nPlayerID, nKeyID )
void GiveBorderguardKey( nPlayerID, nKeyID )
Функции проверяют наличие и выдают игроку ключ должного цвета. Соотв. константы для nKeyID прописаны в /scripts/advmap-startup.lua и бывают такими: 3.2.4 Работа с регионами.
void SetRegionBlocked( sRegionName, bEnable, nPlayerID )
Блокирует/разблокирует регион sRegionName для игрока nPlayerID.
bool IsRegionBlocked( sRegionName, nPlayerID )
Возвращает, заблокирован ли регион sRegionName для игрока nPlayerID.
tsObjects GetObjectsInRegion( sRegionName, nObjectsTypeID )
Возвращает массив имен объектов в регионе с именем sRegionName. На настоящий момент второй параметр может быть только OBJECT_HERO = 0, а соотв. массив будет содержать только информацию о героях. На основе данной функции в файле /scripts/advmap-startup.lua реализован примитив более высокого уровня –
bool IsPlayerHeroesInRegion( nPlayerID, sRegionName )
nX, nY, nFloorID RegionToPoint( sRegionName )
Возвращает координаты региона в том случае, если регион является точечным. Если нет – ничего полезного не вернет, а ошибку таки вызовет.
bool IsObjectInRegion( sHeroName, sRegionName )
Проверяет, находится ли объект sHeroName внутри региона sRegionName. На настоящий момент функция работает только для объектов одного типа – для героев.
void OpenRegionFog( nPlayerID, sRegionName )
Открывает для игрока nPlayerID туман войны, скрывающий регион sRegionName.
Для не AI игрока перечисленные ниже функции смысла не имеют а их вызов приведет к ошибке скрипта (и остановке вызвавшего потока, как уже говорил).
void SetAIPlayerAttractor( sObjectName, nPlayerID, nPriority )
void SetAIHeroAttractor( sObjectName, sHeroName, nPriority )
Функция аналогичная SetAIPlayerAttractor, но работает только для одного героя с именем sHeroName.
void EnableHeroAI( sHeroName, bEnable )
Включает/выключает AI героя.
void MoveHero( sHeroName, nX, nY, nFloorID = GROUND )
Герой поскачет в точку с указанными координатами. В свой ход, и сообразно наличию movepoints.
void EnableAIHeroHiring( nPlayerID, sTownName, bEnable )
Разрешает или запрещает AI игроку nPlayerID найм героев в городе sTownName.
3.2.6 Работа с героями.
Герои – один из видов объектов. Ввиду большого количества функций, которые работают именно с ними, я рассмотрю их в отдельном разделе.
Если герой, имя которого передано в функцию, отсутствует, то вызов функции приводит к ошибке.
nCount GetHeroStats(HeroName, nStatID)
void ChangeHeroStat( sHeroName, nStatID, nCount )
Получение/установка того или иного стата героя. Соотв. константы для nStatID прописаны в /scripts/advmap-startup.lua и бывают такими: На основе данной функции в файле /scripts/advmap-startup.lua реализован примитив более высокого уровня – void GiveExp( sHeroName, nExp )
bool HasHeroSkill( sHeroName, nSkillID )
void GiveHeroSkill( sHeroName, nSkillID )
Получение/выдача того или иного скилла/перка/фита героя. Соотв. константы SKILL_*, PERK_* и *_FEAT_* для nSkillID см. в /scripts/advmap-startup.lua. Сюда писать не буду ввиду большого объема. Как можно увидеть, способа получить/выдать уровень мастерства в скилле данная функция не предоставляет.
void KnowHeroSpell( sHeroName, nSpellID )
void TeachHeroSpell( sHeroName, nSpellID )
Получение/выдача того или иного заклинания герою. Соотв. константы SPELL_* для nSpellID см. в /scripts/common.lua. Сюда писать не буду ввиду большого объема. Кстати, по крайней мере четыре заклинания в lua файл таки не попало – см. содержимое /types.xml.
void LevelUpHero( sHeroName )
Выдать герою с именем sHeroName один уровень. Точнее говоря – выдать количество exp points, которых герою не хватает до следующего уровня. Функция имеет алиас с именем GiveExpToLevel.
nLevel GetHeroLevel( sHeroName )
Получить уровень героя с именем sHeroName.
bool IsHeroAlive( sHeroName )
Возвращает, жив ли герой с именем sHeroName.
void DeployReserveHero( sHeroName, nX, nY, nFloorID = GROUND )
Разместить по указанным координатам героя из резерва. Герои резервируются при дизайне карты. В таверне, соответственно, их нанять нельзя.
void UnreserveHero( sHeroName )
Вывести указанного героя из резерва.
nCost CalcHeroMoveCost(sHeroName, nX, nY, nFloorID = GROUND)
void MoveHeroRealTime( sHeroName, nX, nY, nFloorID = GROUND )
Герой поскачет в точку с указанными координатами. Безотносительно того, чей ход и наличия/отсутствия у него movepoints. Данная функция не работает с героями, находящимися внутри города.
bool CanMoveHero( sHeroName, nX, nY, nFloorID = GROUND )
Возвращает, может ли герой в принципе доскакать до тайла с указанными координатами.
Данная функция не работает с героями, находящимися внутри города.
nCount GetHeroCreatures( sHeroName, nCreatureID )
void AddHeroCreatures( sHeroName, nCreateureID, nCount )
void RemoveHeroCreatures( sHeroName, nCreatureID, nCount )
Функции соответственно возвращают/добавляют/удаляют герою с именем sHeroName стек юнитов типа nCreatureID. Соотв. константы CREATURE_* для nCreatureID см. в /scripts/common.lua. Сюда писать не буду ввиду большого объема. Если стек должного типа отсутствует у героя, то вызов RemoveHeroCreatures к ошибке не приводит.
void GiveArtefact( sHeroName, nArtID, nDummy = 0 )
Выдает герою с именем sHeroName артефакт nArtID. Соотв. константы ARTIFACT_* для nArtID см. в /scripts/advmap-startup.lua. Сюда писать не буду ввиду большого объема.
Третий параметр, видимо, должен был управлять положением предмета – «экипировать/не экипировать», либо являться количеством выдаваемых предметов, однако его изменение никакого видимого эффекта не дает. Артефакт всегда экипируется и всегда выдается в единичном количестве. Чтобы выдать два одинаковых – нужно вызвать функцию с одинаковыми параметрами дважды.
Если после выдачи артефакта подразумевается к/л немедленное продолжение работы с этим предметом (типа удаления, или проверки наличия) рекомендую писать sleep(1) сразу после GiveArtefact. Т.к. иначе предмет может не успеть выдаться. Собственно, это замечание относится ко всем функциям, в которых герою (или объекту) что-либо выдается. Отсюда мораль – ставьте sleep, он лишним не будет. Функция имеет алиас с именем GiveArtifact.
bool HasArtefact(sHeroName, nArtID)
Функция возвращает, есть ли у героя с именем sHeroName хотя бы один артефакт nArtID.
void RemoveArtefact( sHeroName, nArtID )
Функция удаляет у героя с именем sHeroName один артефакт nArtID. Если он у него есть. Если нет – вызов функции приводит к ошибке.
void SetHeroLootable( sHeroName, bEnable )
bool IsHeroLootable( sHeroName )
Функции устанавливают/возвращают «лутабельность» героя с именем sHeroName. Не до конца разобрался, что под этим понимается, скорее всего – будет ли выпадать из героя лут при его поражении в бою.
void MarkObjectAsVisited( sObjectName, sHeroName )
Выставляет у объекта sObjectName «признак посещенности» героем с именем sHeroName на текущий день. Если объект имеет статус enabled (см. ниже IsObjectEnabled и SetObjectEnabled), вызов данной функции приводит к ошибке.
sTownName GetHeroTown( sHeroName )
Если герой с именем sHeroName находится в городе (имеется ввиду – именно внутри, а не на карте около входа), то данная функция возвращает имя города. В противном случае функция вернет nil.
sHeroName GetTownHero( sTownName )
Аналогично GetHeroTown, но в этом случае имя героя ищется по имени города.
tsObjects GetObjectsFromPath( sHeroName, nX, nY, nFloorID = GROUND )
Функция возвращает массив объектов, мимо которых герой с именем sHeroName проскачет при путешествии из Петербурга в Москву. т.е. из текущего своего положения в точку с указанными координатами.
void GiveHeroWarMachine( sHeroName, nWarMachineID )
void HasHeroWarMachine( sHeroName, nWarMachineID )
void RemoveHeroWarMachine( sHeroName, nWarMachineID )
Функции выдают/проверяют наличие/удаляют машину nWarMachineID у героя с именем sHeroName. Соотв. константы для nWarMachineID прописаны в /scripts/common.lua и бывают такими: Попытка удалить несуществующую машину к ошибке не приводит. Удалить катапульту в любом случае не удастся (но ошибкой не является).
Одна из трех возможностей инициировать переход на тактическую карту непосредственно из скрипта стратегического режима. О параметрах подробнее:
sHeroName – атакующий герой.
sEnemyHeroName – защищающийся герой. Может быть nil в случае атаки на нейтралов без героя.
nEnemyIDCount – количество стеков в армии защищающегося. Должно быть больше нуля.
Далее перечисляются nEnemyIDCount пар вида
nCreatureID – тип существа и nCount – количество существ в стеке.
spScriptXDB – путь к XDB файлу тактического скрипта, либо nil, если дело происходит «на автомате».
sFinishProc – имя функции, которой будет передано управлении после окончания боя (с уведомлением о результате). Обращаю внимание, что это именно строка, а не параметр типа функция. Данный callback имеет следующий прототип:
void combatDone( sHeroName, bWin )
где sHeroName – имя атакующего героя, а bWin – статус сражения относительно атакующего (nil – поражение, иначе – победа).
spAdventureFlybySceneXDB – путь к xdb, определяющему арену, на которой будет происходить сражение. Если nil, то будет взята арена, тип которой соответствует типу местности, на которой находится атакующий герой на стратегической карте.
void SetHeroCombatScript( sHeroName, spScriptXDB )
Функция выставляет герою с именем sHeroName скрипт, который будет работать в последующих тактических боях. Если происходит эпическая битва между двумя героями, оба из которых имеют установленный скрипт, то работает скрипт атакующего.
void ResetHeroCombatScript( sHeroName )
Функция сбрасывает навешенный ранее на героя скрипт. Если ничего навешено не было, то ошибки не происходит.
void SiegeTown( sHeroName, spAdvMapTownXDB, spAdventureFlybySceneXDB = nil )
Собственно, стартует осада города, путь к xdb с описанием которого задан во втором параметре, на арене, заданной третьим параметром. Если последний параметр nil, то берется арена по умолчанию.
3.2.6 Работа с городами.
Если город, имя которого передано в функцию, отсутствует на карте, то вызов функции приводит к ошибке.
nLevel GetTownBuildingLevel( sTownName, nBuildingID )
nLevel GetTownBuildingLimitLevel( sTownName, nBuildingID )
nLevel GetTownBuildingMaxLevel( sTownName, nBuildingID )
Функции позволяют узнать уровень/лимит на развитие/максимальный уровень здания nBuildingID в городе с именем sTownName. Соотв. константы TOWN_BUILDING_* для nBuildingID см. в /scripts/advmap-startup.lua. Сюда писать не буду ввиду большого объема.
void SetTownBuildingLimitLevel( sTownName, nBuildingID, nLevel )
Функция позволяет выставить лимит на уровень развития здания nBuildingID в городе с именем sTownName. При попытке выставить уровень больше максимально возможного вызов функции приводит к ошибке.
void TransformTown( sTownName, nTownTypeID )
Трансформирует город с именем sTownName. Соотв. константы для nTownTypeID прописаны в /scripts/advmap-startup.lua и бывают такими: Если в момент трансформации в городе находится герой, он погибнет.
void RazeTown( sTownName )
Разрушает город с именем sTownName. Только в том случае, если при дизайне карты город помечен как «разрушаемый». Иначе вызов данной функции приводит к ошибке.
3.2.7 Работа с объектами.
Под объектом понимается фактически все, что угодно – это здания, города, стеки монстров, герои и т.п. Правда, некоторые функции работают только с определенными видами объектов (например, про работу с героями рассказано выше). Если объект, имя которого передано в функцию, отсутствует, то вызов функции приводит к ошибке.
nX, nY, nFloorID GetObjectPosition( sObjectName )
Функция возвращает позицию объекта. Функция имеет алиас с именем GetObjectPos. На основе данной функции в файле /scripts/advmap-startup.lua реализован примитив более высокого уровня – bool IsInDungeon( sObjectName ).
void SetObjectPosition( sObjectName, nX, nY, nFloorID = GROUND )
Функция устанавливает позицию объекта. Объект должен быть перемещаемым, что, насколько я понимаю, определяется при дизайне этого самого объекта. Например, города перемещать нельзя. Функция имеет алиас с именем SetObjectPos.
void RemoveObject( sObjectName )
Удаляет объект с карты. Объект должен быть перемещаемым и присутствовать на карте. Т.е., например, город удалить нельзя.
bool IsObjectExists( sObjectName )
Возвращает, существует ли на карте объект с данным именем. Функция имеет алиас с именем Exists.
bool IsObjectEnabled( sObjectName )
Возвращает, находится ли объект с именем sObjectName в состоянии enabled.
void SetObjectEnabled( sObjectName, bEnable )
Выставляет или снимает с объекта sObjectName состояние enabled.
tsObjects GetObjectNamesByType( sObjectTypeSubstr )
Выдает массив имен объектов на карте в соответствии с подстройкой sObjectNameSubstr, которая встречается в наименовании его типа. Полностью список соответствующих строк BUILDING_*, TOWN_*, CREATURE_* и HERO_CLASS_* можно найти в файле /types.xml, ветка /Base/Tables. Обращаю внимание, что 1) параметр – именно строка и к константам в /scripts/common.lua имеет весьма опосредованное отношение 2) полного совпадения имени не требуется, достаточно совпадения куска. Например, вызовы
GetObjectNamesByType(“SAWMILL”) и GetObjectNamesByType(“BUILDING_SAWMILL”) вернут один и тот же массив.
3) Тем не менее, излишне доверять сокращениям не следует. Например, по запросу GetObjectNamesByType(“CREATURE_”) не будет выдано ничего.
void AddObjectCreatures( sObjectName, nGreatureID, nCount )
nCount GetObjectCreatures( sObjectName, nCreatureID )
void RemoveObjectCreatures( sObjectName, nCreatureID, nCount )
Позволяет добавить/получить/удалить стеки существ, охраняющих объект.
void SetObjectDwellingCreatures( sObjectName, nCreatureID, nCount )
nCount GetObjectDwellingCreatures( sTownName, nCreatureID )
Позволяет установить/получить стеки существ, которые будут э-э-э, произрастать в объекте, если последний является точкой найма (например, городом). Уточню – изменить тип нанимаемых существ нельзя, можно управлять только их количеством. Например, при попытке вызвать SetObjectDwellingCreatures для города инферно с параметром nCreatureID=1 (крестьяне) никаких крестьян в городе не образуется. (Впрочем, к ошибке данный вызов не приводит) Т.е. данный тип стека должно в принципе быть возможным нанять в указанном месте.
void CreateArtifact( sArtName, nArtID, nX, nY, nFloorID )
Создает артефакт nArtID в точке с указанными координатами и присваивает ему имя sArtName.
void ShowFlyingSign( spTXT, sObjectName, nPlayerID, nTimeSec)
void CreateMonster( sMonsterName, nCreatureID, nCount, nX, nY, nFloorID, nMonsterMoodID, nCreatureCourageID )
Создает стек существ из nCount существ типа nCreatureID в указанных координатах и присваивает ему имя sMonsterName. Созданный стек имеет mood и courage (ага, трудности у меня с внятным переводом – настроение и кураж? Как-то не звучит. ) в соответствии с константами Данные константы нигде не определены. Стек будет принадлежать нейтральному игроку c > Функция имеет алиас с именем CreateMob.
void RemoveAllMonsters( nCreatureID )
Удаляет с карты все стеки с типом существ nCreatureID. Функция имеет алиас с именем KillMobs
void GenerateMonsters( nCreatureID, nCountGroupsMin, nCountGroupsMax,
nCountInGroupMin, nCountInGroupMax )
Генерирует в рандомных местах карты от nCountGroupsMin до nCountGroupsMax стеков существ типа nCreatureID от nCountInGroupMin до nCountInGroupMax существ в каждом стеке. Созданные стеки принадлежат нейтральному игроку c Функция имеет алиас с именем GenerateMobs.
3.2.8 Работа с интерфейсом.
void QuestionBox( spTXT, sCallback )
Выдает модальный QuestionBox с текстом spTXT и кнопками «Да/Нет», по завершении в случае положительного ответа вызывает функцию с именем sCallback и пустым списком параметров.
void StartDialogScene( spDialogSceneXDB, sCallback = nil, sSaveName = nil )
Стартует диалоговую сцену на движке согласно первому параметру. Если второй параметр не nil, то после диалога будет вызвана функция с именем sCallback и пустым списком параметров. Если sSaveName не nil, то перед диалогом будет произведено сохранение в соотв. слот. Что мешает просто вызывать перед StartDialogScene функцию Save там, когда это нужно, пока не понимаю. Возможно, дело в состоянии экрана на момент сохранения (и, соответственно, в картинке, которая ляжет в сейв).
void StartCutScene( sAnimSceneXDB, sCallback = nil, saveName = nil )
Стартует анимированную сцену на движке согласно первому параметру. Если второй параметр не nil, то после ролика будет вызвана функция с именем sCallback и пустым списком параметров. Если sSaveName не nil, то перед диалогом будет произведено сохранение в соотв. слот.
void MessageBox( spTXT, sCallback = nil, sSaveName = nil )
Выдает модальный MessageBox с текстом spTXT, по завершении вызывает функцию с именем sCallback и пустым списком параметров. Если sSaveName не nil, то перед диалогом будет произведено сохранение в соотв. слот.
void StartDialogSceneInt( spDialogSceneXDB, sCallback = nil, sSaveName = nil )
void StartCutSceneInt( spAnimSceneXDB, sCallback = nil, sSaveName = nil )
void MessageBoxInt( spTXT, sCallback = nil, sSaveName = nil )
Немодальные аналоги перечисленных выше функций. означает, что во время работы интерфейсного элемента поток скрипта, вызвавшего функцию, продолжает работу. Собственно, их модальные реализованы скриптом в /scripts/advmap-startup.lua с помощью использования механизма event-ов и функции parse.
void MoveCamera( nX, nY, nFloorID, n1, nAngle, n2 )
void TutorialActivateHint( sHintID )
bool IsTutorialItemEnabled( sItemID )
Функции для работы с туториалом. На настоящий момент они не представляют для меня интереса, желающие могут поэкспериментировать самостоятельно. Разнообразные sHintID и sItemID перечислены в файле /UI/uiconsts.(UIGameConstsH5).xdb в разделе
/GameOptions/TutorialOptions/Hints/Item/ScriptID
3.2.9 Функции общей направленности.
Вызов приводит к автоматическому проигрышу миссии. На мультиплеерных картах функция, видимо, неприменима.
Вызов приводит к автоматической победе в миссии. На мультиплеерных картах функция, видимо, неприменима.
Блокирует интерфейс пользователя. Дабы игрок не дергал попусту мышь и клавиатуру и не сбивал режиссуру ролика с передвижением героев, камеры и т.п.
Немедленный выход из игры. Без всяких промежуточных вопросов.
number GetDate( nDateID )
Возвращает текущую дату в формате согласно переданному параметру. Соотв. константы для nDateID прописаны в /scripts/advmap-startup.lua и бывают такими: nX, nY GetTerrainSize()
Возвращает размер текущей карты в тайлах.
bool IsTilePassable( nX, nY, nFloorID = GROUND )
Возвращает, проходим ли тайл с указанными координатами.
string GetAllNames( nFilterCode )
NEW_DAY_TRIGGER = 0
Формат вызова:
Trigger(NEW_DAY_TRIGGER, sProc)
Формат вызываемой процедуры:
void sProc()
Останов:
Trigger(NEW_DAY_TRIGGER, nil)
Процедура будет вызываться по наступлении каждого нового дня.
PLAYER_ADD_HERO_TRIGGER = 1
Формат вызова:
Trigger(PLAYER_ADD_HERO_TRIGGER, nPlayerID, sProc )
Формат вызываемой процедуры:
void sProc( sHeroName )
Останов:
Trigger(PLAYER_ADD_HERO_TRIGGER, nPlayerID, nil)
Процедура вызывается, когда игрок nPlayerID получает нового героя. Имя данного героя передается в процедуру в качестве параметра.
PLAYER_REMOVE_HERO_TRIGGER = 2
Формат вызова:
Trigger(PLAYER_REMOVE_HERO_TRIGGER, nPlayerID, sProc )
Формат вызываемой процедуры:
void sProc( sHeroName )
Останов:
Trigger(PLAYER_REMOVE_HERO_TRIGGER, nPlayerID, nil)
Процедура вызывается, когда игрок nPlayerID теряет героя. Имя данного героя передается в процедуру в качестве параметра.
OBJECTIVE_STATE_CHANGE_TRIGGER = 3
Формат вызова:
Trigger(OBJECTIVE_STATE_CHANGE_TRIGGER, sObjectiveID, sProc )
Формат вызываемой процедуры:
void sProc( nPlayerID )
Останов:
Trigger(OBJECTIVE_STATE_CHANGE_TRIGGER, sObjectiveID, nil )
Процедура вызывается, когда состояние объективы sObjectiveID для какого-либо игрока меняется. Идентификатор игрока передается в процедуру в качестве параметра.
OBJECT_TOUCH_TRIGGER = 4
Формат вызова:
Trigger(OBJECT_TOUCH_TRIGGER, sObjectID, sProc )
Формат вызываемой процедуры:
void sProc( sHeroName )
Останов:
Trigger(OBJECT_TOUCH_TRIGGER, sObjectID, nil )
Процедура вызывается, когда игрок тыркнулся героем в объект с именем sObjectID. Имя данного героя передается в процедуру в качестве параметра.
OBJECT_CAPTURE_TRIGGER = 5
Формат вызова:
Trigger(OBJECT_CAPTURE_TRIGGER, sObjectID, sProc )
Формат вызываемой процедуры:
void sProc( sHeroName )
Останов:
Trigger(OBJECT_CAPTURE_TRIGGER, sObjectID, nil )
Процедура вызывается, когда объект с именем sObjectID меняет владельца. Имя завладевшего объектом героя передается в процедуру в качестве параметра.
REGION_ENTER_AND_STOP_TRIGGER = 6
Формат вызова:
Trigger(REGION_ENTER_AND_STOP_TRIGGER, sRegionName, sProc )
Формат вызываемой процедуры:
void sProc( sHeroName )
Останов:
Trigger(REGION_ENTER_AND_STOP_TRIGGER, sRegionName, nil )
Процедура вызывается, когда какой-либо герой останавливается в регионе с именем sRegionName. Имя данного героя передается в процедуру в качестве параметра.
REGION_ENTER_WITHOUT_STOP_TRIGGER = 7
Формат вызова:
Trigger(REGION_ENTER_WITHOUT_STOP_TRIGGER, sRegionName, sProc )
Формат вызываемой процедуры:
void sProc( sHeroName )
Останов:
Trigger(REGION_ENTER_WITHOUT_STOP_TRIGGER, sRegionName, nil )
Процедура вызывается, когда какой-либо герой попадает в регион с именем sRegionName. Имя данного героя передается в процедуру в качестве параметра.
HERO_LEVELUP_TRIGGER = 8
Формат вызова:
Trigger(REGION_ENTER_WITHOUT_STOP_TRIGGER, sHeroName, sProc )
Формат вызываемой процедуры:
void sProc()
Останов:
Trigger(REGION_ENTER_WITHOUT_STOP_TRIGGER, sHeroName, nil )
Процедура вызывается, когда герой с именем sHeroName повышает уровень.
WAR_FOG_ENTER_TRIGGER = 9
TOWN_HERO_DEPLOY_TRIGGER = 10
Собственно, для данных типов триггеров отсутствуют примеры, и соответственно, данные. Эксперименты я ставить поленился.
3.2.10 Работа со звуком.
nSoundID Play3DSound( spSoundXDB, nX, nY, nFloorID )
nSoundID Play2DSound( spSoundXDB )
void StopPlaySound( nSoundID )
Останавливает проигрывание циклического звука.
3.2.11 Работа с освещением.
void SetCombatAmbientLight( spAmbientLightXDB )
Меняет освещение тактической арены. Функция имеет алиас с именем SetCombatLight.
void SetObjectFlashlight( sObjectName, sLightID )
Теоретически функция должна устанавливать подсветку объекта, практически же попытка подсунуть ей вторым параметром что-либо отличное от пустой строки, приводит к ошибке. Вероятно, в sLight должна идти ссылка на что-то, определяемое при дизайне карты.
void SetAmbientLight( nFloorID, sLightID, b1, n1)
Аналогично SetObjectFlashlight. Причем назначение двух последних параметров мне неизвестно. Функция имеет алиас с именем SetLight.
3.2.12 Всякие непонятки.
void SetWarfogBehaviour( n1, n2 )
Очевидно, имеет какое-то отношение к туману войны. Смысл параметров мне не понятен.
tnTier GetGuardsTier( sObjectName )
Возвращает массив целых чисел.
void SetStandState( sStandName, nState )
number GetStandState( sStandName )
number GetStandStatesCount( sStandName )
3.3. Тактический режим.
При старте тактического режима игра делает следующее:
1. Загружает файл /scripts/combat-startup.lua и все прописанные в нем с помощью doFile скрипты
2. Вызывает функции createCombatAliases() и createTutorialAliases()
3. Приступает к интерпретации файла тактического скрипта. Упомянутый тактический скрипт может появиться в результате
• Использования примитивов StartCombat или SetHeroCombatScript
• Дизайна файла карты (AdvMapDesc)
• Дизайна файла определения героя (AdvMapHero)
4. Так или иначе, если файл скрипта в наличии, то интерпретатор последовательно выполняет из него строки, не являющиеся телами функций, после чего приступает к последовательному вызову хуков в зависимости от ситуации. Всего в наличии четыре хука.
3.3.1 Общее положение дел.
Итак, имеется две армии. Собственно различие между ними скрипт проводит по признаку атакующий/обороняющийся. Атакующая сторона всегда содержит в своем составе героя. Обороняющаяся может героя не иметь. Имена героев и стеков не имеют никакого отношения к именам использующимся на стратегической карте. Существует единственный примитив, позволяющий соотносить имена героев между стратегическим и тактическим режимом – GetHeroName.
Вызывается на этапе расстановки стеков игроком. На данном этапе состав армии игрока не определен, соотв. функции будут показывать, что в наличии есть только собственно герой. Возвращаемое значение роли не играет. В файле /scripts/combat-startup.lua данный хук заменен на void Prepere(), пользуйтесь либо одним либо другим по собственному разумению.
Вызвается на старте сражения непосредственно после расстановки войск обеими сторонами. Возвращаемое значение роли не играет. В файле /scripts/combat-startup.lua данный хук заменен на void Start(), пользуйтесь либо одним либо другим по собственному разумению.
Вызывается перед каждым ходом стека AI игрока. Имя стека передается в качестве параметра. Если функция возвращает true, то AI не предпринимает над стеком к/л осмысленных действий, считая, что Вы позаботились об этом в теле хука.
Юниту отдается команда «защищаться», что, вообщем, не совсем то, чего бы лично я ожидал в этом случае. Логичней было бы вообще ничего не делать с юнитом. Кстати, по поводу «true». В файле /scripts/combat-startup.lua в отличие от файла /scripts/advmap-startup.lua отсутствует определение константы true, поэтому ее нужно либо доопределить самостоятельно, либо пользовать вместо нее not nil.
В файле /scripts/combat-startup.lua данный хук заменен на целый набор функций: Опять таки, пользуйтесь тем, чем Вам удобнее.
Вызывается при смерти стека существ. Имя стека передается в качестве параметра.
В файле /scripts/combat-startup.lua данный хук заменен на целый набор функций: Пользуйтесь тем, чем Вам удобнее.
3.3.3 Общие функции контроля боя.
void EnableDynamicBattleMode( bEnable )
Если вызвано с параметром true, то грядущая битва будет происходит в динамическом режиме, т.е. с ограничением на время хода. Внимание! Отключить динамический режим по ходу боя будет нельзя.
void EnableAutoFinish( bEnable )
Понятия не имею, для чего это нужно.
void EnableCinematicCamera( bEnable )
Разрешает или запрещает «кинематографическое» метание камеры с показом действий юнитов.
void SetControlMode( nSideID, nModeID )
Устанавливает режим боя для стороны nSideID. Попытка вызвать данную функцию для AI игрока приводит к ошибке. Соотв. константы для nModeID прописаны в /scripts/ combat-startup.lua и могут быть В частности, вызвав данную функцию из DoPrepare c параметром MODE_AUTO и, последовательно, с MODE_MANUAL из DoStart можно обеспечить автоматическую расстановку юнитов вне желания игрока.
Соотв. константы для nSideID прописаны в /scripts/ combat-startup.lua и могут быть void combatEnableFinish( bEnable )
Понятия не имею, для чего это нужно.
void Finish( nSideID )
Автоматически завершает бой победой стороны, идентификатор которой передан в качестве параметра.
Немедленно прерывает бой. Потери, понесенные сторонами в ходе боя, в случае выхода на стратегическую карту учитываться не будут.
void combatSetPause( n1, b1 )
Устанавливает и убирает паузу в бое (при паузе курсор превращается в часы и интерфейс заблокирован). Смысл параметров мне не до конца ясен.
void showHighlighting( bShow = true )
Убирает или устанавливает подсвечивание поля боя. Функция имеет алиас с именем ShowCombatHighlighting.
3.3.3 Управление юнитами.
void SummonCreature( nSideID, nCreatureID, nCount, nX, nY )
void AddCreature( nSideID, nCreatureID, nCount, nX, nY )
Практически идентичные функции. Добавляют стороне nSideID стек из nCount существ, и размещает его по указанным координатам. Различие состоит в том, что SummonCreature создает стек только на время боя, и подсвечивает его появление эффектом. В случае, если клетка по указанным координатам недоступна (например, занята препятствием или другим стеком) новый стек будет помещен на ближайшую свободную клетку. Созданный стек будет помещен в конец таблицы, которая возвращается функцией GetUnits. Если планируется что-либо предпринимать со стеками непосредственно после добавления, то необходимо добавить вызов sleep(1) непосредственно сразу после использования функций. Иначе последствия непредсказуемы – от невыполнения следующей операции без к/л диагностики до вылета игры в операционную систему.
void addUnit(nCreatureID, nSideID, nX, nY, nCount, sUnitName)
Странная функция, которая, по идее, занимается тем же, что и две предыдущие. С некоторыми отличиями. Параметр sUnitName используется только в одном месте – если уже есть стек с таким именем, то вызов функции приведет к ошибке. В противном случае имя стеку присвоится автоматически, sUnitName никак не задействуется. В случае, если клетка по указанным координатам недоступна, вызов функции приведет к ошибке.
Вывод: использование данной функции проблематично, для чего она нужна – непонятно.
Функция имеет алиас с именем AddCombatUnit.
void removeUnit( sUnitName )
Функция удаляет с поля боя стек с именем sUnitName. Удалять можно только стеки.Героев, машины и здания – нельзя. Функция имеет алиас с именем RemoveCombatUnit.
void UnitCastAimedSpell( sUnitName, nSpellID, sTarget)
Функция заставляет юнит с именем sUnitName откастовать заклинание nSpellID на юнит sTarget. Тип юнита и наличие у юнита заклинания роли не играет, играет роль только запас манны у него. Нехватка манны приводит к ошибке скрипта. Следует быть осторожным с выбором nSpellID – попытка скастовать подобным образом «площадное» заклинание, например, файрболл, может привести к подвису игры. Попытка скастовать «вредоносное» заклинание на союзников и «полезное» на врага к ошибке не приводит, но и эффекта так же не дает.
void UnitCastGlobalSpell( sUnitName, nSpellID )
Функция заставляет юнит с именем sUnitName откастовать заклинание «общего действия» (т.е. не требующее прицела) nSpellID. Тип юнита и наличие у юнита заклинания роли не играет, играет роль только запас манны у него. Нехватка манны приводит к ошибке скрипта.
void UnitCastAreaSpell( sUnitName, nSpellID, nX, nY )
Функция заставляет юнит с именем sUnitName откастовать заклинание «площадного действия» nSpellID на тайл с требуемыми координатами. Тип юнита и наличие у юнита заклинания роли не играет, играет роль только запас манны у него. Нехватка манны приводит к ошибке скрипта. Опять таки не следует забывать про sleep – например, если Вы вздумаете удалить стек непосредственно после того, как он что-то откастовал, то собственно кастовки Вы не увидите. И sleep(1) тут не отделаешься – необходимо дождаться результатов кастовки, для файрбола это sleep(8 ), для других заклинаний может и отличаться. Собственно, замечание со sleep относится ко всем манипуляциям с юнитами.
void SetUnitManaPoints( sUnitName, nPoints )
number GetUnitMaxManaPoints( sUnitName )
Функция возвращает максимальный запас маны юнита sUnitName.
number GetUnitManaPoints( sUnitName )
Функция возвращает текущий запас маны юнита sUnitName.
void commandDefend( sUnitName )
Функция заставляет юнит с именем sUnitName выполнить команду «защищаться».
Функция имеет алиас с именем DefendCombatUnit.
void commandDoSpell( sUnitName, nSpellID, nX, nY )
void commandShot( sUnitName, sVictimName, bDontShowScene = false )
void commandMove( sUnitName, nX, nY, bCheckPath = false )
Функция заставляет юнит с именем sUnitName переместиться на клетку с указанными координатами. Если третий параметр true, то будет учитываться длина хода юнита. При нехватке хода юнит с места не сдвинется, а вызов функции приведет к ошибке. Если клетка недостижима (т.е. занята другим юнитом или на пути к ней есть непреодолимые препятсятвия), то в любом случае никто никуда не пойдет, а вызов функции приведет к ошибке. Функция имеет алиас с именем MoveCombatUnit.
Функция заставляет юнит с именем sUnitName атаковать юнит sVictim в melee режиме. Если указаны положительные координаты, то юнит сначала дойдет до требуемой клетки, а потом произведет атаку с нее (да-да, несмотря на то, что melee, и между юнитами пол-поля – ударит, да еще и сдачи получит). В противном случае юнит подбежит к атакуемому вплотную. Если третий параметр true, то будет учитываться длина хода юнита. При нехватке хода юнит с места не сдвинется, а вызов функции приведет к ошибке. Если клетка недостижима (т.е. занята другим юнитом или на пути к ней есть непреодолимые препятсятвия), то в любом случае никто никуда не пойдет, а вызов функции приведет к ошибке. Функция имеет алиас с именем AttackCombatUnit.
Функция заставляет юнит с именем sUnitName использовать спецспособность по клетке с указанными координатами (если они заданы – некоторые спецспособности не требуют координат). Если третий параметр true, то будет учитываться длина хода юнита. При нехватке хода юнит с места не сдвинется, а вызов функции приведет к ошибке. Если клетка недостижима (т.е. занята другим юнитом или на пути к ней есть непреодолимые препятсятвия), то в любом случае никто никуда не пойдет, а вызов функции приведет к ошибке. Константы ABILITY_* nAbilityID прописаны в /scripts/combat-startup.lua, приводить полный список не буду. На этот раз не из-за большого объема. А из-за того, что они там некорректные. Нормальные значения констант SPELL_ABILITY_* нужно смотреть в файле /types.xml. Принципиальных ограничений на использование «неродных» абилок, в принципе, нет – так, например, суккуб вполне может изображать BATTLE_DIVE. Однако, все возможные сочетания я, конечно, не проверял.
Функция имеет алиас с именем UseCombatAbility.
void displace( sUnitName, nX, nY )
Функция мгновенно телепортирует юнит на требуемую клетку. Никакими эффектами процесс не сопровождается. Если клетка уже занята кем-либо или чем-либо, то вызов функции приведет к ошибке.
Функция имеет алиас с именем SetCombatPosition.
void playAnimation( sUnitName, sAnimType, nActionTypeID = ONESHOT )
Функция заставляет юнит с именем sUnitName проигрывать анимацию sAnimType способом nActionTypeID. Возможные sAnimType следует смотреть в xdb файле определения анимации для существ. Например, для импов это файл _(AnimSet)\Creatures\Inferno\Imp-arena.(AnimSet).xdb. Как правило, анимация типа «death» существует для всех. Остальное зависит от типа существа. Константы для nActionTypeID прописаны в /scripts/combat-startup.lua и могут быть void combatPlayEmotion( nSideID, n1 )
Функция заставляет юниты стороны nSideID проигрывать эмоцию. Полагаю, второй параметр должен определять ее тип, но эксперименты ничего не дали – независимо от значения параметра все ведут себя одинаково – радуются и чего-то голосят.
Функция удаляет все стеки с поля боя. У обоих сторон. Ввиду чего полезность ее под вопросом.
void setATB( sUnitName, n1 )
Функция позволяет управлять положением юнита на ATB. Значения второго параметра большие нуля приводят к сдвигу юнита по ATB в начало шкалы, прочие – в конец. Вероятно, существует какая-то количественная интерпретация параметра, но я ее не уловил. Следует вызывать только из хуков, т.к. в противном случае можно получить рассинхронизацию ATB с действительным порядком ходов.
3.3.4 Информационные и прочие функции.
tsUnits GetUnits(nSideID, nType)
Возвращает таблицу имен юнитов типа nType для стороны nSideID. Константы nType прописаны в /scripts/combat-startup.lua и могут быть С использованием данной функции в файле /scripts/combat-startup.lua реализованы примитивы более высокого уровня:
sHeroName GetHero(nSideID)
tsUnits GetCreatures(nSideID)
tsUnits GetWarMachines(nSideID)
tsUnits GetBuildings(nSideID)
sHeroName GetAttackerHero()
sHeroName GetDefenderHero()
tsUnits GetAttackerCreatures()
tsUnits GetDefenderCreatures()
tsUnits GetAttackerWarMachines()
tsUnits GetDefenderWarMachines()
tsUnits GetAttackerBuildings()
tsUnits GetDefenderBuildings()
nCreatureID GetCreatureType( sCreatureName )
Возвращает тип существ в стеке с именем sCreatureName.
nX, nY pos( sUnitName )
Возвращает координаты юнита с именем sCreatureName. Функция имеет алиас с именем GetCombatPosition.
Возвращает false до тех пор, пока не началась былинная битва. Имеет смысл использовать только вне хуков.
sHeroName GetHeroName( sUnitName )
Возвращает «стратегическое» имя героя sUnitName. Если передано не имя героя – вызов приведет к ошибке.
number GetCreatureNumber( sUnitName )
Возвращает количество существ в стеке с именем sUnitName.
nX, nY GetUnitPosition( sUnitName )
Аналог функции pos.
bool exist( sUnitName )
Возвращает, а жив ли еще юнит с именем sUnitName. Функция имеет алиас с именем IsCombatUnit.
nHostType GetHost( nSideID )
Возвращает, под чьим управлением находится сторона nSideID – человека или AI.
Возвращаемые константы прописаны в /scripts/common.lua и могут быть С использованием данной функции в файле /scripts/combat-startup.lua реализованы примитивы более высокого уровня:
bool IsHuman( nSideID )
bool IsComputer( nSideID )
nSideID GetUnitSide( sUnitName )
Возвращает, к какой стороне относится юнит с именем sUnitName.
Возвращаемые константы прописаны в /scripts/combat-startup.lua и могут быть
С использованием данной функции в файле /scripts/combat-startup.lua реализованы примитивы более высокого уровня:
bool IsAttacker( sUnitName )
bool IsDefender( sUnitName )
number GetUnitType( sUnitName )
Возвращает тип юнита с именем sUnitName. Возвращаемые константы прописаны в /scripts/combat-startup.lua и могут быть С использованием данной функции в файле /scripts/combat-startup.lua реализованы примитивы более высокого уровня:
bool IsHero( sUnitName )
bool IsCreature( sUnitName )
bool IsWarMachine( sUnitName )
bool IsBuilding( sUnitName )
number GetWarMachineType( sUnitName )
Возвращает тип машины с именем sUnitName. Возвращаемые константы прописаны в /scripts/common.lua и могут быть С использованием данной функции в файле /scripts/combat-startup.lua реализованы примитивы более высокого уровня:
sUnitName GetWarMachine( nSideID, nWarMachineTypeID )
sUnitName GetAttackerWarMachine(nWarMachineTypeID)
sUnitName GetDefenderWarMachine(nWarMachineTypeID)
number GetBuildingType( sUnitName )
Возвращает тип здания с именем sUnitName. Возвращаемые константы прописаны в /scripts/combat-startup.lua и могут быть С использованием данной функции в файле /scripts/combat-startup.lua реализованы примитивы более высокого уровня:
sUnitName GetBuilding(nSideID, nBuildingID)
sUnitName GetAttackerBuilding(nBuildingID)
sUnitName GetDefenderBuilding(nBuildingID)
Возвращает имя юнита, который готов совершить ход (т.е. находится в самом начале ATB).
Возвращает строку, содержащую через пробел имена всех юнитов на поле боя. Полагаю, функция нужна, в основном, для отладочных целей.
Функция позволяет эмулировать событие от клавиатуры/мыши. В качестве sEvent могут выступать названия биндов, см. файл input.cfg. Полный список биндов я предоставить в настоящий момент не готов. Смысл двух последних параметров мне так же неясен. Довольно занятная функция, полагаю, с ее помощью можно соорудить миниотладчик, вызывая с ее помощью открытие консоли из функции errorHook.
При старте режима города игра делает следующее:
1. Загружает файл /scripts/town-startup.lua и все прописанные в нем с помощью doFile скрипты
2. Приступает к интерпретации файла скрипта города. Упомянутый скрипт города может появиться в результате дизайна города.
3. В зависимости от ситуации вызывает один из двух хуков.
void CreatureHired( nCreatureID, nCount )
Вызывается при найме существ. Идентификатор типа существа и их количество передаются в качестве параметра.
void HeroHired( sHeroName )
Вызывается при найме героя. Имя героя передается в качестве параметра.
3.4.2 Прочие функции
Собственно, никаких прочих функций я не нашел. Работать можно только с теми, которые перечислены в разделе 3.1.
4. Если бы директором был я.