The Storyboard gredom Lua module provides a limited access to the hierarchical model used by the Storyboard Engine. This functionality is provided in a separate plugin (plugins/libgre-plugin-luagredom.so) and should be available for any target platform that contains the Lua Storyboard plugin. Client can check for the existence of the DOM module by checking that the symbole gredom is not nil.

The DOM module provides two sets of function interfaces. The first set of functions are associated with the gredom namespace and are used to lookup or access an Lua object (table) that contains a special set of methods (metatable entries) that are used to extract additional information about the object. In this documentation the object returned from the gredom namespace functions will be referred to as a DOMOBJECT object. Methods associated with the DOMOBJECT object must be invoked using the Lua colon (:) notation for example DOMOBJECT:get_name()