Enumerations used in system interfaces.
enum ESubsystem { ESubsys_3DEngine = 0, ESubsys_AI = 1, ESubsys_Physics = 2, ESubsys_Renderer = 3, ESubsys_Script = 4 };
ISystem.h
enum ESystemConfigSpec { CONFIG_CUSTOM = 0, CONFIG_LOW_SPEC = 1, CONFIG_MEDIUM_SPEC = 2, CONFIG_HIGH_SPEC = 3, CONFIG_VERYHIGH_SPEC = 4, CONFIG_DURANGO = 5, CONFIG_ORBIS = 6, CONFIG_DETAIL_SPEC = 7, END_CONFIG_SPEC_ENUM };
ISystem.h
|
Members |
Description |
|
CONFIG_CUSTOM = 0 |
should always be first |
|
CONFIG_DETAIL_SPEC = 7 |
Specialized detail config setting. |
|
END_CONFIG_SPEC_ENUM |
MUST BE LSAT VALUE. USED FOR ERROR CHECKING. |
Configuration specification, depends on user selected machine specification.
System wide events.
enum ESystemEvent { ESYSTEM_EVENT_RANDOM_SEED = 1, ESYSTEM_EVENT_RANDOM_ENABLE, ESYSTEM_EVENT_RANDOM_DISABLE, ESYSTEM_EVENT_CHANGE_FOCUS = 10, ESYSTEM_EVENT_MOVE = 11, ESYSTEM_EVENT_RESIZE = 12, ESYSTEM_EVENT_ACTIVATE = 13, ESYSTEM_EVENT_POS_CHANGED = 14, ESYSTEM_EVENT_STYLE_CHANGED = 15, ESYSTEM_EVENT_LEVEL_LOAD_START_PRELOADINGSCREEN, ESYSTEM_EVENT_LEVEL_LOAD_RESUME_GAME, ESYSTEM_EVENT_LEVEL_LOAD_PREPARE, ESYSTEM_EVENT_LEVEL_LOAD_START_LOADINGSCREEN, ESYSTEM_EVENT_LEVEL_LOAD_LOADINGSCREEN_ACTIVE, ESYSTEM_EVENT_LEVEL_LOAD_START, ESYSTEM_EVENT_LEVEL_LOAD_END, ESYSTEM_EVENT_LEVEL_LOAD_ERROR, ESYSTEM_EVENT_LEVEL_NOT_READY, ESYSTEM_EVENT_LEVEL_PRECACHE_START, ESYSTEM_EVENT_LEVEL_PRECACHE_FIRST_FRAME, ESYSTEM_EVENT_LEVEL_GAMEPLAY_START, ESYSTEM_EVENT_LEVEL_UNLOAD, ESYSTEM_EVENT_LEVEL_POST_UNLOAD, ESYSTEM_EVENT_GAME_POST_INIT, ESYSTEM_EVENT_GAME_POST_INIT_DONE, ESYSTEM_EVENT_SHUTDOWN, ESYSTEM_EVENT_LANGUAGE_CHANGE, ESYSTEM_EVENT_TOGGLE_FULLSCREEN, ESYSTEM_EVENT_SHARE_SHADER_COMBINATIONS, ESYSTEM_EVENT_3D_POST_RENDERING_START, ESYSTEM_EVENT_3D_POST_RENDERING_END, ESYSTEM_EVENT_SWITCHING_TO_LEVEL_HEAP, ESYSTEM_EVENT_SWITCHED_TO_LEVEL_HEAP, ESYSTEM_EVENT_SWITCHING_TO_GLOBAL_HEAP, ESYSTEM_EVENT_SWITCHED_TO_GLOBAL_HEAP, ESYSTEM_EVENT_LEVEL_PRECACHE_END, ESYSTEM_EVENT_GAME_MODE_SWITCH_START, ESYSTEM_EVENT_GAME_MODE_SWITCH_END, ESYSTEM_EVENT_VIDEO, ESYSTEM_EVENT_GAME_PAUSED, ESYSTEM_EVENT_GAME_RESUMED, ESYSTEM_EVENT_TIME_OF_DAY_SET, ESYSTEM_EVENT_EDITOR_ON_INIT, ESYSTEM_EVENT_FRONTEND_INITIALISED, ESYSTEM_EVENT_EDITOR_GAME_MODE_CHANGED, ESYSTEM_EVENT_EDITOR_SIMULATION_MODE_CHANGED, ESYSTEM_EVENT_FRONTEND_RELOADED, ESYSTEM_EVENT_SW_FORCE_LOAD_START, ESYSTEM_EVENT_SW_FORCE_LOAD_END, ESYSTEM_EVENT_SW_SHIFT_WORLD, ESYSTEM_EVENT_STREAMING_INSTALL_ERROR, ESYSTEM_EVENT_USER = 0x1000 };
ISystem.h
|
Members |
Description |
|
ESYSTEM_EVENT_RANDOM_SEED = 1 |
Seeds all random number generators to the same seed number, WParam will hold seed value. |
|
ESYSTEM_EVENT_CHANGE_FOCUS = 10 |
Changes to main window focus. wparam is not 0 is focused, 0 if not focused |
|
ESYSTEM_EVENT_MOVE = 11 |
Moves of the main window. wparam=x, lparam=y |
|
ESYSTEM_EVENT_RESIZE = 12 |
Resizes of the main window. wparam=width, lparam=height |
|
ESYSTEM_EVENT_ACTIVATE = 13 |
Activation of the main window. wparam=1/0, 1=active 0=inactive |
|
ESYSTEM_EVENT_POS_CHANGED = 14 |
Main window position changed. |
|
ESYSTEM_EVENT_STYLE_CHANGED = 15 |
Main window style changed. |
|
ESYSTEM_EVENT_LEVEL_LOAD_START_PRELOADINGSCREEN |
Sent before the loading movie is begun |
|
ESYSTEM_EVENT_LEVEL_LOAD_RESUME_GAME |
Sent before the loading last save |
|
ESYSTEM_EVENT_LEVEL_LOAD_PREPARE |
Sent before starting level, before game rules initialization and before ESYSTEM_EVENT_LEVEL_LOAD_START event Used mostly for level loading profiling |
|
ESYSTEM_EVENT_LEVEL_LOAD_START_LOADINGSCREEN |
Sent to start the active loading screen rendering. |
|
ESYSTEM_EVENT_LEVEL_LOAD_LOADINGSCREEN_ACTIVE |
Sent when loading screen is active |
|
ESYSTEM_EVENT_LEVEL_LOAD_START |
Sent before starting loading a new level. Used for a more efficient resource management. |
|
ESYSTEM_EVENT_LEVEL_LOAD_END |
Sent after loading a level finished. Used for a more efficient resource management. |
|
ESYSTEM_EVENT_LEVEL_LOAD_ERROR |
Sent after trying to load a level failed. Used for resetting the front end. |
|
ESYSTEM_EVENT_LEVEL_NOT_READY |
Sent in case the level was requested to load, but it's not ready Used in streaming install scenario for notifying the front end. |
|
ESYSTEM_EVENT_LEVEL_PRECACHE_START |
Sent after precaching of the streaming system has been done |
|
ESYSTEM_EVENT_LEVEL_PRECACHE_FIRST_FRAME |
Sent before object/texture precache stream requests are submitted |
|
ESYSTEM_EVENT_LEVEL_GAMEPLAY_START |
Sent when level loading is completely finished with no more onscreen movie or info rendering, and when actual gameplay can start |
|
ESYSTEM_EVENT_LEVEL_UNLOAD |
Level is unloading. |
|
ESYSTEM_EVENT_LEVEL_POST_UNLOAD |
Sent after level have been unloaded. For cleanup code. |
|
ESYSTEM_EVENT_GAME_POST_INIT |
Called when the game framework has been initialized. |
|
ESYSTEM_EVENT_GAME_POST_INIT_DONE |
Called when the game framework has been initialized, not loading should happen in this event. |
|
ESYSTEM_EVENT_SHUTDOWN |
Sent when system is shutting down. |
|
ESYSTEM_EVENT_LANGUAGE_CHANGE |
When keyboard layout changed. |
|
ESYSTEM_EVENT_TOGGLE_FULLSCREEN |
Toggled fullscreen. wparam is 1 means we switched to fullscreen, 0 if for windowed |
|
ESYSTEM_EVENT_3D_POST_RENDERING_START |
Start 3D post rendering |
|
ESYSTEM_EVENT_3D_POST_RENDERING_END |
End 3D post rendering |
|
ESYSTEM_EVENT_SWITCHING_TO_LEVEL_HEAP |
Called before switching to level memory heap |
|
ESYSTEM_EVENT_SWITCHED_TO_LEVEL_HEAP |
Called after switching to level memory heap |
|
ESYSTEM_EVENT_SWITCHING_TO_GLOBAL_HEAP |
Called before switching to global memory heap |
|
ESYSTEM_EVENT_SWITCHED_TO_GLOBAL_HEAP |
Called after switching to global memory heap |
|
ESYSTEM_EVENT_LEVEL_PRECACHE_END |
Sent after precaching of the streaming system has been done |
|
ESYSTEM_EVENT_GAME_MODE_SWITCH_START |
Sent when game mode switch begins |
|
ESYSTEM_EVENT_GAME_MODE_SWITCH_END |
Sent when game mode switch ends |
|
ESYSTEM_EVENT_VIDEO |
Video notifications wparam=[0/1/2/3] : [stop/play/pause/resume] |
|
ESYSTEM_EVENT_GAME_PAUSED |
Sent if the game is paused |
|
ESYSTEM_EVENT_GAME_RESUMED |
Sent if the game is resumed |
|
ESYSTEM_EVENT_TIME_OF_DAY_SET |
Sent when time of day is set |
|
ESYSTEM_EVENT_EDITOR_ON_INIT |
Sent once the Editor finished initialization. |
|
ESYSTEM_EVENT_FRONTEND_INITIALISED |
Sent when frontend is initialised |
|
ESYSTEM_EVENT_EDITOR_GAME_MODE_CHANGED |
Sent once the Editor switches between in-game and editing mode. |
|
ESYSTEM_EVENT_EDITOR_SIMULATION_MODE_CHANGED |
Sent once the Editor switches simulation mode (AI/Physics). |
|
ESYSTEM_EVENT_FRONTEND_RELOADED |
Sent when frontend is reloaded |
|
ESYSTEM_EVENT_SW_FORCE_LOAD_START |
Sent before triggering a force loading of specified segments |
|
ESYSTEM_EVENT_SW_FORCE_LOAD_END |
Sent after triggering a force loading of specified segments |
|
ESYSTEM_EVENT_SW_SHIFT_WORLD |
Sent once segmented world manager shifts the world |
|
ESYSTEM_EVENT_STREAMING_INSTALL_ERROR |
Currently durango only Triggers when streaming install had failed to open newly recevied pak files
when installing from store |
enum ESystemGlobalState { ESYSTEM_GLOBAL_STATE_UNKNOWN, ESYSTEM_GLOBAL_STATE_INIT, ESYSTEM_GLOBAL_STATE_RUNNING, ESYSTEM_GLOBAL_STATE_LEVEL_LOAD_START_PREPARE, ESYSTEM_GLOBAL_STATE_LEVEL_LOAD_START, ESYSTEM_GLOBAL_STATE_LEVEL_LOAD_START_MATERIALS, ESYSTEM_GLOBAL_STATE_LEVEL_LOAD_START_OBJECTS, ESYSTEM_GLOBAL_STATE_LEVEL_LOAD_START_CHARACTERS, ESYSTEM_GLOBAL_STATE_LEVEL_LOAD_START_STATIC_WORLD, ESYSTEM_GLOBAL_STATE_LEVEL_LOAD_START_ENTITIES, ESYSTEM_GLOBAL_STATE_LEVEL_LOAD_START_PRECACHE, ESYSTEM_GLOBAL_STATE_LEVEL_LOAD_START_TEXTURES, ESYSTEM_GLOBAL_STATE_LEVEL_LOAD_END, ESYSTEM_GLOBAL_STATE_LEVEL_LOAD_COMPLETE };
ISystem.h
enum ESystemProtectedFunctions { eProtectedFunc_Save = 0, eProtectedFunc_Load = 1, eProtectedFuncsLast = 10 };
ISystem.h
enum ESystemUpdateFlags { ESYSUPDATE_IGNORE_AI = 0x0001, ESYSUPDATE_IGNORE_PHYSICS = 0x0002, ESYSUPDATE_EDITOR = 0x0004, ESYSUPDATE_MULTIPLAYER = 0x0008, ESYSUPDATE_EDITOR_AI_PHYSICS = 0x0010, ESYSUPDATE_EDITOR_ONLY = 0x0020 };
ISystem.h
|
Members |
Description |
|
ESYSUPDATE_EDITOR = 0x0004 |
Special update mode for editor. |