Overview

Component Interface events are non-contract; that is, they may fail and return an error code, so the caller must check the return code. More succinct code is achieved in C++ by offering "contract" functions, that either succeed or raise an exception. Contract wrapper functions are provided for some Component Interface events in the overlay. In addition, they may be much less verbose than the equivalent code to fire the event.

Functions

These are "contract" functions; that is, they either succeed or raise an exception.

const char* getSymbolString(Symbol symbol)
Contract wrapper for ENGINE_EVENT_GET_SYMBOL_STRING.
const char* getTypeString(TYPE type)
Contract wrapper for ENGINE_EVENT_GET_TYPE_STRING.
VUINT32 getRandomSeed(UINT32 count = 0)
Contract wrapper for ENGINE_EVENT_GET_RANDOM_SEED. If count is zero, a seed of unspecified length is returned (at least one element). If count is non-zero, a seed of the specified length is returned.
Symbol createUtility(const char* cls, UINT16 release, const char* name = NULL)
Contract wrapper for ENGINE_EVENT_CREATE_UTILITY. A utility, as specified, is returned. If name is non-NULL, the new utility is named accordingly.
Symbol stillActive()
Send ENGINE_EVENT_STILL_ACTIVE to the framework.