PGE Engine
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Macros Pages
Public Types | Public Attributes | List of all members
LevelBGO Struct Reference

Level specific Background object entry structure. Defines preferences of each Background object. More...

#include <lvl_filedata.h>

Public Types

enum  zmodes {
  Background2 =-2, Background1 =-1, ZDefault =0, Foreground1 =1,
  Foreground2 =2
}
 Z order Modes of background objects. More...
 

Public Attributes

long x
 X position of Background Object.
 
long y
 Y position of Background Object.
 
unsigned long id
 ID of background object type defined in the lvl_bgo.ini.
 
PGESTRING layer
 Name of a parent layer. Default value is "Default".
 
int z_mode
 Z-Mode of displaying of BGO.
 
double z_offset
 Z-Offset relative to current of Z-value.
 
long smbx64_sp
 
long smbx64_sp_apply
 Automatically calculated value of SMBX64 Order priority.
 
unsigned int array_id
 Array-ID is an unique key value identificates each unique block object. Re-counts on each file reloading.
 
unsigned int index
 Recent array index where block was saved (used to speed-up settings synchronization)
 

Detailed Description

Level specific Background object entry structure. Defines preferences of each Background object.

Member Enumeration Documentation

Z order Modes of background objects.

Enumerator
Background2 

Background-2 (under sizable blocks)

Background1 

Background-1 (over sizable blocks, under regular blocks)

ZDefault 

Use config default Z-Mode (which defined in the lvl_bgo.ini)

Foreground1 

Foreground-1 (over regular blocks, but under lava blocks and foreground NPC's)

Foreground2 

Foreground-2 (over everything)

Member Data Documentation

long LevelBGO::smbx64_sp

SMBX64 Order priority. Defines priority for ordering of entries in array of BGO's before writing into a SMBX-lvl file. \ -1 - use system default order priority


The documentation for this struct was generated from the following file: