ExoEngine Class

Description

This page detail everything about the EE class.

We recommend to first check our installation and first use guide (Introduction) before using our systems.

Class Details

Variables (Members):

Main (Important information):

Name	Type	Default Value	Description
ENGINE_VERSION	Constant STRING	A0.0.3	Constant Variable defining the version the Engine used
EGE	EGE Class	null	The member that hold the EGE Class when the EGE is called.

Status (Modules loading status):

Name	Type	Default Value	Description
animationFunctionalStatus	Private Boolean	false	Status of the module: "Animation: Functional" (Check for loaded or not).
animationFlipStatus	Private Boolean	false	Status of the module: "Animation: Flip" (Check for loaded or not).
animationAnimatedGradientStatus	Private Boolean	false	Status of the module: "Animation: Animated Gradient" (Check for loaded or not).
arrayGrid2DStatus	Private Boolean	false	Status of the module: "Array: 2D Grid" (Check for loaded or not).
arrayMap2DStatus	Private Boolean	false	Status of the module: "Array: 2D Map" (Check for loaded or not).
GUI_ImageViewerStatus	Private Boolean	false	Status of the module: "Images: Viewer" from GUI Group (Check for loaded or not).
GUI_ImageImageListStatus	Private Boolean	false	Status of the module: "Images: Image List" from GUI Group (Check for loaded or not).
GUI_Tab_InteractiveTabStatus	Private Boolean	false	Status of the module: "Tab: Interactive Tab" from GUI Group (Check for loaded or not).
GUI_Tab_LegendStatus	Private Boolean	false	Status of the module: "Tab: Legend" from GUI Group (Check for loaded or not).
GUI_Tab_MultiTabStatus	Private Boolean	false	Status of the module: "Tab: MultiTab" from GUI Group (Check for loaded or not).
GUI_Tab_OverlappingTabStatus	Private Boolean	false	Status of the module: "Tab: Overlapping Tab" from GUI Group (Check for loaded or not).
GUI_TimeVerticalTimelineStatus	Private Boolean	false	Status of the module: "Time: Vertical Timeline" from GUI Group (Check for loaded or not).
GUI_Status_StateBarStatus	Private Boolean	false	Status of the module: "Status: State Bar" from GUI Group (Check for loaded or not).
GUI_Status_LoadingBarStatus	Private Boolean	false	Status of the module: "Status: Loading Bar" from GUI Group (Check for loaded or not).
GUI_ToolBox_InteractiveToolBoxStatus	Private Boolean	false	Status of the module: "Tool Box: Interactive Tool Box" from GUI Group (Check for loaded or not).
GUI_PopUp_SelectStatus	Private Boolean	false	Status of the module: "Pop up: Select" from GUI Group (Check for loaded or not).
DESIGN_Background_ImageBackgroundStatus	Private Boolean	false	Status of the module: "Background: Image Background" from Design Group (Check for loaded or not).
DESIGN_Hover_HoverGradientStatus	Private Boolean	false	Status of the module: "Hover: Hover Gradient" from Design Group (Check for loaded or not).
DESIGN_Hover_HoverBlurStatus	Private Boolean	false	Status of the module: "Hover: Hover Blur" from Design Group (Check for loaded or not).
mathTrigoStatus	Private Boolean	false	Status of the module: "Math: Trigonometry" (Check for loaded or not).
mathRandomStatus	Private Boolean	false	Status of the module: "Math: Random" (Check for loaded or not).
SYSTEM_LangStatus	Private Boolean	false	Status of the module: "Language: Lang" from System Group (Check for loaded or not).
SYSTEM_MouseStatus	Private Boolean	false	Status of the module: "Mouse: Mouse" from System Group (Check for loaded or not).
SYSTEM_ScrollStatus	Private Boolean	false	Status of the module: "Scrolling: Scrolling" from System Group (Check for loaded or not).
SYSTEM_FILE_DeviceFileStatus	Private Boolean	false	Status of the module: "File: Device File" from System Group (Check for loaded or not).
SYSTEM_CookiesStatus	Private Boolean	false	Status of the module: "Cookies" from System Group (Check for loaded or not).
SYSTEM_KeyboardStatus	Private Boolean	false	Status of the module: "Keyboard: Keyboard" from System Group (Check for loaded or not).
UTIL_LoadCheckStatus	Private Boolean	false	Status of the module: "Load Check" from Util group (Check for loaded or not).
UTIL_RedirectStatus	Private Boolean	false	Status of the module: "Redirect" from Util group (Check for loaded or not).
UTIL_ConverterStatus	Private Boolean	false	Status of the module: "Converter" from Util group (Check for loaded or not).
GameStatus	Private Boolean	false	Status of the EGE (Check for loaded or not).

Enumerations:

Name	List	Description
modulesList	ANIMATIONS ANIMATIONS_FUNCTIONAL ANIMATIONS_FLIP ANIMATIONS_ANIMATED_GRADIENT ARRAY ARRAY_GRID2D ARRAY_MAP2D GUI_IMAGES GUI_IMAGES_VIEWER GUI_IMAGES_IMAGELIST GUI_TAB GUI_TAB_INTERACTIVETAB GUI_TAB_LEGEND GUI_TAB_MULTITAB GUI_TAB_OVERLAPPINGTAB GUI_TIME GUI_STATUS GUI_STATUS_STATEBAR GUI_STATUS_LOADINGBAR GUI_TOOLBOX GUI_TOOLBOX_INTERACTIVETOOLBOX GUI_POPUP GUI_POPUP_SELECT DESIGN_BACKGROUND DESIGN_BACKGROUND_IMAGEBACKGROUND DESIGN_HOVER DESIGN_HOVER_HOVERGRADIENT DESIGN_HOVER_HOVERBLUR MATHS MATHS_RANDOM MATHS_TRIGONOMETRY SYSTEM_LANG SYSTEM_MOUSE SYSTEM_SCROLLING SYSTEM_FILE_DEVICEFILE SYSTEM_COOKIES SYSTEM_KEYBOARD UTIL_CONVERTER UTIL_REDIRECT UTIL_LOADCHECK	This list is used by the call() function to define which module has to be called
EGEModulesList	LOADING_LOADING GUI_OVERLAY GUI_LINKER GUI_WIDGET GUI_WIDGET_BUTTON GUI_WIDGET_TEXTINPUT GUI_WIDGET_TEXT GUI_WIDGET_SELECT GUI_WIDGET_LAYOUT GUI_POPUP WORLD_LAYEREDWORLD	Since EGE modules are called by EE they have to be in the main class. Those are used by LaunchGE() Function

Inner Classes:

All the inner classes are the modules or the modules groups.

Name	Status	Description
Animation	Module	Module used for all animation purpose.
Array	Module	Module within different array class.
GUI	Group of modules	This group contain all graphical modules
Design	Group of modules	This group contain website design enhancer
Math	Module	Module used for different math calculation
System	Group of modules	This group contain all classes used for back-ends operations
Util	Group of modules	This group contain all other modules that doesn't fit with other groups (mostly help modules). NOTE: From this version most of the Util content are not anymore modules and are directly loaded.

Functions:

Name	Arguments	Return	Description
Call	modulesList: Module - the modulesList 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).
ModuleCheck	modulesList: Module - the modulesList item you want to test	Boolean	This function is used to test if the selected modules has already been called, it return False if the module has already been called. (This system is used by Call() to avoid loading modules two times).
LaunchGE	String: LocationID - where in DOM the view-port and the EGE Structure has to be created. EGEModulesList []: ModulesList - List of all the EGE modules you want to load. Function: Callback - the call function which is call went the files are loaded.	VOID	This function is used to launch the EGE system. (See more details in the EGE Installation tutorial) Note: Only one EGE can be load at the time.

Created with the Personal Edition of HelpNDoc: Write EPub books for the iPad