Detail props

This article or section needs to be updated to include current information regarding the subject.
Remember to check for any notes left by the tagger at this article's talk page.

Detail prop на этом скриншоте взят из Dear Esther(en).

Detail props отражается на воде в Orion(en) скрине. Обратите внимание на склон холма вдали, который находится за пределами затухания.

Detail props смешан с static props(en) в Prison Island(en).

Detail props это дешевые, бесплотные объекты, которые случайным образом появляются на поверхности специальных материалов. Они исчезают из вида на определенном расстоянии от игрока (по умолчанию это 1200 юнитов). Это значит, что они годятся только для небольших объектов, таких как трава или прочая мелкая растительность.

Detail props бывает двух типов:

Спрайты: Двух полигональный плоский квадрат, использующий параметр $translucent(en) внутри материала. Объект может быть настроен так, чтобы он всегда “смотрел” в сторону камеры игрока, покачивался на ветру (что уже будет ресурсоемко) и прогибался под шагами идущего. Спрайт не может проходить сквозь водную поверхность.
Модели: 3д модели следует использовать очень редко, если вообще использовать. Каждая модель расходует видео ресурсы DirectX, вне зависимости от того, сколько у модели полигонов, нагрузка всегда будет выше приемлемой.

Использование

Типы покрытия detail prop ("detail types") определяются скриптом файла .VBSP (Формат ANSI), и описаны в материалах с помощью параметра %detailtype. Затем VBSP(en) рандомно генерирует detail props на поверхностях, покрытых этим материалом, при компиляции карты.

Detail props могут быть размещены в ручную в паре с prop_detail(en) и prop_detail_sprite(en) энтити, но это редкая практика.

Совет:Стандартный VBSP файл находится в root\detail.vbsp (например Half-life 2/ep2/detail.vbsp), но вы можете создать и свой собственный, только не забудьте изменить в Valve Hammer переменную “Detail vbsp file” во вкладке (Map > Map Properties…

Совет:Используйте брашевую энтити Template:L4D add (впервые появился в Left 4 Dead) для подавления генерации detail sprites в нежелательных зонах.

Базовые типы detail

Эти типы detail доступны Source SDK Base(en):

Type	View
swamp_land_002
grass01
grass02
coastline_grass01
coastline_grass02
coastline_redgrass01
coastline_redgrass02
coastline_redgrass03
citygrass01
redgrass
redgrass_light
short_redgrass
canal_reeds
PerfTest1
lostcoast_grass
lostcoast_grass2

Эти типы detail присутствуют, но доступны только на 3D моделях:

swamp_land_001
swamp_water_001
grassland1
grassland2
grassland3
rocks3
test
coast_pebbles
street_junk

Новые типы detail

Здесь отображен пользовательский VBSP файл. Требуется поддержка detail shape. Используется эта текстура с этим шаблоном.

detail
{
	forest_floor_01
	{
		density 1600
		GrassTex
		{
			alpha 0
			RoseFlower
			{
				sprite "0 0 83 128 512"
				spritesize "0.5 0.05 7 13"
				spriterandomscale .3
				amount 0.02
				detailorientation 2
				sway 0.2
				upright 1
				maxangle 70
			}
			FernShrub
			{
				sprite "120 0 136 256 512"
				spritesize "0.5 0.05 17 28"
				spriterandomscale .15
				amount 0.03
				sprite_shape tri
				shape_size 0
				sway 0.3
				upright 1
				maxangle 50
			}
			GrassTuft
			{
				sprite "0 199 120 57 512"
				spritesize "0.5 0 20 10"
				spriterandomscale .2
				amount .6
				sprite_shape cross
				sway .1
				maxangle 95
			}
			PinkFlower
			{
				sprite "83 0 38 128 512"
				spritesize "0.5 0 6 18"
				spriterandomscale .1
				amount 0.02
				detailorientation 2
				sway 0.3
				upright 1
				maxangle 70
			}
			LushShrub
			{
				sprite "256 128 172 128 512"
				spritesize "0.5 0 32 21"
				spriterandomscale .3
				amount 0.01
				sprite_shape tri
				shape_size 0.1
				sway 0.1
				maxangle 40
			}
		}
		LeavesTex
		{
			alpha 1
			DriedGrass
			{
				sprite "256 0 92 120 512"
				spritesize "0.5 0 13 17"
				spriterandomscale .15
				amount .3
				sprite_shape cross
				sway .3
				maxangle 95
			}
			GrassTuft
			{
				sprite "0 199 120 57 512"
				spritesize "0.5 0 20 10"
				spriterandomscale .2
				amount .6
				sprite_shape cross
				sway .1
				maxangle 95
			}
			RoseFlower
			{
				sprite "0 0 83 128 512"
				spritesize "0.5 0.05 7 13"
				spriterandomscale .3
				amount 0.02
				detailorientation 2
				sway 0.2
				upright 1
				maxangle 70
			}
		}
	}
}

Его синтаксис:

detail
{
	<Detail type>
	{
		density <float>

		<Group>
		{
			alpha <normal>

			<Prop>
			{
				<settings>
			}
		}
	}
}

Обозначение команд:

Detail type

Это имя дитейла указанного в VMT материала %detailtype.

density <float(en)>: Плотность генерации detail пропов на поверхности материала.

Совет:Density 1000000означает, что на каждом юните будет по 1 пропу. Средняя плотность детейлов 1000-1500. (128 юнитов - 2 пропа - 256 плотность)

Group

Даже если вам требуется определить всего один detail prop, вам все равно необходимо создать группу (group). Имя вряд ли где-то используется, оно нужно просто для справки.

Примечание: поверхности Non-displacement используют только первую группу detail!

alpha <normal(en)>: Значение сдвига alpha, при котором генерируется данная группа detail проп. Каждый раз при генерации detail проп VBSP выбирает группу с ближайшим значением alpha к текущему в данной локации (месте). Если alpha не определена, все группы появятся во всех областях.

Prop: Определяет detail prop. И хотя у него есть уникальное имя, нет возможности ссылаться на существующий проп позже в .VBSP: он должен быть переопределен всякий раз, когда он нужен. И все же использовать понятные имена это неплохая идея.

Prop настройки

amount <normal(en)>: Доля от общего числа всех моделей (спрайтов) относительно указанной плотности из переменной density Обычно 0.1.
upright <bool(en)>: Если указано (не важно какое значение) модель всегда будет “смотреть” вверх. Если переменной нет, модель будет ориентироваться относительно материала поверхности на которой она должна генерироваться. (расти из земли вертикально)
minangle <float>
maxangle <float>: Регулирует генерацию на крутых поверхностях. Стандартное значение для обоих 180 градусов (без ограничений).
Совет:Если выставить 180 и 180 (min-max) Ваша трава будет расти даже на потолке. Если выставить 0 и 180, трава будет расти всюду, кроме потолка. 45 и 180, стена под косым углом ВНИЗ - редкая растительность. 180 и 45, стена под косым углом ВВЕРХ - редкая растительность. Значение 0 и 90 - трава только на земле и склонах, но на прямой стене и потолке её не будет.

Спрайты

sprite <int(en)|X, Y, W, H, VTF width>

Это координаты на общей VTF текстуре, откуда берется рендер каждой отдельной травинки.

X/Y это горизонтальная и вертикальная координаты.
W/H это размеры (ширина, высота) в текстелях

Баг:Любая пользовательская текстура растительности должна быть краткой дефолтной detail\detailsprites Иначе будет искривление рендера ! исправить это можно здесь [todo tested in?]

spritesize <normal|U, V> <float(en)|W, H>: Размеры спрайта в самой игре, (U/V) - смещение.относительно точки опоры и (W/H)
spriterandomscale <normal>: Ширина и высота спрайта. (U/V лучше не трогать)

Размер спрайта не должен быть указан как 1 и 1, его не будет в игре. Оптимальный размер от 10 до 20.

detailOrientation <int>

Будет ли спрайт поворачиваться своим “лицом” к камере игрока:

0: Не вращается.
1: спрайт всегда смотрит в камеру игрока, даже когда игрок стоит над спратом, тот словно наклоняется.
2: Спрайт всегда смотрит в камеру игрока, однако вращается только вокруг Z оси, по кругу.

Шейпы-сложные формы

sprite_shape tri

sprite_shape cross

Шейпы это пропы, где два или три спрайта собраны в трехмерную форму. Они могут покачиваться на ветру или под воздействием проходящего игрока

Предупреждение:Генерация шейпов сильнее грузят GPU, в то время покачивание шейпов нагружает CPU. Используйте их как можно меньше. (Команда разработчиков Dear Esther разработала покачивания шейпов с обработкой на GPU, они более реалистичные и быстрые, но их код не вошел в релиз.)

Detail shapes доступны всего в нескольких играх, например, Day of Defeat: Source(en), Counter-Strike: Source(en), Counter-Strike: Global Offensive(en), Garry's Mod(en) и в коде SDK. Если вы попытаетесь создать шейпы в игре, где нет их поддержки, то detail props вообще не будут сгенерированы.

Совет: Для включения шейпов в свой мод, или скомпилируйте его с SDK_DLL или откройте\game\client\detailobjectsystem.cpp и удалите #ifdef в 27 строке.

sprite_shape <choices>

Создает набор спрайтов под разными углами, разрешая эффект псевдо-3D.

tri: три спрайта посажены на одинаковом расстоянии друг от друга по углам треугольника.
cross: Два спрайта пересекают друг друга крестиком по центру.

sway <normal(en)>: Процент от cl_detail_max_sway определяющий насколько проп может наклониться (по умолчанию?)

Совет:Не обязательно указывать sprite_shape чтобы шейп покачивался, но обязательно нужна поддержка шейпов в вашей игре.

shape_angle <float(en)>: Актуально только для варианта tri (sprite_shape). Число градусов снаружи, под которыми повернуты отдельные спрайты. Внешний угол, под которым повернуты отдельные спрайты. К сожалению, нельзя указать внутренний угол по некоторым причинам! Полезные значения параметра от 0-45.
shape_size <normal>: Актуально только для варианта tri (sprite_shape). Процент ширины спрайта, определяющий расстояние от центра треугольника до спрайтов. 0 означает, что все спрайты будут расти из 1 точки.

Есть также несколько консольных команд, которые воздействуют на шейпы:

cl_detail_avoid_force: Избегать генерации при воздействии игрока.
cl_detail_avoid_radius: Радиус вокруг спрайта; если игрок находится в его пределах, спрайт не будет сгенерирован.
cl_detail_avoid_recover_speed: определяет насколько быстро восстанавливается спрайт после взаимодействия с игроком.
cl_detail_max_sway: Амплитуда покачиваний detail prop.

Если в игре вы не нашли этих команд, значит, игра не поддерживает шейпы.

Модели

Помните, что модели отнимают намного больше ресурсов, чем спрайты. Используйте их крайне осторожно.

Хорошими кандидатами для 3д флоры являются, маленькие камушки, упавшие ветви, продолговатые растения, как плющ или кусты сложной формы. Для простой вертикальной растительности лучше выбирать спрайты.

model <string(en)>: Чтобы модель могла быть использована как Prop Detail, внутри её QC должна быть строка $staticprop, а материал vmt должен использовать шейдер UnlitGeneric.

Размещайте модели в папке Models и не путайтесь в путях.

Совет:Если вы коддер и вам нужно разрешить модели использовать шейдер VertexLitGeneric, откройте файл game\client\detailobjectsystem.cpp и удалите блок CDetailObjectSystem::UnserializeModelDict().

Новые detail материалы

The sample .VBSP's detail texture.

Несколько важных условий:

Нужно оставлять хотя бы 1 пиксель между двумя изображениями растительности внутри общего кастомного detailsprites, иначе в игре будет заметен переход по краям двух спрайтов.
Материал должен использовать шейдер UnlitGeneric(en). Возможно Вам пригодятся и другие переменные $vertexcolor(en), $receiveflashlight(en), $nocull(en) и $translucent(en).
Если Вы решили заменить стандартный detail\detailsprites.vmt, не забудьте указать в свойствах карты Map > Map Properties... путь и имя новой текстуры.

Баг: Любая пользовательская текстура растительности должна быть краткой дефолтной detail\detailsprites! Иначе будет искривление рендера. Править это можно вот тут. [todo tested in?]

Блокировка Detail props в нежелательных зонах

Если вам нужно исключить генерацию пропов в определенной зоне, воспользуйтесь энтити func_detail_blocker(en) (Доступно только в Portal 2(en), Alien Swarm(en), Left 4 Dead 2(en), Counter-Strike: Global Offensive(en), и Garry's Mod(en).)

Detail props

Contents

Использование

Базовые типы detail