Ru/Authoring a Model Entity
После создания логической энтити в предыдущем примере, теперь создадим энтить которая может двигаться, создавать коллизии с остальнымио бъектами, и которая имеет визуальную компоненту (в данном случае, модель). В этом примере мы создадим энтить которая отображается используя модель, и перемещаются по миру случайным образом.
Создаем CPP файл для новой энтити
- Создаем файл называемый
sdk_modelentity.cpp
. Этот файл должен быть внутри пакпки dlls которая находить в папке с вашим исходным кодом. Например, если вы установили код вC:\MyMod\src
, тогда вы должны создать файл называемыйC:\MyMod\src\dlls\sdk_modelentity.cpp
. - Далее копируем этот код и вставляем его в новый файл.
- В последнею очередь добавляем этот файл в ваш проект server.dll. Если вы открыли
game_sdk.sln
solution, тогда вы можете щелкнуть правой кнопкой на проекте hl в окне Solution Explorer и выбрать Add, затем Add Existing Item.
Рассмотрение кода
Создание определения класса
class CMyModelEntity : public CBaseAnimating { public: DECLARE_CLASS( CMyModelEntity, CBaseAnimating ); DECLARE_DATADESC(); void Spawn( void ); void Precache( void ); void MoveThink( void ); // Функция ввода void InputToggle( inputdata_t &inputData ); private: bool m_bActive; float m_flNextChangeTime; };
Мы наследуем нашу энтить от класса CBaseAnimating
. Это позволяет использовать модели и анимацию. Также новыми для этой энтити являются функции Spawn()
и Precache()
.
Определяем описание данных
LINK_ENTITY_TO_CLASS( my_model_entity, CMyModelEntity ); // Начинаем описание наших данных для класса BEGIN_DATADESC( CMyModelEntity ) // Сохраняем/востанавливает наще активное состояние DEFINE_FIELD( m_bActive, FIELD_BOOLEAN ), DEFINE_FIELD( m_flNextChangeTime, FIELD_TIME ), // Связываем наше имя input из Хаммера к нашей input функции DEFINE_INPUTFUNC( FIELD_VOID, "Toggle", InputToggle ), // Описываем нашу think функцию DEFINE_THINKFUNC( MoveThink ), END_DATADESC()
Подобно нашей логической энтити, мы должны объявить переменные используемые энтитью так чтоб движок знал их смысл.
Важно отметить что функция MoveThink()
должна быть объявлена как энтить с think-функцией таблице описания данных используя макрос DEFINE_THINKFUNC
. Смотрите документ о таблице описания данных для дополнительной информации.
Создаем Precache() функцию
#define ENTITY_MODEL "models/gibs/airboat_broken_engine.mdl" void CMyModelEntity::Precache( void ) { PrecacheModel( ENTITY_MODEL ); }
Precache()
функция выполняет кеширование всех нужных файлов. Для дополнительной информации по теме, смотрите Кеширование файлов. Здесь мы также определяем модель которая представляет нашу энтить в мире.
В данном примере мы вызываем PrecacheModel()
для кеширования модели. Без этого шага, модель энтити не появиться в мире и движок будет жаловаться на отсутствующее кэширование.
Создаем Spawn() функцию
void CMyModelEntity::Spawn( void ) { Precache(); SetModel( ENTITY_MODEL ); SetSolid( SOLID_BBOX ); UTIL_SetSize( this, -Vector(20,20,20), Vector(20,20,20) ); m_bActive = false; }
Функция Spawn()
вызывается после создания энтити. Эта функция может считаться игровым конструктором энтити. Здесь энтить может установить ее начальное состояние, включая то что модель использует, ее способы движения и твердость. Важно отметить что функция Spawn()
вызывается немедленно после размещения энтити в памяти и поскольку это происходит в самом начале карты, нет гарантии что все остальные энтити к этому моменту были успешно созданы. В связи с этим, любой код связывающий данную энтить с поиском или связью с другими именованными энтитями должен производиться в функции Activate()
данной энтити. Функция Activate() вызывается когда все энтити создались и произвели запуски их Spawn() функций. Поиск энтитей перед функцией Activate() зависит от порядка создания энтитей и является ненадежным.
В приведенном ниже примере, сначала вызывается функция Precache()
для того чтобы удостовериться что все файлы будут корректно кэшированы. После чего, используется функцияSetModel()
для установки модели определенной до этого.
Далее, устанавливается твердость энтити с помощью функции SetSolid()
. Здесь доступны несколько допустимых типов твердости:
SOLID_NOT |
Отсутствует. |
SOLID_BSP |
Использует BSP дерево для определения твердости (используется для браш-моделей) |
SOLID_BBOX |
Используется выравненый по осям ограничительный бокс. |
SOLID_CUSTOM |
Энтить определяет ее собственные функции для проверки колизий. |
SOLID_VPHYSICS |
Использует объект vcollide для проверки коллизий. |
В данном примере, мы создаем энтить использующую ограничительный бокс. Функция UTIL_SetSize()
позволяет установить размер ограничительного бокса. Здесь мы устанавливаем куб размером 40x40x40.
Создаем MoveThink() функцию
Энтити способны обновлять внутренее состояние и принимать решения с помощью функции think, которая вызывается с частотой указанной энтитью. Ниже мы создаем think-функцию которая вызывается 20 раз в секунду. Эта функции используется для случайного обновления передвижения и направления в мире.
void CMyModelEntity::MoveThink( void ) { // Смотрим если мы должны снова изменить направление if ( m_flNextChangeTime < gpGlobals->curtime ) { // Случайно выбираем новое направление и скорость Vector vecNewVelocity = RandomVector( -64.0f, 64.0f ); SetAbsVelocity( vecNewVelocity ); // Случайно изменяем его снова через 1-3 секунд m_flNextChangeTime = gpGlobals->curtime + random->RandomFloat(1.0f,3.0f); } // Устанавливаем лицо по направлению движения Vector velFacing = GetAbsVelocity(); QAngle angFacing; VectorAngles( velFacing, angFacing ); SetAbsAngles( angFacing ); // Думаем каждые 20Гц SetNextThink( gpGlobals->curtime + 0.05f ); }
Эта функция содрежит много кода, но смысл его довольно прост: после прохождения случайного интервала времени, энтити выбирает новое, случайное направление и скорость путешествия. Он также обновляет углы чтобы лицо было направлено по направлению движения.
Вызов функции SetNextThink()
важен, потому что это говорит энтити когда думать в следующий раз. Здесь устанавливается вызвать think через 1/20 секунды. Для большинства энтитей только нужно думать с частотой 1/10 секунды, взависимости от из поведения. Важно заметить что если не обновить next think time для энтити это приведет к тому что она престанет думать (иногда это удобно).
Создаем ToggleInput() функцию
Для данной энтити мы используем ввод(input) для переключения ее передвижения как включенного/выключенного. Для этого, мы объявляем input-функцию подобной из предыдущего урока.
void CMyModelEntity::InputToggle( inputdata_t &inputData ) { // Переключаем наше состояние активности if ( !m_bActive ) { // Начинаем думать SetThink( MoveThink ); SetNextThink( gpGlobals->curtime + 0.05f ); // Начинаем летать SetMoveType( MOVETYPE_FLY ); // Устанавливаем следующее время когда меняем скорость и направление m_flNextChangeTime = gpGlobals->curtime; m_bActive = true; } else { // Перестаем думать SetThink( NULL ); // Перестаем двигаться SetAbsVelocity( vec3_origin ); SetMoveType( MOVETYPE_NONE ); m_bActive = false; } }
Для начала "работы" энтити используется функция SetThink()
в соединении с функцией SetNextThink()
. Она сообщает энтити использовать функцию MoveThink()
и вызывается через 1/20 секунды. Важно отметить что энтить может иметь любое количество think-функций и использовать SetThink()
функцию для выбора между ними. Каждая энтить может иметь несколько think-функций выполняющихся в одно и то же время используя SetContextThink()
описанной в другом документе.
Также мы определяем тип движения энтити MOVETYPE_FLY
. Это позволяет энтити двигаться в заданном направлении без гравитации.
Во второй части энтити этой функции мы останавливаем энтить от движения. think-функция устанавливается в NULL
для остановки think-процесса. Её тип движения также устанавлтвается MOVETYPE_NONE
чтобы предотвратить движение.
Создаем запись в FGD файле
Для использования энтити в Хаммере, мы должны создать запись в FGD файле. Хаммер будет использовать эти данные для того чтобы понять различные ключевые значения и функции которые предоставляет энтитя. Смотрите документ FGD формата для дополнительной информации о FGD файлах.
Запись FGD для энтити просто отображает модель в хаммере и позволяет отправлять input "Toggle" ей.
@PointClass base(Targetname) studio("models/gibs/airboat_broken_engine.mdl")= my_model_entity : "Tutorial model entity." [ input Toggle(void) : "Toggle movement." ]
Если ваш .FGD не пустой, убедитесь что добавили строку @include "base.fgd", которая даст вам некоторые нужные функции Хаммера. (При полном преобразование. Мод основанный на существующем содержимом, включайте соответствующие FGD файлы; на пример для HL2 мода, включите halflife2.fgd
вместо base.fgd
.)