Prev Next

GetMenuList

Inputs

Parameter

Details

parameters

  • C++: const char*
  • C#: string

A JSON string of parameters. Includes:

  • level - the level hierarchy of the requested menu (starting with 1 for first level)
  • currentID, currentName - the id and name of the current menu level
  • levelXID - the id of the menu level X for all previous levels in the hierarchy, ie level1ID, level2ID
  • levelXName - the name of the menu level X for all previous levels in the hierarchy, ie level1Name, level2Name

Outputs via Callbacks

  • AddProperty - 2 calls per menu item: "id", "name".
  • [Optional] LogMessage or SetError - to provide user feedback.

Details

This method receives a request to populate the menu in External Data window. Each level in the menu hierarchy will trigger a new request, and the parameters will include the level being requested.

This method should fill in the menu items by calling the AddProperty callback method.

Each item in the menu requires two calls to AddProperty. And each item must use a unique 'index' value as the first parameters

  • id - the id passed in specifies a unique id representing this menu item. The plugin may receive this id back in subsequent calls (eg when requesting the next sub-menu level)
  • name - the user displayable name of the menu item

Don't return an error for a blank response. Simply do nothing.