Создаём простой объект на Shot

В этой статье поговорим о том, как добавить в игру простейший объект, используя встроенный язык программирования Shot.

Использовать будем уже существующую кодобазу от игры Comrades, которая, в свою очередь, основана на игровом коде от Quake II, но портирована на Shot и вместо множества разрозненных функций теперь представляет собой симпатичные классы-объекты.

Для начала создадим самый простой объект, который ничего не делает, а просто показывает в игре модель без коллизии. Пусть это будет модель подбираемого предмета 'Power Cube' (но вы конечно можете взять и любую другую).

1. Подготовка к работе

Первым делом мы должны настроить наши исходники для того, чтобы их можно было скомпилировать. Они находятся в XashNT_SDK\src_user

Если у вас уже имеется бета-версия XashNT_SDK, то внутри проектов пути настроены правильным образом и вам остается только ассоциировать в Windows расширения файлов .hsproj с компилятором-линковщиком языка Shot, который расположен по адресу XashNT_SDK\bin\hshot32.exe.

После ассоциирования, файлы .hsproj будут компилироваться по двойному клику на них. Результат автоматически помещается в comrades/client.program для клиента и ../../comrades/server.program для сервера, соответственно.

Проще всего будет вставить новый объект в конец уже имеющегося файла проекта, который служит для такого рода объектов - XashNT_SDK\src_user\ComradesServer\misc.shot

2. Немного теории

Организация кодовой базы Comrades похожа на таковую в бизнес-логике Half-Life. Что необходимо знать:

4. Создаём свой первый объект

Итак, теперь мы можем приступить к созданию нового объекта.
Выше мы уже условились, что будем использовать модель от 'Power Cube', а писать код в конце файла XashNT_SDK\src_user\ComradesServer\misc.shot

Добавляем в конец файла:

struct CRotationCube : public CBaseEntity
{
	string model_path = "models/items/keys/power.model";

	void Precache() { PRECACHE_MODEL(model_path);}

	void Spawn() {
		Precache();
		SetModel(model_path);
	}
};

LINK_ENTITY_TO_CLASS(misc_rotation_cube, CRotationCube);

Компилируем игровой код двойным щелчком по XashNT_SDK\src_user\ComradesServer\server.hsproj

Готово.

Открываем FGD-файл Джека (XashNT_SDK\J.A.C.K\comrades\quake2_comrades.fgd) и добавляем в конец его объект:

@PointClass base(Keys) studio("models/items/keys/power.model") = 
misc_rotation_cube : "Test Entity\n\nRotating cube model." []

Собираем тестовый уровень, размещаем на нем info_player_start, light_environment и misc_rotation_cube. Компилируем и запускаем из Джека.

Видим в игре:

5. Добавляем вращение объекта

Теперь немного усложним наш код - сделаем так, чтобы объект мог вращаться по произвольным осям. Следует отметить, что это будет чисто визуальное вращение без коллизии.

В кодовой базе Comrades есть несколько типов движения объектов:

• MOVETYPE_NONE - объект неподвижен
• MOVETYPE_NOCLIP - объект игнорирует коллизии
• MOVETYPE_PUSH - используется для дверей, поездов и т.п.
• MOVETYPE_STOP - используется для дверей, поездов если объект может быть заблокирован игроком
• MOVETYPE_FOLLOW - используется для жесткого скрепления двух объектов между собой, например для оружия от первого лица и игрока.
• MOVETYPE_WALK - специальный тип для ходьбы игрока
• MOVETYPE_STEP - наземные монстры
• MOVETYPE_FLY - летающие монстры
• MOVETYPE_TOSS - предметы, которые можно выбросить, аптечки или оружие
• MOVETYPE_FLYMISSILE - используется для ракет
• MOVETYPE_BOUNCE - используется для гранат

Как видно, лучше всего для наших целей подойдет MOVETYPE_NOCLIP.

Включить его можно добавив в Spawn() строчку:

m_movetype =  MOVETYPE_NOCLIP;

Однако само по себе переключение на данный тип физической симуляции ещё не сделает объект подвижным, ведь мы же не задали ускорение вращения. Давайте это сделаем:

m_avelocity = vec3(30.0f, 30.0f, 30.0f);

Переменная m_avelocity имеет векторный тип и позволяет задавать вращение раздельно по трём осям: PITCH, YAW, ROLL. В данном случае, мы задаём вращение по всем трём осям одновременно со скоростью 30 градусов в секунду. Иными словами за одну секунду объект повернётся на 1/12 часть полного оборота, одновременно по всем осям.

Для того чтобы выбрать какую-то одну ось, достаточно обнулить необходимые аргументы конструктора vec3, к примеру:

m_avelocity = vec3(30.0f, 0.0f, 0.0f);

Это даст нам вращение только по оси PITCH.
Добавим две вышеприведённые строчки прямо в функцию Spawn:

void CRotationCube :: Spawn( void )
{
	Precache();
	SetModel( "models/items/keys/power.model" );
	m_movetype = MOVETYPE_NOCLIP;
	m_avelocity = vec3( 30.0f, 30.0f, 30.0f );
}

Компилируем игровой код двойным щелчком по XashNT_SDK\src_user\ComradesServer\server.hsproj

Карту пересобирать не нужно, поэтому запускаем XashNT_SDK\comrades.exe, жмем Escape для выхода в консоль, выполняем:

map имя-карты

и видим что наш объект теперь вращается по всем осям:

6. Настраиваемое вращение

Добавим возможность настраивать скорость вращения по всем трём осям из редактора уровней:

В наш класс CRotationCube добавим 3 строки в самое начало:

DECLARE_PROP_KEYFIELD_READONLY(float, m_speed_x);    
DECLARE_PROP_KEYFIELD_READONLY(float, m_speed_y);    
DECLARE_PROP_KEYFIELD_READONLY(float, m_speed_z);

Этот макрос создаст члены класса:

float m_speed_x;
float m_speed_y;
float m_speed_z;

Передадим их в конструктора вектора ускорения:

m_avelocity = vec3(m_speed_x, m_speed_y, m_speed_z);

Финальный вид класса:

struct CRotationCube : public CBaseEntity
{
	DECLARE_PROP_KEYFIELD_READONLY(float, speed_x);
	DECLARE_PROP_KEYFIELD_READONLY(float, speed_y);
	DECLARE_PROP_KEYFIELD_READONLY(float, speed_z);

	string model_path = "models/items/keys/power.model";

	void Precache() { PRECACHE_MODEL(model_path);}

	void Spawn() {
		Precache();
		SetModel(model_path);
		m_movetype =  MOVETYPE_NOCLIP;
		m_avelocity = vec3(speed_x, speed_y, speed_z);
	}
};

Теперь добавим эти поля в quake2_comrades.fgd:

@PointClass base() studio("models/items/keys/power.model") = 
misc_rotation_cube : "Test Entity\n\nRotating cube model." 
[
	m_speed_x(float) : "Rotating speed X" : 0
	m_speed_y(float) : "Rotating speed Y" : 0
	m_speed_z(float) : "Rotating speed Z" : 0
]

Формат описания поля:

имя-поля(тип) : "Имя в редакторе" : значение-по-умолчанию

Перезапустим Джек и откроем свойства объекта:

Теперь можно настраивать скорость вращения модели куба по всем осям из редактора.

На этом пока всё, продолжение следует.