particle

This page is incomplete! You can contribute information using GitHub issues or pull requests.

The particle tag defines the characteristics of point-like entities used extensively throughout Halo's effects to simulate sparks, smoke, plasma, blood, and more. Particles can interact with wind, collision geometry and the BSP via their point_physics.

	Function/global	Type
	`(debug_sprites [boolean])` Renders 2D sprite effects like particles and weather_particle_system with white triangle outlines. This also displays some sprite statistics at the top of the screen (coverage and big sprites count).	Global
	`(profile_display [boolean])` Displays profiling and budget information in the upper-left of the screen, including object, effects, particles, AI encounters, collision tests, and more. You may find it useful to open the console while using this feature in order to stop the game simulation.	Global
	`(render_particles [boolean])` Toggles the display of all particles.	Global

Function/global

Type

(debug_sprites [boolean])

Renders 2D sprite effects like particles and weather_particle_system with white triangle outlines. This also displays some sprite statistics at the top of the screen (coverage and big sprites count).

Global

(profile_display [boolean])

Displays profiling and budget information in the upper-left of the screen, including object, effects, particles, AI encounters, collision tests, and more. You may find it useful to open the console while using this feature in order to stop the game simulation.

Global

(render_particles [boolean])

Toggles the display of all particles.

Global

Structure and fields

Field Type Comments

flags bitfield

Flag	Mask	Comments
can animate backwards	`0x1`
animation stops at rest	`0x2`
animation starts on random frame	`0x4`
animate once per frame	`0x8`
dies at rest	`0x10`
dies on contact with structure	`0x20`
tint from diffuse texture	`0x40`
dies on contact with water	`0x80`
dies on contact with air	`0x100`
self illuminated	`0x200`
random horizontal mirroring	`0x400`
random vertical mirroring	`0x800`

bitmap

TagDependency: bitmap

Non-null

physics TagDependency: point_physics

sir marty exchanged his children for thine TagDependency: material_effects

lifespan

Bounds

Unit: seconds

Field	Type	Comments
min	`float`
max	`float`

fade in time float

fade out time float

collision effect

TagDependency

death effect

TagDependency

minimum size

float

Unit: pixels

radius animation

Bounds^?

Default: 1,1

animation rate

Bounds^?

Unit: frames per second

contact deterioration

float

Non-cached
Hidden

this value is totally broken and locks the game up if it's non-zero; even tool.exe sets it to zero

fade start size

float

Unit: pixels
Default: 5

fade end size

float

Unit: pixels
Default: 4

first sequence index uint16

initial sequence count uint16

looping sequence count uint16

final sequence count uint16

sprite size

float

Cache only

orientation enum

Option	Value	Comments
screen facing	`0x0`	Particles will face directly toward the viewer, ideal for effects like smoke and snow.
parallel to direction	`0x1`	Particles will be oriented along the direction of movement, facing the camera but only rotating around the axis of movement. This type is ideal for particles with trails like rain and sparks. In the sprite texture, right is the forward direction.
perpendicular to direction	`0x2`	Particles will be oriented perpendicular to the direction of movement, so will be seen face-on when the particle is moving toward or away from the camera.

make it actually work

uint32

Cache only

shader flags bitfield

Flag	Mask	Comments
sort bias	`0x1`
nonlinear tint	`0x2`
don't overdraw fp weapon	`0x4`

framebuffer blend function enum

Option	Value	Comments
alpha blend	`0x0`
multiply	`0x1`
double multiply	`0x2`
add	`0x3`
subtract	`0x4`
component min	`0x5`
component max	`0x6`
alpha multiply add	`0x7`

framebuffer fade mode enum

Option	Value	Comments
none	`0x0`	The faces do not fade by viewing angle.
fade when perpendicular	`0x1`	The faces fade out when viewed edge-on.
fade when parallel	`0x2`	The faces fade out when viewed flat to the camera.

map flags bitfield

Flag	Mask	Comments
unfiltered	`0x1`	Texture sampling is unfiltered, resulting in aliasing at a distance and a blocky pixelated look up close.

bitmap1 TagDependency: bitmap

anchor enum

Option	Value	Comments
with primary	`0x0`	Positioned relative to each particle.
with screen space	`0x1`	Positioned relative to the screen.
zsprite	`0x2`

map flags1 bitfield^?

u animation source enum

Option	Value	Comments
none	`0x0`
a out	`0x1`
b out	`0x2`
c out	`0x3`
d out	`0x4`

u animation function enum

Option	Value	Comments
one	`0x0`
zero	`0x1`
cosine	`0x2`
cosine variable period	`0x3`
diagonal wave	`0x4`
diagonal wave variable period	`0x5`
slide	`0x6`
slide variable period	`0x7`
noise	`0x8`
jitter	`0x9`
wander	`0xA`
spark	`0xB`