Turok EX Modding Guide

continuously increment rather than multiply scale by scaleDest:

0. scale *= scaleDest
1. scale += scaleDest

Mirrors the sprite (horizontally and vertically, contrary to the name and existence of bTextureWrapMirrorHeight) to form a larger image (scaled to fit in the same space).

example:

render with first-person weapon modelview matrix

allows consistent alignment with first-person weapon irrespective of FOV, but causes inconsistent positioning in the world when FOV is not 47.5

offset (using muzzleOffset) relative to first-person weapon orientation

results in a tighter link than bWeaponView alone (follows waver when turning, won't lag by a frame, etc.)

also causes the effect to last for only a single frame

affects various behavioral properties:

• Particle is destroyed when speed drops below a certain threshold. Does not call onExpire or onWaterExpire in this case (they will still happen when lifeTime runs out).
• See notes in Collision.

makes the particle qualify for precise projectile collision

may not always be desirable, as it can cause the particle to collide with small details like vines

do not spawn when blood is disabled, or against actors with "no blood" flag (namely animals)

a bBlood particle also indicates that all particles that come after it in the file should only be spawned when blood is disabled (or against "no blood" actors), unless they also have bBlood set

details of the green blood violence setting are untested

similar to offset, but relative to first-person weapon orientation

for use with bMuzzleEffect

initial velocity = forwardSpeed * normal(translation)

speed is in terms of distance per second

acceleration along global vertical axis, in terms of speed per second

negative values are down

fraction of velocity along hit surface normal to retain when bouncing (after velocity is mirrored):

velocity += (1 + mass) * (velocity • normal) * normal

If bBullet is set, this instead controls max deflection angle. The two extremes are:

• 0.0 - bounce only when hitting completely parallel to surface
• 1.0 - always bounce, even if hitting head-on

acceleration opposing velocity

seems to be constant based on initial velocity:

• will cause the particle to move backward if set too high
• causes path to curve after bouncing (instead of opposing new velocity)

Only affects horizontal velocity. Vertical velocity always seems to be affected by ~0.1 friction (but only when moving down).

Unlike airFriction, this isn't a constant force – the particle will actually come to a stop if waterFriction is high enough, and bouncing won't mess things up.

how many copies of this particle to spawn

any randomized properties get randomized independently for each instance (e.g., shotgun pellets don't all get the same randomized trajectory)

a negative instancesRandom can be used to make the particle spawn < 100% of the time

how long the particle will exist, in 1⁄15 seconds

There's a limit to how many particles can exist at once. Particles with a higher priority are given precedence when that limit is reached.

Things that affect gameplay (like projectiles) should be set to 100.

shader to render the sprite with

typically worldfx or worldcolorfx (the latter tends to be more colorful for translucent particless)

e.g., shader = "progs/worldcolorfx"

sprite to represent the particle with

e.g., sprite = "sprites/fx064"

lens flare effect to cause

e.g., lensFlares = "lensflares/turoklens.klf"

bLensFlares must be set for this to take effect

trailDefinition_1
...
trailDefinition_N

leave polygonal trails

e.g.,

trailDefinition_1 = "Trail_TekBow_Crossline_1"
trailDefinition_2 = "Trail_TekBow_Crossline_2"

0. face camera
1. flat along xy-plane
2. flat along xy-plane, elevated 1 unit to avoid z-fighting with floor
3. face camera
4. face along surface normal
5. face camera (billboard)
6. not drawn?
7. face camera

0. normal?
1. fade out as you get closer (full opacity is pretty far away)
2. normal?
3. hidden?
4. normal?

0. play, then destroy when complete
1. play, then hold last frame until lifeTime runs out
2. loop
3. don't draw
4. loop, don't necessarily start at first frame?
5. play, then hold a random frame?
6. don't draw?

how much to slow animation as velocity decreases?

not sure of the details; reasonable values seem to be around 0 to forwardSpeed?

negative values do not appear to cause animation to speed up as velocity decreases

offset from the particles's physical location to render the sprite

uses the same coordinate system as other vectors, except relative to the camera's orientation, rather than the particles's orientation

sprite rotation orbits the particles's physical location (this is how rockets and shockwave weapon projectiles spiral)

spawned particless will center on the sprite, but hit detection, splash damage, and sounds will still be based on the particles's physical location

alters light and dark colors of the sprite, respectively

displayColor = blackColor + spriteColor * (whiteColor - blackColor)

color randomization

values range from 0 to 255

0. ignore; pass right through
1. hit and disappear
2. hit and reflect
   • onImpact event is ignored (unless bBullet is set)
   • if bBullet is set, bounce only up to twice, and only if angle is wide, based on mass
3. hit and bounce
   • this is supposed to be reflection with speed reduction, but seems identical to reflect?
4. hit and push against, dealing continuous damage

happens when hitting an actor, wall, or floor (based on the onCollide properties above)

contains a sub-block for each surface type it can hit:

0. grass/wood surfaces
1. water (rarely used*)
2. metallic enemies
3. hard surfaces
4. red-blooded enemies
5. yellow-blooded enemies
6. undead enemies (unused?)
7. lava
8. tar
9. force field

happens when lifeTime runs out, unless underwater

happens when entering (or exiting?) water

spawn another effect

e.g., fx = "fx/blood.kfx"

play a sound

e.g., sound = "sounds/shaders/bullet_impact_13.ksnd"

deal damage, from defs/damageInfo.txt

e.g., damageClass = "S_Damage_Target_damage_10"

ignored by onWaterImpact