Open Search
    ScriptInfoData::ScriptInfoItem Struct Reference

    #include <c4d_baselist.h>

    Detailed Description

    Describes a singular script parameter held by a node, e.g., the OPYTHON_CODE parameter of Opython.

    Nodes that hold more then one script, e.g., the Sketch & Toon material which holds scripts for its color, opacity, and thickness channels, will yield multiple ScriptInfoItem upon being queried.

    Note
    Due to the inner makeup of Tcavisualselector, it is for users of the public API only possible to access the Python code of the active hot spot. But when MSG_MULTI_SCRIPTINFO is being broadcasted to a Tcavisualselector tag, it will collect information for all hot spots, not only the active one. This makes it impossible for users of the public API to retrieve the associated Tcavisualselector code for ScriptInfoItem event data in this case.

    Public Member Functions

     ScriptInfoItem ()
     

    Public Attributes

    BaseList2Dnode
     
    DescIDpid
     
    SCRIPT_LANGUAGE language
     
    SCRIPT_CONTEXT context
     
    Bool isDefault
     
    Bool isExecuted
     

    Constructor & Destructor Documentation

    ◆ ScriptInfoItem()

    Member Data Documentation

    ◆ node

    The node owning the code, only meaningful when broadcasted as a multi-message to multiple nodes.

    ◆ pid

    DescID* pid

    The identifier of the parameter which holds the script code.

    Note
    Unreliable for Tcavisualselector, see class description for details.

    ◆ language

    SCRIPT_LANGUAGE language

    The scripting language the code is written in, as for example CPython.

    ◆ context

    SCRIPT_CONTEXT context

    The context in which the script is used, as for example a Python Generator object.

    ◆ isDefault

    Bool isDefault

    If the code is the default code of node.

    ◆ isExecuted

    Bool isExecuted

    If node is in a state where the code at pid will be executed on node evaluation.