Scripting API Documentation

This is the index for the Scripting API Documentation for the Crystal Clear Engine. This documentation does not inform about namespaces which are not related to the Scripting API.

Namespaces:

• CrystalClear - The base namespace for the Scripting API. All projects use this for the base of their namespaces. This also contains the CrystalClearInformation class which contains useful information about the engine, such as current version etc.

  • CrystalClear.CompilationSystem - The system responsible for compilation of scripts and which manages different languages' compilation methods.

  • CrystalClear.EventSystem - This namespace contains the system which manages events. The Event System contains many useful attributes and methods for handling events.

  • CrystalClear.HierarchySystem - This is, quite intuitively, the namespace for the Hierarchy System. The Hierarchy System contains definitions for highly important types such as HierarchyObject and also contains the static class HierarchyManager which manages Hierarchies.

  • CrystalClear.ScriptUtilities - The script utilities namespace contains useful features and utilities, some even as important as the IsScriptAttribute or Output. The project which "hosts" this namespace might later be removed for a more distributed implementation where any project can contain specific Script Utilities.

  • CrystalClear.Standard - This is a very important namespace, which you are almost guaranteed to use in your scripts. CrystalClear.Standard is the namespace for standard implementations of types. ScriptObject and WorldObject are examples of very common types defined in this namespace. Any code that is in the Standard namespace is also code that essentially could be compiled in a Crystal Clear project! Looking at the implementation of types in Standard can be great to get insight on how to create custom things in Crystal Clear!

  • CrystalClear.UI - (This namespace is not implemented yet!) This is the main UI namespace for the engine. It is responsible for the editor's UI, so scripts which want custom serialisation need this namespace, but for actual in-game/software UI that will likely be located elsewhere.