m2etis  0.4
Documentation for macros

These lists contain all important macros.

Object-like macros

Name Defined in file Brief description
I6E_API I6eSystemParameters.h This macro contains a compiler directive. It should be written after each class declaration if this class should be exported later.
I6E_MODE I6eSystemParameters.h Is defined either as '1' when running in Debug mode or as '2' when running in Release mode.
I6E_PLATFORM I6eSystemParameters.h Is defined either as '1' when running in a MS Windows environment or as '2' when running in a Linux environment.
LNG_GRAPHICS_FRAME_TIME GameEngineController.h This macro sets the frametime the GraphicsController subsystem works with.
LNG_INPUT_FRAME_TIME GameEngineController.h This macro sets the frametime the InputController subsystem works with.
LNG_MESSAGING_FRAME_TIME SubSystemController.h This macro sets the frametime the MessagingController subsystem works with.
LNG_OBJECT_FRAME_TIME GameEngineController.h This macro sets the frametime the ObjectController subsystem works with.

Function-like macros

Name Defined in file Brief description
CONVERTVARIABLE(objRealVariable, Type, objVariantVariable) MessagingController.h Used to convert a variable of type ObjectVariable into it's original type. Have a look at the MessagingController class description to get more information.
M2ETIS_LOG_X("Module", "Message") Logger.h This macro is used for the controlled output of error / info / warning / debug messages. X stands for the logging level and can be one of: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'. For example: M2ETIS_LOG_WARN("PhysicsController", "Erratic Gravity!")
M2ETIS_LOG_SETLEVEL(level) Logger.h Sets the new LogLevel (i6utils::Logger::LogLevel). Everything at least as important as 'level' is logged. For example: M2ETIS_LOG_SETLEVEL(i6utils::Logger::INFO)
REGISTERMESSAGETYPE(strMessageTypeName, ptrMessageMethod) MessagingController.h This macro should be used to register message types at the MessagingController. Have a look at its class description to get more information.
RETURNIFVARIABLEISNULL(objVariable) MessagingController.h Macro to check of an extracted variable of a message is null. Should be used just before the CONVERTVARIABLE macro. Have a look at the MessagingController class description to get more information.
UNREGISTERMESSAGETYPE(strMessageTypeName) MessagingController.h Deletes a registration of a message type. Have a look at the MessagingController class description to get more information.