Trespasser Script Reference

This document describes the classes and values of the scripting used by Trespasser. The syntax of the script is that used by TresEd, the Trespasser Level Editor.

Script Reference:
General Script Classes
Trigger Classes
Trigger Actions

• Default value "none" means value is optional and only used if specified.
• A '$' object is one whose name begins with '$' and is used by the physics engine.
• If restrictions (eg. "Named object must exist") are not honored, Trespasser may behave oddly or crash.
• If a value is listed as "Must specify", Trespasser may behave oddly or crash if the value is not specified.

Disclaimer: This page is work in progress, is far from complete, and has not been thoroughly checked so use it just as a guide.

General Script Classes and Values

Trespasser recognizes the following data types:

bool

A boolean logic state, can be either true or false

char

A single text character in ASCII, probably. Uses a single byte? Not used in any level.

int

An integer numerical value, stored in four bytes

float

A floating-point numerical value, stored as four bytes too.

string

A sequence of characters ending with a null character.

object

A structure that engulfs values of other types (including other objects). TresEd calls it "group", but internally, the Trespasser executables use "object". Throughout this document, "group" is used, until a newer version of TresEd adds support for "object" while keeping "group" for backwards compatibility.

Values are case sensitive and strongly typed. This means that if you type "moveable" instead of "Moveable" or "int Frame" instead of "float Frame", Trespasser will ignore the value. Where the default value is listed as "must specify", Trespasser may behave badly or even crash if the value is not specified.

The Class value determines the type of object, and all objects should specify it.

Example:

group MyTerrainTexture = {
  string Class = "CTerrainObj"
  int Height = 1
  string SoundMaterial = "Grass"
}

Classes:
AI Command
CAnimal
CBackdrop
CEntityAttached
CEntityWater
CGun
CHitSpang
CInstance
CJoint
CLightDirectional
CMagnet or MasterMagnet
SlaveMagnet
CSocket
CMuzzleFlash
CParticles
CSky
CSubsystem
CTerrainObj
CTest
CWaterDisturbance or Disturbance
Player
Player Settings
Settings
Teleport
Marker
TerrainPlacement
<no Class specified>
IGNORE
See also Trigger classes

Possible classes, with unknown usage (not used in original levels): CHitSpang, CInput, CSocket, Default, Marker, TerrainExtent, CTest, CSubsystem.

AI Command

Specifies the sounds to use for CAnimals. See a level for examples.

Example:

group VocalTriceratopsRoar = {
    string Class = "AI Command"
    int Dinosaur = 3
    int Vocal = 2
    string A00 = "TRIC-CALL-03"
    string A01 = "TRIC-STLK-01"
    object A02 = {
        string Sample = "TRIC-WMPR-02"
        float Open = 0.1
        float Close = 0.2
    }
}

Vocal values are as follows: 0=Pain, 1=Call, 2=Roar, 3=Snarl, 4=Stalk, 5=Whimper, 6=Dying, 7=Attack, 8=Bite, 9=Chew, 10=Drink, 11=Swallow, 12=Sniff, 13=Tear

CAnimal

A dinosaur, see a level for examples. See also the trigger actions "CSetAIAction", "CSetAnimatePropertiesAction" and "CWakeAIAction".

CBackdrop

Used in original levels to represent Mt. Watson from great distances, either when terrain is too distant to be rendered or does not extend far enough to have it included. CBackdrop is excluded from the normal render-distance restriction for visible models in Trespasser, where the mesh begins to disappear at a certain range, and as such will be viewable in full quality across any ingame distance. CBackdrop is also excluded from Occlusion objects. In the original levels, the CBackdrop always takes on the color of the level's fog setting. New CBackdrop objects are colored black when within a certain viewing distance, for uknown reasons. They can sometimes take on the level's fog color when far enough away. CBackdrop objects cannot use textures, however if one is textured, it will take on an average color of the texture rather than black in the afore mentioned circumstances. CBackdrop meshes copied in TresEd from other CBackdrop meshes can appear as gray-textureless rather than black unless reimported, suggesting lighting settings used by GeomAdd are required for CBackdrop to work properly and would also be why new CBackdrop objects do not work like those in the original levels. No original instances contain other values, just "string Class = "CBackdrop"". Initialized as standard instance (may have different function in-game).

CEntityAttached

Pretty much like a CInstance, but has a "string Target" value, which is the object it is attached to. Beware, if it's tangible and it's colliding with the "parent" object, it will attempt to "free" itself.

CEntityWater

Ripples happen on water entities when objects collide with it. See also CWaterDisturbance.

CGun

See a level for examples..

Other possible values: Kick

Example:

group Pak47drumagazine-00 = {
    string MFlashOrg = "$FAKDFlash-00"
    string MFlashObject0 = "FMFrifleMF03-00"
    string MFlashObject1 = "FMFrifleMF04-00"
    string MFlashObject2 = "FMFrifleMF05-00"
    bool RandomRotate = true
    float MFlashDuration = 0.000000
    bool AutoFire = true
    string Sample = "GUN - AK47 SHOT"
    string RingSample = "GUN - AK47 REL"
    string EmptyClipSample = "GUN - AUTOMATIC DRYFIRE 01"
    string SoundMaterial = "Rifle"
    float WakeUp = 175.000000
    float RecoilForce = 55.000000
    float ROF = 10.000000
    float Push = 230.000000
    float Damage = 15.000000
    float DamageMultiplier = 1.000000
    float Range = 200.000000
    int MaxAmmo = 100
    bool AltAmmoCount = true
    string Class = "CGun"
    bool Tangible = true
    bool Moveable = true
    float Density = 0.080000
    string Type = "Compound"
    string Model00 = "$Fak47drum00-00"
    string Model01 = "$Fak47drum01-00"
    string Detail1 = "$Pak47drumagazineDRC-00"
    float A01 = 30.000000
    string DetailShadow = "$Pak47drumagazineShdw-00"
    string Barrel = "$FAKDbarrel-00"
    string RecoilOrg = "$FAKDrecoil-00"
    float Diffuse = 1.200000
    float Specular = 1.200000
    float SpecularAngle = 37.000000
}

CHitSpang

Is not implemented in executable (no initialization function). However, there seem to be some properties related to it (like SpangCount).

At some point, it was used to make the "hit spangle" effects when a gun's bullet hit different materials, in a way somewhat similar to the muzzle flashes, but apparently, with the addition of particles, it was dropped.

Example:

group FMFHitSpangDefault00-00 = {
    string Class = "CHitSpang"
    bool Shadow = false
    int Normals = 2
    int SpangCount = 8
    float MinScale = 0.100000
    float MaxScale = 0.100000
    float Decay = -300.000000
    float ScaleLimit = 0.400000
}

group FMFHitSpangChips00-00 = {
    string Class = "CHitSpang"
    bool Shadow = false
    int Normals = 2
    int SpangCount = 8
    float MinScale = 0.100000
    float MaxScale = 0.100000
    float Decay = -250.000000
    float ScaleLimit = 0.700000
    string A00 = "Terrain - Gravel"
    string A01 = "Terrain - Wood Loose"
    string A02 = "Terrain - Dirt"
    string A03 = "Log 1"
    string A04 = "Log 2"
}

CInstance

General object in world. See also the trigger actions "CAnimateTextureAction", "CSetPhysicsAction", and "CSubstituteMeshAction".

CJoint

CAnimal (and Anne also) have joints, which have no Class specified, and are named $J<objectname>XX where XX is the joint number (starting at 00). Basic joints have a list A00, A01,... of vertices attached to the joint, the highest value being A199, which means no more than 200 vertices can be attached to the same joint. "Double" joints also have "int Anim00,Anim01" specifying parent joints, and "float Ratio,RotationRatio" specfying an interpolation between the parent joints (Ratio and RotationRatio determining how much the Anim00 bone/joint influences the position and rotation over the Anim01 one). Maybe the default values are 0.5 for an interpolation that goes 50/50 between Anim00 and Anim01?
Looking at the retail:

• Raptors have 21 joints and 6 double joints, interpolated ones are 21, 22, 23, 24, 25, 26
• The para has 21 joints, no double/interpolated ones
• The albertasaur and rexes have 21 joints and 1 double, interpolated one is 21
• The brachi has 29 joints, no double/interpolated ones
• The steg has 30 joints and 2 double joints, interpolated ones are 30 and 31
• The trike has 31 joints and 4 double joints, interpolated ones are 31, 32, 33 and 34

• No CAnimal uses NumDoubleJoints
• Only raptors use interpolated joints, on bone 20 and with these values:

  Anim00 = 22
  Anim01 = 16
  Ratio = 0.500000
  RotationRatio = 0.500000
  

• Only raptors have a NumJoints value of 23, all other bipeds have 21
• All quadrupeds have a NumJoints value of 29

• there were some predefined vertex assignments for certain meshes (for example, 6000 for the "old" Para), new ones use a value of -2 and t-scripts for vertex assignment instead
• the base biped skeleton (indicated by string Type = "Raptor" or "TRex", which are synonyms) has 21 bones/joints
• the base quadruped one (indicated by string Type = "Trike") has 29 bones/joints
• additional bones/joints can be added (yes, I'm being redundant)
• some of the new bones/joints can become double/interpolated, but they don't need to; I guess non-interpolated ones remain "static" relative to the "hip" bone and interpolated ones instead move together with the ones between which they're interpolated

Example:

group $JRaptorB05 = {
    int A00 = 24
    int A01 = 25
}
group $JRaptorB26 = {
    int Anim00 = 7
    int Anim01 = 6
    float Ratio = 0.500000
    float RotationRatio = 0.500000
    int A00 = 0
    int A01 = 1
    int A02 = 2
    int A03 = 15
}

CLightDirectional

Directional light source for the level. Light direction is along the Z axis of the model. Not all levels have this. When missing, apparently Trespasser assigns a default one. Always has "bool Visible = false". See also the trigger action "CSetRendererAction".

Example:

group DLight_JungleRoad = {
  string Class = "CLightDirectional"
  bool Visible = false
}

CMagnet or MasterMagnet

Magnets are used to create rotational joints, slide joints, attach a slave object to a master, and attach master objects to Anne's hand or shoulder. See also the trigger action "CMagnetAction". (Suspected invalid value: "float RestoringForce", only specified once (=2.5) in original levels, not mentioned in exe.)

Possible additional values (but not used in original levels): Delta, Delay, Gender, Magnet, X, Z.

SlaveMagnet

Initialized as standard instance (may have different function in-game).

CSocket

This class shares several properties with CMagnet, but unlike it, CSocket objecs can be visible, tangible and moveable. Not used in original levels.

CMuzzleFlash

Muzzle flashes are used by CGun.MFlashObject0, and are always of the form:

Example:

group FMFrifleMF03-00 = {
  string Class = "CMuzzleFlash"
  bool Unlit = true
  bool Shadow = false
}

CParticles

Particle system definition. See a level for examples. Replaced the older Hit Spang system.

Example:

group EffectDefault = {
    string Class = "CParticles"
    int R = 188
    int G = 188
    int B = 188
    bool Solid = true
    group Min = {
        float Threshold = 0.500000
        float Number = 15.000000
        float Velocity = 0.900000
        float Lifespan = 0.300000
        float Size = 0.003000
        float Length = 0.050000
        float Gravity = 0.050000
        float StuckGravity = 0.000000
        float Spread = 20.000000
    }
    group Max = {
        float Threshold = 1.000000
        float Number = 30.000000
        float Velocity = 1.250000
        float Lifespan = 0.500000
        float Size = 0.007000
        float Length = 0.050000
        float Gravity = 0.050000
        float StuckGravity = 0.000000
        float Spread = 35.000000
    }
    string A00 = "Default"
}

Retail levels have "GravityStuck", which is a typo. Other possible values: Log, Dust.

CSky

The sky object. Always has "bool MipMap = false". See also the trigger action "CSetSkyAction".

Example:

group MySky-00 = {
  string Class = "CSky"
  bool MipMap = false
    // MUST specify false, so sky texture is always loaded
  int SkyFlatColour = 0 // Always 0 in original levels
}

CSubsystem

Recognized by executable, but does not appear to accept any parameters.

CTerrainObj

Can have CInstance values Culling and SoundMaterial. (Also AI, CacheMul and CacheIntersecting, but I'm not sure if Trespasser uses those three). See also the trigger action "CSetTerrainAction".

Example:

group MyTrnobj-00 = {
  string Class = "CTerrainObj"
  int Height = 2
  string SoundMaterial = "Terrain - Cement"
}

CTest

Scans for at least one script entry of each type (int, bool, float, string, and type 2 - presumably "char"). Does not appear to create an explicit instance.

CWaterDisturbance

I assume that if an instance of this is placed by a CEntityWater object it creates some waves. A couple of instances of this class have some other values (like "Visible=false") but I think Trespasser ignores them.

Example:

group WaterDisturb1-00 = {
    string Class = "CWaterDisturbance"
    float Interval = 1.0  // Either 1,2,3 in original levels
    float Strength = 0.1  // Either 0.1,0.2 in original levels
}

Also uses float Radius to indicate the size of the disturbance.

Player

This is Anne, the player in Trespasser. Not much to modify here, just use Anne from an existing level. Note that values in the script refer to Anne as "Player" instead of the instance name "Anne".

Example:

group Anne = {
    string Class = "Player"
    int PVA = -2
    int NumJoints = 20
    int NumDoubleJoints = 2
    int Normals = 2
    int AnimSubMaterial = 8
    string Anim00 = "Anne2_Health_100t2.bmp"
    string Anim01 = "Anne2_Health_90t2.bmp"
    string Anim02 = "Anne2_Health_80t2.bmp"
    string Anim03 = "Anne2_Health_70t2.bmp"
    string Anim04 = "Anne2_Health_60t2.bmp"
    string Anim05 = "Anne2_Health_50t2.bmp"
    string Anim06 = "Anne2_Health_40t2.bmp"
    string Anim07 = "Anne2_Health_30t2.bmp"
    string Anim08 = "Anne2_Health_20t2.bmp"
    string Anim09 = "Anne2_Health_10t2.bmp"
    string Anim10 = "Anne2_Health_deadt2.bmp"
    string A00 = "$Anne_Gun1-00"
    string A01 = "$Anne_Bat-00"
    string A02 = "$Anne_Gun2-00"
    string A03 = "$Anne_Barrett-00"
    string A04 = "$Anne_TranqPistol-00"
    string A05 = "$Anne_Benelli-00"
    string A06 = "$Anne_ButtonFinger-00"
    string A07 = "$Anne_Natural-00"
    string A08 = "$Anne_Rock-00"
    string A09 = "$Anne_Bird-00"
    string A10 = "$Anne_HamRev-00"
    string A11 = "$Anne_KeyCard-00"
    string A12 = "$Anne_HuntRifle-00"
    bool Merge = false
    bool Split = false
    bool Wrap = false
    bool Shadow = false
    string Hand = "$AnneHand"
    string Foot = "$AnneFoot"
    string Body = "$AnneBody"
}

Doesn't need to be called "Anne", Shadow can be set to true and the substitute meshes (A00 to A12) need to exist in order to pick up objects without the level crashing.

Player Settings

Specifies the sounds to use for Anne. Just copy from an existing level if needed.

Example:

group VocalAnneJump = {
    string Class = "Player Settings"
    group JumpUp = {
        string A00 = "ANNEJUMP"
    }
}

group VocalAnneFall = {
    string Class = "Player Settings"
    group Fall = {
        group A00 = {
            float Damage = 0.650000
            string A00 = "ANNEFALLDAMAGE01"
            string A01 = "ANNEFALLDAMAGE02"
            string A02 = "ANNEFALLDAMAGE03"
            string A03 = "ANNEFALLDAMAGE04"
            string A04 = "ANNEFALLDAMAGE05"
        }
        group A01 = {
            float Damage = 0.000000
            string A00 = "ANNEFALLDEATH01"
            string A01 = "ANNEFALLDEATH02"
            string A02 = "ANNEFALLDEATH03"
            string A03 = "ANNEFALLDEATH04"
            string A04 = "ANNEFALLDEATH05"
        }
    }
}

group VocalAnneAmmoPickup = {
    string Class = "Player Settings"
    group AmmoPickup = {
        group AmmoAlmostEmpty = {
            string A00 = "ANNEAMMOAUTO1"
            string A01 = "ANNEAMMOAUTO2"
            string A02 = "ANNEAMMOAUTO3"
        }
        group AmmoHalfFull = {
            string A00 = "ANNEAMMOAUTO4"
            string A01 = "ANNEAMMOAUTO5"
            string A02 = "ANNEAMMOAUTO6"
        }
        group AmmoFull = {
            string A00 = "ANNEAMMOAUTO7"
        }
        group AmmoReallyFull = {
            string A00 = "ANNEAMMOAUTO8"
            string A01 = "ANNEAMMOAUTO9"
        }
        group A00 = {
            string A00 = "ANNEAMMOPHRASE2"
            string A01 = "ANNEAMMOPHRASE1"
        }
        group A01 = {
            string A00 = "ANNEAMMOPHRASE3"
            string A01 = "ANNEAMMOPHRASE4"
        }
        group A02 = {
            string A00 = "ANNEAMMOPHRASE5"
            string A01 = "ANNEAMMOPHRASE6"
        }
        group A03 = {
            string A00 = "ANNEAMMOPHRASE7"
            string A01 = "ANNEAMMOPHRASE8"
        }
        group A04 = {
            string A00 = "ANNEAMMOPHRASE9"
            string A01 = "ANNEAMMOPHRASE10"
        }
        group A05 = {
            string A00 = "ANNEAMMOPHRASE11"
            string A01 = "ANNEAMMOPHRASE12"
        }
        group A06 = {
            string A00 = "ANNEAMMOPHRASE13"
            string A01 = "ANNEAMMOPHRASE14"
        }
        group A07 = {
            string A00 = "ANNEAMMOPHRASE15"
            string A01 = "ANNEAMMOPHRASE16"
        }
        group A08 = {
            string A00 = "ANNEAMMOPHRASE18"
            string A01 = "ANNEAMMOPHRASE19"
        }
        group A09 = {
            string A00 = "ANNEAMMOPHRASE20"
            string A01 = "ANNEAMMOPHRASE21"
        }
        group A10 = {
            string A00 = "ANNEAMMOPHRASE22"
            string A01 = "ANNEAMMOPHRASE23"
        }
        group A11 = {
            string A00 = "ANNEAMMOPHRASE24"
            string A01 = "ANNEAMMOPHRASE25"
        }
        group A12 = {
            string A00 = "ANNEAMMOPHRASE24"
            string A01 = "ANNEAMMOPHRASE25"
        }
        group A13 = {
            string A00 = "ANNEAMMOPHRASE24"
            string A01 = "ANNEAMMOPHRASE25"
        }
        group A14 = {
            string A00 = "ANNEAMMOPHRASE9"
            string A01 = "ANNEAMMOPHRASE10"
        }
        group A15 = {
            string A00 = "ANNEAMMOPHRASE26"
            string A01 = "ANNEAMMOPHRASE27"
        }
        group A16 = {
            string A00 = "ANNEAMMOPHRASE26"
            string A01 = "ANNEAMMOPHRASE27"
        }
        group A17 = {
            string A00 = "ANNEAMMOPHRASE26"
            string A01 = "ANNEAMMOPHRASE27"
        }
        group A20 = {
            string A00 = "ANNEAMMOPHRASE28"
            string A01 = "ANNEAMMOPHRASE29"
        }
        group A30 = {
            string A00 = "ANNEAMMOPHRASE30"
            string A01 = "ANNEAMMOPHRASE31"
        }
    }
}

group VocalAnneAmmoCount = {
    string Class = "Player Settings"
    group Ammo = {
        group A00 = {
            string A00 = "ANNEAMMOPHRASE2"
            string A01 = "ANNEAMMOPHRASE1"
        }
        group A01 = {
            string A00 = "ANNEAMMONUMERAL1A"
            string A01 = "ANNEAMMONUMERAL1B"
            string A02 = "ANNEAMMONUMERAL1C"
        }
        group A02 = {
            string A00 = "ANNEAMMONUMERAL2A"
            string A01 = "ANNEAMMONUMERAL2B"
        }
        group A03 = {
            string A00 = "ANNEAMMONUMERAL3A"
            string A01 = "ANNEAMMONUMERAL3B"
            string A02 = "ANNEAMMONUMERAL3C"
        }
        group A04 = {
            string A00 = "ANNEAMMONUMERAL4A"
            string A01 = "ANNEAMMONUMERAL4B"
        }
        group A05 = {
            string A00 = "ANNEAMMONUMERAL5A"
            string A01 = "ANNEAMMONUMERAL5B"
        }
        group A06 = {
            string A00 = "ANNEAMMONUMERAL6A"
            string A01 = "ANNEAMMONUMERAL6C"
        }
        group A07 = {
            string A00 = "ANNEAMMONUMERAL7A"
            string A01 = "ANNEAMMONUMERAL7B"
            string A02 = "ANNEAMMONUMERAL7C"
        }
        group A08 = {
            string A00 = "ANNEAMMONUMERAL8A"
            string A01 = "ANNEAMMONUMERAL8B"
        }
        group A09 = {
            string A00 = "ANNEAMMONUMERAL9B"
            string A01 = "ANNEAMMONUMERAL9C"
        }
        group A10 = {
            string A00 = "ANNEAMMONUMERAL10A"
            string A01 = "ANNEAMMONUMERAL10B"
        }
        group A12 = {
            string A00 = "ANNEAMMONUMERAL12A"
            string A01 = "ANNEAMMONUMERAL12B"
        }
        group A13 = {
            string A00 = "ANNEAMMONUMERAL13A"
            string A01 = "ANNEAMMONUMERAL13B"
            string A02 = "ANNEAMMONUMERAL13C"
        }
        group A15 = {
            string A00 = "ANNEAMMONUMERAL15A"
            string A01 = "ANNEAMMONUMERAL15B"
            string A02 = "ANNEAMMONUMERAL15C"
        }
        group A17 = {
            string A00 = "ANNEAMMONUMERAL17A"
            string A01 = "ANNEAMMONUMERAL17B"
            string A02 = "ANNEAMMONUMERAL17C"
        }
        group A20 = {
            string A00 = "ANNEAMMONUMERAL20B"
            string A01 = "ANNEAMMONUMERAL20C"
        }
        group A30 = {
            string A00 = "ANNEAMMONUMERAL30A"
            string A01 = "ANNEAMMONUMERAL30B"
            string A02 = "ANNEAMMONUMERAL30C"
        }
        group AmmoAlmostEmpty = {
            string A00 = "ANNEAMMOAUTO1"
            string A01 = "ANNEAMMOAUTO2"
            string A02 = "ANNEAMMOAUTO3"
        }
        group AmmoHalfFull = {
            string A00 = "ANNEAMMOAUTO4"
            string A01 = "ANNEAMMOAUTO5"
            string A02 = "ANNEAMMOAUTO6"
        }
    }
}

group VocalAnneOuch = {
    string Class = "Player Settings"
    group Ouch = {
        group A00 = {
            float Damage = 0.500000
            string A00 = "ANNELIGHTHIT02"
            string A01 = "ANNELIGHTHIT06"
            string A02 = "ANNELIGHTHIT07"
            string A03 = "ANNELIGHTHIT09"
            string A04 = "ANNEEFFORT3"
        }
        group A01 = {
            string A00 = "ANNELIGHTHIT03"
            string A01 = "ANNEEFFORT8"
            string A02 = "ANNELIGHTHIT08"
            string A03 = "ANNEEFFORT1"
            string A04 = "ANNEEFFORT7"
        }
        group A02 = {
            float Damage = 0.000000
            string A00 = "ANNELIGHTHIT05"
            string A01 = "ANNEEFFORT2"
        }
    }
}

Settings

Define the settings for the 16 available AlphaChannels (0-15). You need one Settings object for each channel you want to redefine.

Teleport

Teleport objects are the destinations for the "tnext" cheat. I'm not sure what the order of the teleports is, but most likely the order they're listed in the GRF regiontable. Teleports often contain other CInstance values, but I think Trespasser ignores them.

Example:

group TeleportA = {
    string Class = "Teleport"
}

Marker

Is not implemented in executable. Maybe similar to Teleport?

TerrainPlacement

Specifies the terrain file for the level. (The texture on this object sometimes looks like a render of the terrain objects of the whole level.)

Example:

group TrnPlacement-00 = {
  string Class = "TerrainPlacement"
  string File = "be"
  bool MipMap = false
}

<no Class specified>

If no "Class" value is specified, Trespasser seems to assume it's a CInstance. However, there is one special object which defines a color look up table. The name of the object follows a standard format for all the levels, but I don't know if that format is important. The object contains two groups:

Example:

group Trig_BEGlobalClut-00 = {
  group DefaultClutStartColor = {
    int B = 223
    int G = 237
    int R = 251
  }
  group DefaultClutStopColor = {
    int B = 17
    int G = 20
    int R = 24
  }
}

Apparently, the CLUT defines the range of colors that are rendered in a level.

Other possible values: DefaultClutReflectionColor, ClutStartColor, ClutStopColor, ClutReflectionColor

IGNORE

Recognized by executable, but is then treated as its name implies.

Trigger Classes

Triggers perform one or more actions when certain conditions are met. The base class CBooleanTrigger evaluates a FireExpression monitoring the state of trigger instances. All other trigger classes inherit CBooleanTrigger's values, and have additional contitions to determine when the trigger fires.

Example:

group InsideHouseTigger = {
  string Class = "CLocationTrigger"
  bool PlayerEnterTrigger = true
  int ActionType = 34
  string OverlayText = "You have entered the house"
}

CBooleanTrigger

Trigger fires automatically when FireExpression evaluates to true. Evaluate Now function returns the current value of the expression.

CCollisionTrigger

Trigger fires when two objects collide. Evaluate Now function will return false.

CCreatureTrigger

Trigger fires when a Anne or a CAnimal dies, wakes, or sleeps. Evaluate Now function only works with CreatureDie.

Example:

group CreatureDie-00 = {
  string Class = "CCreatureTrigger"
  string A00 = "RaptorB-300"
  bool CreatureDie = true
  int ActionType = 34
  string OverlayText = "Raptor died"
}

Probable additional values (but not used in original levels): CreatureWake, CreatureSleep, CreatureCriticalDamage, CreatureDamagePoints.

CLocationTrigger

Trigger fires when Anne or an object enters/is in/leaves a certain area. Evaluate Now function first checks the TriggerActivate string, then the other flags and returns the current state.

Probable additional values (but not used in original levels): CreatureEnterTrigger, CreatureInTrigger, CreatureLeaveTrigger, CreatureEnterCount, CreatureLeaveCount.

CMoreMassTrigger

Will compare mass of objects inside trigger to specified mass. Trigger never fires. Returns true if mass is higher than specified value, false if not. Evaluate Now function returns current value.

Not used in any original levels (possibly meant for Lab capacitor puzzle).

CObjectTrigger

Fires when an object is picked up, put down, or "used" (eg. by pressing spacebar).

CSequenceTrigger

Fires when a sequence of things happen. See 'lab' level for some examples.

Eg. If there are 5 SequenceOrderNames, the trigger waits until 5 triggers from the SequenceListenNames list have fired. Or if any trigger in the SequenceEvalNowNames list fires, the sequence is evaluated immediately. Then, if the order they fired matches the order listed in SequenceOrderNames, the trigger fires. If the order does not match, SequenceFalseTriggerName fires.

Example:

group TrigKeypadSequence = {
    string Class = "CSequenceTrigger"
    group SequenceListenNames = {
        string A00 = "TrigButtonBeepLoc-00"
        string A01 = "TrigButtonBeepLoc-01"
        string A02 = "TrigButtonBeepLoc-02"
        string A03 = "TrigButtonBeepLoc-03"
        string A04 = "TrigButtonBeepLoc-04"
        string A05 = "TrigButtonBeepLoc-05"
        string A06 = "TrigButtonBeepLoc-06"
        string A07 = "TrigButtonBeepLoc-07"
        string A08 = "TrigButtonBeepLoc-08"
        string A09 = "TrigButtonBeepLoc-09"
    }
    string SequenceFalseTriggerName = "TrigBadKeyCode"
    group SequenceOrderNames = {
        string A00 = "TrigButtonBeepLoc-05"
        string A01 = "TrigButtonBeepLoc-02"
        string A02 = "TrigButtonBeepLoc-06"
        string A03 = "TrigButtonBeepLoc-03"
        string A04 = "TrigButtonBeepLoc-02"
        string A05 = "TrigButtonBeepLoc-07"
    }
    int FireCount = 1
    int ActionType = 23
    string Sample = "Spec-Keypad Confirmation01"
    int BoundVol = 1
}

CStartTrigger

Trigger fires once when level starts.

CTimerTrigger

Apparently, the trigger fires on the transition from Low to High. Evaluate Now function returns the current state of the trigger.

CVariableTrigger

I don't think this trigger ever fires, it's just a "boolean variable" that can be controlled by the script (using CSetVariableTriggerAction), and can be used in other triggers' FireExpression. Eavlauate Now function returns current state of the trigger.

Example:

group MyBooleanVariable-00 = {
  string Class = "CVariableTrigger"
  bool Value = true // Initial state
}

Trigger Actions

Actions that can happen when a trigger fires.

The type of action is specified in the ActionType value of a trigger. If there is only one action for a trigger, the ActionType and the action's values can simply be added into the trigger group:

group SimpleActionTrigger = {
  string Class = "CStartTrigger"
  int ActionType = 34
  string OverlayText = "This trigger just displays some text."
}

If there is more than one action, the actions are specified as ActionXX groups, each containing one ActionType, and that action's values. The trigger may also contain a ProcessStyle value to specify how the multiple actions are to be executed:

group MultipleActionTrigger = {
  string Class = "CStartTrigger"
  int ProcessStyle = 3
  group Action00 = {
    int ActionType = 0
    string Sample = "VA01"
  }
  group Action01 = {
    int ActionType = 25
    float Delay = 4.0
  }
  group Action02 = {
    int ActionType = 34
    string OverlayText = "This trigger plays a sound, waits 4 seconds,
                          then displays this text."
  }
}

Some action types were not used in the original levels and their usage is unknown: 3, 4, 8, 12, 14, 15, 26, 30, 32, 33.

ActionType 0 = "CVoiceOverAction"

Play voiceover (from "Stream.tpa"). I think volumes are specified in Decibels (dB), in which case -3 = half volume.
There is a difference between ActionType 0 and 2. 0 is known as "CVoiceOverAction" and 2 is known as "CMusicAction". All voiceovers and music are located in the Stream.tpa file (or your ATX additive file). Only 1 sound out of any called to play using AT 0 will play at one time, and only 1 sound out of any called to play using AT 2 will play at one time. However, a sound from AT 0 and AT 2 may play at the same time. If a sound from Stream.tpa is playing via AT 2 while one from AT 0 is playing, the sound from AT 0 is dominant - the volume of the AT 2 sound is automatically lowered and the AT 0 sound plays over it. This is how you get voiceovers to play while music is going. As far as I know, any sounds from Effects.tpa will play on top of each other, since in some cases many collisions and dinosaur sounds must be played immediately once they are called on.

Possible additional values (but not used in original levels): Attach, BoundaryVolume, LoopCount, MaximumDistance, OutsideVolume, Mute, Frustum, Emitter, StopAfterFade, VolumeFader.

ActionType 1 = "CAmbientAction"

Play ambient sound (from "Ambient.tpa").

Possible additional values (but not used in original levels): Attach, BoundaryVolume, LoopCount, MaximumDistance, OutsideVolume, Mute, Frustum, Emitter, StopAfterFade, VolumeFader.

ActionType 2 = "CMusicAction"

Play music (from "Stream.tpa").

Possible additional values (but not used in original levels): Attach, BoundaryVolume, LoopCount, MaximumDistance, OutsideVolume, Mute, Frustum, Emitter, StopAfterFade, VolumeFader.

ActionType 3 = "CFadeMusicAction"

Fade music (from "Stream.tpa").

ActionType 4 = "CShowOverlayAction"

Overlay bitmap on screen.

ActionType 5 = "CSetFogAction"

Set fog parameters. See also the trigger action "CSetSkyAction".

ActionType 6 = "CSetRendererAction"

Set renderer parameters.

Possible additional values (not used in original levels): AltSubdivisionLen, AltPixelError, SubdivisionLen, PixelError, NoLowRes, SoftwareOnly, HardwareOnly, Priority, CullMaxRadiusShadow, CullMaxDistShadow, CullMaxRadius, CullMaxDist, ShadowCulling, Culling.

ActionType 7 = "CSetTerrainAction"

Set terrain renderer parameters.

ActionType 8 = "CSetImageCacheAction"

Set image cache parameters.

ActionType 9 = "CSetAIAction"

Modify dinosaur behaviour.

The various other AI emotions from CAnimal can also be set. Eg. Anger, Hunger etc.

ActionType 10 = "CSetPhysicsAction"

Freeze, set velocity, or apply push to an object.

ActionType 11 = "CSubstituteMeshAction"

Change mesh used by object.

ActionType 12 = "CSetSortAction"

Depth sort settings.

ActionType 13 = "CSetSkyAction"

Set parameters of the sky. See also the trigger action "CSetFogAction".

Values that were never used in the original levels: probably ScaleLimit, MinScale, MaxScale, FillScreen.

ActionType 14 = "CSetAlphaWaterAction"

Define water properties.

Example:

group SomeTrigger { ; (trigger class start)

string Class = "SomeTriggerType"
...
int ActionType = 14
...
group AlphaWaterProperties {
group A00 {
int R = ?
int G = ?
int B = ?
float Alpha = ?
}
group A01 {
int R = ?
int G = ?
int B = ?
float Alpha = ?
}
(same for group A02, A03, etc.)
}
...
group NonAlphaWaterProperties {
group A00 {
int R = ?
int G = ?
int B = ?
float Alpha = ?
}
group A01 {
int R = ?
int G = ?
int B = ?
float Alpha = ?
}
(same for group A02, A03, etc.)
}
...
} ;(trigger class end)

ActionType 15 = "CWaterOnOffAction"

ActionType 16 = "CLoadLevelAction"

Load a level.

ActionType 17 = "CSetAnimatePropertiesAction"

Modify health and other values of Anne and dinosaurs.

ActionType 18 = "CTeleportAction"

Move object.

Values that were never used in the original levels: possibly OnTerrain.

ActionType 19 = "CSaveLevelAction"

Creates a new savegame (eg. "Savegame.000") in the Trespasser directory. Doesn't include a thumbnail though, so it's more like a .scn file than a savegame.

(This action was not used in the original levels.)

ActionType 20 = "CMagnetAction"

Change the parameters of a magnet attached to an object. Probably can use any values from CMagnet (@test). Original levels set the following CMagnet values: Drive, Enable, Friction, MasterObject, Target, ZFree. MasterObject is required. A couple of triggers also set a "string Target" value, probably a typo.

ActionType 21 = "CAnimateTextureAction"

Set animated texture parameters.

Values that were never used in the original levels: possibly Toggle.

ActionType 22 = "CHideShowAction"

Set visible/hidden state of object.

If an object is initially set to bool Visible = false in its t-script, ActionType 22 can't make it visible. The way around this is to make it bool Visible = true and se a start trigger with ActionType 22 to make it invisible as soon as the level loads, and later use another trigger with ActionType 22 to make it visible again when you need to.

ActionType 23 = "CSoundEffectAction"

Play effect sound (from "Effects.tpa"). Similar to action "CAmbientAction" but can attach to (move with) an object.

ActionType 24 = "CWakeAIAction"

Wake up dinos or put them to sleep. It's only used once in original levels, in a trigger with name "TrigWakeupA-00".

ActionType 25 = "CDelayAction"

Delay before moving to next action.

ActionType = 26 "CScriptedAnimationAction"

Not used in original levels. This action animates objects and/or the camera. See the Animation Scripts section for details of the script format.

group Trig_Start2-00 = {
  string Class = "CStartTrigger"
  int FireCount = 1
  int ActionType = 26
  string AnimationName = "test" 
}

ActionType 27 = "CSetVariableTriggerAction"

Set (boolean) variable trigger state.

ActionType 28 = "CSetHintAction"

ActionType 29 = "CAudioEnvironmentAction"

Set EAX environmental audio parameters. Eg. Set default parameters in a CStartTrigger, and then in CLocationTriggers to give different areas special effects. Remember to set the defaults again when player leaves the area.

The following table lists Creative EAX 1.0's 26 environment presets as used by Trespasser and their default values:

ActionType 30 = "CSubstituteAIAction"

Change AI used by object.

ActionType 31 = "CEndGameAction"

End game and play 'win' movie. No other values for this action.

ActionType 32 = "CControlPlayerAction"

Make player perform an action.

ActionType 33 = "CAISystemAction"

Can be used to enable/disable AI options. Affects all AIs.

ActionType 34 = "CTextAction"

Display text at top of screen.

Values that were never used in the original levels: TextDisplayTime, TextPosition (and possibly ResourceID, TextAtTop).

ActionType 35 = "CWaterDisturbanceAction"

Activate CWaterDisturbance object.

Animation Scripts

Animation scripts were not used in any of the original levels - I've had to determine the format myself.

An animation script is used to animate object and camera movements, and is used by trigger action CScriptedAnimationAction. File extensions are ".asb" for binary format, or ".asa" for ASCII format.

ASCII Animation Script (.asa)
Binary Animation Script (.asb)

•  ASCII scripts (.asa extension) must be placed in "<data drive>\data\anim\". Binary scripts (.asb extension) must be in "<data drive>\data\". Trespasser tries to load the binary file first. If it's not found, it loads the ASCII file, and saves a binary version in the data directory (which in future is used in preference to the ASCII version).
• Note that shadows of moving objects are not updated. I haven't found a workaround for this.

ASCII Animation Script (.asa)

I'll continue the example from the CScriptedAnimationAction section, then describe the script keywords.

version 1

object Box-00

frame 0
pos 0 5 3
rot 0 0 0 1
scale 1

frame 3.5
pos 5.5 3 3
rot 0 0 1 0
scale 1

end_object

If there's a syntax error in the file, anything from that point on is ignored. If the file is not found, the trigger does nothing.

version <number>

forced_rate <number>

object <name>

frame <time>

pos <X> <Y> <Z>	

rot <X> <Y> <Z> <W>

scale <S>

object Camera

Binary Animation Script (.asb)

Trespasser loads these (from the data directory) in preference to a .asa file, and they should be used when a level is released. An .asb file is created automatically in the data directory the first time a .asa file is loaded.

Page researched and created by Andres, with additional research by Rebel, BigRed, Draconisaurus, chronzerg and machf.