Skip to content

Root()

The Root Lua function returns a handle to the object at the root position.

This function does not accept any arguments.

  • Handle:
    The function returns a handle to the Root object.

Example

This simple example prints the information of the Root object in the Command Line History using the Dump() function:

The Dump() function returns a string with information about the object, for instance, the name, class, path of the object, its properties, and children.

Learn more in the Dump() topic.

Copy CodeLua
```
return function()
-- The following prints the dump for the root object
Printf("=============== START OF DUMP ===============")
Root():Dump()
Printf("================ END OF DUMP ================")

end