ExoEngine - WebEngine
(Alpha 0.0.3 Doc)
PRESENTATION
The ExoEngine (EE) is a programming developed to facilitate web development through different modules. It usable from simple website to more complex WebApp or even video games.
This engine has two main sections:
- ExoEngine (EE): A system developed to make web site creation easier, the system works with independents modules. It work has a code extension.
- ExoGameEngine (EGE): System include in the EE and use to make video games, but it also works for WebApp / WebSoftware. Contrary to EE, the EGE is an all-in-one system, all the modules work together.
INSTALATION (EE)
ExoEngine is using the library JQuery, so before using the EE make sure you call it (See details below).
Once JQuery is set you can install EE on your page, EE is an external library system, so all you have to do is calling the main EE file: http://www.exodiastudio.com/ExoEngine/Alpha0.0.2/ExoEngine.js.
Example (you can copy this code to install):
- <script src="https://code.jquery.com/jquery-3.4.1.min.js"></script>
- <script src="http://www.exodiastudio.com/ExoEngine/Alpha0.0.3/ExoEngine.js"></script>
you now have access the EE class.
HOW TO USE (EE)
As said previously, to avoid a heavy loading the EE use a module system. Each modules are call separately based on your website needs.
To use an EE functionality / module follow those step:
1st: What you need to now
- EE is just a massive class where all the functionalities are stored. To access it, you just need to call the global variable EE or EE0_4 (See Multi-Version for more info).
2nd: Call a module
- To call a module simply use the function EE.Call(), with two arguments: the module name from the enumerator modulesList (EE.modulesList.MODULE_NAME) and a callback function (called when loaded -- the loading is asynchronous). For more details check the ExoEngine Class file.
3rd: Call the module functionality
- Now your module is ready, within the callback function or latter in an event (if you use the module just after the call it might not be loaded) use EE.Module.Functionality or EE.Group.Module.Functionality (some module are store in groups just enter the group name first). Groups and Modules names are the same as shown is this documentation.
- EE.Call(EE.modulesList.SYSTEM_SCROLLING, function(){
- Scrolling = EE.System.Scrolling.AddScrolling();
- }
MULTI-VERSION INSTALATION (EE)
At any time you can call another EE version (e.g. if you prefer how was working in a previous version), to implement it just add a second line:
- <script src="https://code.jquery.com/jquery-3.4.1.min.js"></script>
- <script src="http://www.exodiastudio.com/ExoEngine/Alpha0.0.2/ExoEngine.js"></script>
- <script src="http://www.exodiastudio.com/ExoEngine/Alpha0.0.3/ExoEngine.js"></script>
Important: When a ExoEngine.js file is called it create two global variable EE and EE0_3 (Change with versions called -- This is an example). When you use different version at the same time the EE variable will always be the last version entered. Functions called with EE will be automatically upgraded if you change the version.
We recommend to use EE0_3 format instead of EE. If you add a new version your code will not crash.
INSTALATION & HOW TO USE (EGE)
This section is detailed in another page: click here to reach it.
Created with the Personal Edition of HelpNDoc: Produce Kindle eBooks easily