Scenery Entry INI config (Config pack)
Jump to navigation
Jump to search
scene-*.ini - the settings file which declares single entry of scenery object types. When this file is a part of config pack, almost all parameters are required. The default location of theese files is specifying in the main wld_scenery.ini file by "config-dir" field of "[scenery-main]" section.
When this file is created inside level or episode, all parameters are optional: the role of episode/world side configuration is overriding of default properties are declared on a side of config pack.
| [ scenery ] | |||
|---|---|---|---|
| Parameter | Allowed values | Example value | Description |
| group | string | group = "Common sceneries" | Name of organizing group (reserved) |
| category | string | category = "City" | Name of organizing category (reserved) |
| description | string | description = "It's my car" | A short description about this element. |
| extra-settings | string | extra-settings = "mylayout.json" | Filename of GUI layout for extra settings if they are needed for this element. |
| is-meta-object | boolean | is-meta-object = false | Make this element be meta-object: It will be hidden on exported images/screeshots in dependence from a choice. |
| image | string | image = scene-1.gif | Filename of scenery picture |
| grid | >=1 | grid = 32 | Size of align grid |
| animated | [0,1] | animated = 0 | Enable sprite animation for this tile |
| frames | >=1 | frames = 1 | Total number of frames on sprite |
| frame-delay | >=1 | frame-delay = 128 | Delay between animation frames in milliseconds |
| frame-speed | >=1 | frame-speed = 128 | Alias to frame-delay |
| framespeed | >=1 | framespeed = 8 | Delay between animation frames in 1/65 seconds |
| display-frame | >=0 | display-frame = 0 | Default frame index for disabled animation mode in the editor |
| frame-sequence | string, sequence of integers | frame-sequence = "1,3,2,0" | Initial custom animation frames sequence (first frame is 0, last is n-1). Empty string is usage of default sequence. |