ScriptInfoData Struct Reference

#include <c4d_baselist.h>

Detailed Description

Broadcasted alongside the message MSG_MULTI_SCRIPTINFO to query scene elements for scripts they contain and might execute.

The message is usually broadcasted at a document level with C4DAtom::MultiMessage to collect information for a whole document:

BaseDocument* doc;
ScriptInfoData infoData;
doc->MultiMessage(MULTIMSG_ROUTE::BROADCAST, MSG_MULTI_SCRIPTINFO, &infoData);
for (const ScriptInfoData::ScriptInfoItem& item: scriptInfoData.items)
  DebugOutput(maxon::OUTPUT::DIAGNOSTIC, "Node: '@'", item.node ? item.node->GetName() : item.node);

When implementing a NodeData derived plugin hook which executes Python code, one must implement the message so that documents containing the plugin can be stopped from loading when the user does not trust the document:

Bool MyPythonObjectData::Message(GeListNode *node, Int32 type, void *data)
{
  // ...
  switch(type)
  {
    // ...
    case MSG_MULTI_SCRIPTINFO:
    {
      BaseList2D* const blist = static_cast<BaseList2D*>(node);
      ScriptInfoData* const infoData = reinterpret_cast<ScriptInfoData*>(data);
      if (!blist || !infoData)
        return false;
 
      // Setup an info item and define the parameter ID of the Python code in your plugin.
      ScriptInfoData::ScriptInfoItem item;
      DescID paramId = ConstDescID(DescLevel(ID_MYPLUGIN_CODE));
      const BaseContainer& bc = blist->GetDataInstanceRef();
 
      // Fill in the node and parameter pointers.
      item.node = blist;
      item.pid = &paramId;
      // Define the language and context. 3rd party plugins must use #SCRIPTINFO_CONTEXT::UNKNOWN.
      item.language = SCRIPTINFO_LANGUAGE::PYTHON;
      item.context = SCRIPTINFO_CONTEXT::UNKNOWN;
      // isDefault should express if the current code state is equal to the default value and
      // isExecuted if the code will be executed when Cinema 4D invokes this node. For an object
      // plugin this for example depends on the parameter #ID_BASEOBJECT_GENERATOR_FLAG.
      item.isDefault = bc.GetString(ID_MYPLUGIN_CODE) == MY_DEFAULT_CODE;
      item.isExecuted = bc.GetBool(ID_BASEOBJECT_GENERATOR_FLAG);
 
      // And finally append your script information. When your plugin holds multiple scripts,
      // append one item for each of them.
      iferr (infoData->items.Append(item))
        return false;
 
      break;
    }
    // ...

Classes
struct	ScriptInfoItem

Public Member Functions
	ScriptInfoData ()

Public Attributes
maxon::BaseArray< ScriptInfoItem >	items

Constructor & Destructor Documentation

ScriptInfoData()

ScriptInfoData

(

)

Member Data Documentation

items

maxon::BaseArray<ScriptInfoItem> items

Stores the scripting element information provided by the queried nodes.