ExoEngine

ExoGameEngine Class

Description

This page detail everything about the EGE class.

We recommend to first check our tutorial before using our systems.

Class Details

Variables (Members):

Main (Important information):

Name	Type	Default Value	Description
id	String	None	Store where in DOM the EGE is set.
overlayList	overlays[]	[]	The list of all the overlays in used
isFullscreenSet	Boolean	false	Is holding the information if the fullscreen button has been set or not.
isFullscreen	Boolean	false	True when the app is fullscreen.

Status (Modules loading status):

Name	Type	Default Value	Description
GUI_menuOverlayStatus	Private Boolean	false	Status of the module: "MenuOverlay" from GUI Group (Check for loaded or not).
GUI_linkerStatus	Private Boolean	false	Status of the module: "Other: Linker" from GUI Group (Check for loaded or not).
GUI_widgetStatus	Private Boolean	false	Status of the module: "Widgets: Widget" from GUI Group (Check for loaded or not).
GUI_widgetButtonStatus	Private Boolean	false	Status of the module: "Widgets: Widget Button" from GUI Group (Check for loaded or not).
GUI_widgetTextInputStatus	Private Boolean	false	Status of the module: "Widgets: Widget Text Input" from GUI Group (Check for loaded or not).
GUI_widgetTextStatus	Private Boolean	false	Status of the module: "Widgets: Widget Text" from GUI Group (Check for loaded or not).
GUI_widgetSelectStatus	Private Boolean	false	Status of the module: "Widgets: Widget Select" from GUI Group (Check for loaded or not).
GUI_widgetLayoutStatus	Private Boolean	false	Status of the module: "Widgets-Layout: Layout" from GUI Group (Check for loaded or not).
GUI_popUpStatus	Private Boolean	false	Status of the module: "PopUp: PopUp" from GUI Group (Check for loaded or not).
LOADING_loadingStatus	Private Boolean	false	Status of the module: "Loading: Loading" from Loading Group (Check for loaded or not).
WORLD_layeredWorldStatus	Private Boolean	false	Status of the module: "LayeredWorld" from World Group (Check for loaded or not).

Inner Classes:

Name	Status	Description
Classes	Holder	Unlike EE, classes are not hold in module but in this class.
GUI	Group of modules	This group contain all graphical modules.
World	Group of modules	This group contain all worlds modules.

Functions:

Main Methods:

Name	Arguments	Return	Description
Init	String: LocationID - Where the viewport is located (See tutorial). EGEModulesList []: ModulesList - Unlike the EE you cannot call module during the EGE use. This is where you call them, all the modules you need during with EGE as to be entered here. Function: Callback - This is the function called when everything is set (The function can take EGE as first arguments).	VOID	This will initialize the EGE class by setting up basics structures and calling all asked modules. Note: this function is only called by EE with LaunchGE
Launch	None	VOID	You must called this function after doing all initialization of everything you need to launch all the systems.
Call	EGEModulesList: Module - the EGEModulesList item you want to call (open) Function: Callback: the call function which is call went the files are loaded	VOID	This function is called when you need to setup a module. It use a callback function to continue the process after the modules has been loaded (because the loading in asynchronous). Note: this function is only called by EE during EGE initialization

Modules and Setters Methods:

Name	Arguments	Return	Description
AddOverAllLoading	None	Loading	This function create a loading system that entirely cover the viewport (and it return it for modification and Launch).
SetFullscreen	Function: FullscreenCallback: call when all loaded.	VOID	This function set the fullscreen button and it's images.

Util:

Name	Arguments	Return	Description
GetFullScreenButton	None	String	Use this function to get the fullscreen button ID.

Created with the Personal Edition of HelpNDoc: Qt Help documentation made easy