grandMA3 User Manual Publication
SelectedFeature()
grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » SelectedFeature()
Version 2.0

Description

The SelectedFeature Lua function returns the handle of the selected feature.

Arguments

This function does not accept any arguments.

Return

  • Handle:
    The returned handle for the selected feature.

Example

This example prints all information about the selected feature in the Command Line History using the Dump() function:

Dump()

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.

Lua
return function ()
-- The following prints the dump for the selected feature object
Printf("=============== START OF DUMP ===============")
SelectedFeature():Dump()
Printf("================ END OF DUMP ================")
end