Skip to content
Features

Completion and hover

Suggestions for classes, attributes, values, units and files, and descriptions on hover.

Suggestions appear as you type. Press Control plus Space to open them at any time. They come from the schema database, which lists every class of the game with the attributes the game itself reads.

Class names

At the start of a unit, the list shows every class. Documented classes come first, then the ones the game uses most, so the class you need is usually near the top. A documented class shows its description next to the list.

Attribute keys

Inside a unit, the list shows the attributes of its class, with their type. Attributes the game no longer uses, and those it manages itself, aren't suggested.

This works in a .sui fragment too: it gets the attributes of the unit that includes it.

Values

After the : of an attribute, the list depends on what the attribute takes.

Fixed values

For an attribute with a fixed set of values, the list shows them all, and the default one is marked:

The value is written without quotes. If you typed a quote first, the quotes are kept.

Units

For an attribute that points to a unit (such as animation in a chassis, which takes a vehicle_animation_data), the list shows the units of the right class: the ones in the same file first, then the ones in the rest of your mod, and null.

A unit of a subclass counts too: an attribute that takes a sign_template_item also lists your sign_template_text units.

Files

For an attribute that takes a file, such as model (a .pmd) or shadow_texture (a .tobj), type "/ and the list shows your mod's folders and only the files of the right type:

In this folder collision would list only the .pmc files, and animation only the .pma ones.

The game's own files aren't listed: the extension doesn't read the game's archives.

Sound events

After a sound bank and its # (scene_music: "/sound/music/scene.bank#), the list shows the bank's events. They come from the .bank.guids file FMOD Studio writes next to the bank, so this works for your mod's own banks: the game's are inside its archives.

@include paths

Type @include " and the list shows the folders and .sui files next to the current file. Start with / to list from your mod's root instead. This works even with completion turned off, since it doesn't need the schema database.

If your mod is split into base/ and dlc_* folders, the list joins the same folder of all of them, as the game does.

Hover

Point at a class name or an attribute key to see what it is: its type, its default value, the values it accepts and its description. Hover also warns about an attribute that has no effect any more (the game still accepts it but ignores it), or one the game manages itself and you shouldn't set.

Most classes of the game have no description yet. The database is a community effort; for those, hover says so and shows the type only.