Lvl bgo.ini (Config pack)

From PGE Wiki
Jump to navigation Jump to search

lvl_bgo.ini - Definition of background objects for levels.

[ background-main ]
Parameter Allowed values Example value Description
total >=1 total = 190 Allocate number of BGO-ID's to define background objects
grid >=1 grid = 32 Default alignment grid size for all BGOs without defined "grid" field.
config-dir string config-dir = "items/bgo" Enables split config mode (using a set of background-*.ini files in the specified directory instead finding sections in the same INI-file)
extra-settings string extra-settings = "items/bgo" 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 background-*.ini config file, section name is always background.

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

[ background-* ]
Parameter Allowed values Example value Description
name string name = "Some bush" Title of background object
group string group = "Plants" Group where included this background object
category string category = "Bushes" Category where included this background object
description string description = "A nice green decoration" 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.
grid >=1 grid = 32 Size of grid snapping
z-layer string z-layer = background Default Z-Order layer of background object:
z-offset floating z-offset = 0 Z-Order offset relative to default Z-Order
z-value floating z-value = 0 Set absolute Z-value
grid-offset-x integer grid-offset-x = 0 Grid offset X
grid-offset-y integer grid-offset-y = 0 Grid offset Y
offset-x integer offset-x = 0 Alias to "grid-offset-x", Deprecated.
offset-y integer offset-y = 0 Alias to "grid-offset-y, Deprecated.
image string image = "background-45.png" Image filename
climbing [0,1] climbing = 0 Allow playable character climb up on contact with background object
animated [0,1] animated = 0 Enable vertical sprite animation of background object
frames >=1 frames = 5 Number of available frames for this background object
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 static frame in the editor with disabled animation
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.
smbx64-sort-priority integer smbx64-sort-priority = 44 The array sorting order for SMBX64 LVL files.
view string view = background Alias to "z-layer" field
priority floating priority = 0 Alias to "z-value" field