Reference: Scenery File Format

Purpose

Describes the format of the scenery tile files. These files are present in the Scenery and Grove folders, further arranged into subfolders for each specific Zone ID.

The tile files themselves have a naming convention of x000y000.txt or similar. Tile coordinates are calculated by dividing a scenery object's X and Z coordinates by the ZoneDef PageSize.

File Format

INI format. Most lines interpreted as a key=value pair, but are also delimited by commas (,)
Comment character: semicolon (;)
Uses object entry headers.

Block Format

Standard Properties

Property Type Description
[ENTRY] Begins a new prop.
ID Integer Prop ID. Must be unique.
Asset String Asset name. Fixed-length string, cannot exceed 128 characters.
Name String Arbitrary name. Not used. Fixed-length string, cannot exceed 32 characters.
Pos Float (x3) Three floats, separated by commas (X,Y,Z). This represents the position of the prop in the game world.
Orient Float (x4) Four floats, separated by commas (X,Y,Z,W). This represents the prop's rotation in the game world, using a Quaternion (coordinates based on 3D vector math, calculated by the client)
Scale Float (x3) Three floats, separated by commas (X,Y,Z). This represents the prop's scale along each axis. All three values will usually be identical unless custom modified.
Flags Integer Bit flags. Combine flags for multiple effects. These are managed by the client when editing props. Possible flags:

1 : LOCKED (Cannot be selected)
2 : PRIMARY (Loading queue priority)

Layer Integer Can be arbitrarily set. Not used.
patrolSpeed Integer Not used.
patrolEvent String Not used. Fixed-length string, cannot exceed 3 characters.
links_count Integer Number of linked scenery to expect.
link Integer,Integer Two integers, separated by commas. The first is the Prop ID to link. The second is the link type (0=standard, 1=patrol). A maximum of 11 props may be linked.

SpawnPoint Properties

Only apply to SpawnPoint entities.

spawnName String Arbitrary name of the prop. Limited to 48 characters.
leaseTime Integer Original purpose is unknown. If set, indicates that a spawn will be created as dead, then disappear after a certain amount of time. This time is expressed in milliseconds.
spawnPackage String Sets the spawn package. See SpawnPackages for more info. The package name is limited to 56 characters.
mobTotal Integer Original purpose is unknown. Not used.
maxActive Integer Original purpose is unknown. The maximum number of creatures that may be spawned at any one time. Defaults to 1.
aiModule String Original purpose is unknown. Allows a custom override of a spawned creature's AI script. See the Creature ai_package property (not ai_module). The AI script must exist. See the AIScript Folder and Script List file for a list of available scripts, and how to write new ones.
maxLeash Integer Maximum distance that a spawn can stray from its SpawnPoint before it is forced to return. Also known as tether range. Distance is expressed in game units, where 10 units = 1 meter. Defaults to 500.
loyaltyRadius Integer When a creature is attacked, all nearby creatures within this range will pull aggro as well. Distance is expressed in game units, where 10 units = 1 meter. Defaults to zero (no loyalty).
wanderRadius Integer Idle creatures that do not have linked path nodes for patrols will stray randomly around their spawnpoint, up to this distance. This is box distance. Distance is expressed in game units, where 10 units = 1 meter. Defaults to zero (no wandering).
despawnTime Integer This is used as the re-spawn time, in seconds.
sequential Bool If nonzero, this spawn will notify the instance script when it is killed.
spawnLayer String[48] Unused. Original purpose unknown.
sceneryName String[38] Unused. Arbitrary name? Original purpose unknown.
innerRadius Integer Distance. 10 units = 1 meter. Minimum spawn distance from the SpawnPoint. Together with outerRadius it can be used to create a circular area in which to spawn. This can be used to spawn objects around the base of trees or rocks, but not inside of them.
outerRadius Integer Distance. 10 units = 1 meter. Maximum spawn distance away from the SpawnPoint.

Legacy Properties

Provided for compatibility with old file formats only. Should not be used.

props_count Integer Do not use. Legacy scenery format.
property String,Integer,String Do not use. Legacy scenery format. Sets an arbitrary named property. The first string is an arbitrary property name. The integer corresponds to an expected way to interpret the value (0 = integer, 1 = float, 2 = string, 3 = scenery (alias for integer)). The last string is the value. A maximum of 3 of these properties may be assigned.
Facing Byte Obsolete. Now uses the SpawnPoint's prop rotation instead. The directional angle that a creature will be facing when it is spawned. A value of 0 to 255, corresponding to 360 degree rotation.
PX
PY
PZ
Float Obsolete. Now uses Pos instead. Sets the value of a particular axis world location.
QX
QY
QZ
QW
Float Obsolete. Now uses Orient instead. Sets the value of a particular axis Quaternion rotation.
SX
SY
SZ
Float Obsolete. Now uses Scale instead. Sets the value of a particular axis scale.