Wld scenery.ini (Config pack)

From PGE Wiki
Jump to navigation Jump to search

wld_scenery.ini - Definition of sceneries for world maps.

[ scenery-main ]
Parameter Allowed values Example value Description
total >=1 total = 32 Allocate SCENERY-ID's to define sceneries.
grid >=1 grid = 32 Default alignment grid size for all scemeries without defined "grid" field.
config-dir string config-dir = "items/scenery" Enables split config mode (using a set of scenery-*.ini files in the specified directory instead finding sections in the same INI-file)
extra-settings string extra-settings = "items/scenery" Relative path to folder where are extra settings JSON layouts are stored. If the field didn't define, the value of `config-dir` will be used. When it's also empty too, extra settings will not work.

Note: in the split mode or in the custom level/episode scene-*.ini config file, section name is always scenery.

Settings of each scenery (Where '*' - should be a SCENERY-ID from 1 to total number of sceneries)
You should define settings for all allocated SCENERY-ID range!

[ 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.