All along this documentation you will a color code, some special annotations, and specific classes to help understanding the doc. This color color code is summarize here:




Color


       Main:


- EngineEngine (#BF0000): Color of the EE class.

- EngineGameEngine (#7F0000): Color of the EGE class.




       Web languages:


               - CSS (#588877): CSS class or name.


               - JQuery Classes (#A40694): All JQuery Classes.

               - JS Functions (#23503F): JavaScript method or function



       EE & Main:


               - Class / Modules (#7030A0): Default classes / Modules color.

- Group (#825BC1): Default groups color.


- Method / Functions (#00B050): Refer to any type of functions.


- Event (#FF0000): Refer events names.



       Structures:


               - Enumerator (#FF8040): Refer to a enumerator structure or its content.



       Programming identifier:

               

- Keyword (#00007F): Programming Key words


- Integer (#3333FF): String variable

- Float (#6666FF): String variable


- String (#007F7F): String variable

- BOOLEAN (#B96666): Boolean variable



       Other:


               - WEB ADDRESS (#00B0F0): Used to specify a web address (this is not a link).




       Specials methods (some function are use for very specific cases):


- EVENT FUNCTION (#C80000): Called by a window event.

- ANIMATION FUNCTION (#007BBF): Basics structure use by animation process, usually it contain the three arguments: Percent, X, ExtraData.





Annotations


Annotations are special remarks identified by the symbol @:



@Nullable: The argument can be null.

@CSS: You have to enter a value matching with CSS systems (correct units, matching description, etc...).

@Non-Module: Those are functions where don't need to call a modules, there are already loaded with EE, it use for faster access while programming



Common Classes / Structures


Some classes and structure are used by different modules all around EE here is a some of them:



Position (Pos):

Name

Type

Default Value

Description

x

Float / Integer

null

X of the point

y

Float / Integer

null

Y of the point



Position are used to keep track of a point into a 2D space.



Undefined identifier


Some identifier are multi-types and can be used different ways:




Color


This identifier can accept:


  • @CSS String: Defining the color as used by CSS.
  • String: used for hex colors.
  • Integer[3]: used to define RGB color.
  • Integer & Float[4]: used to define RGBA color.
  • Class: class with members - .r for red, .g for green, .b for blue and .a for alpha Chanel (Optional).


Created with the Personal Edition of HelpNDoc: Easily create PDF Help documents