Package com.inductiveautomation.ignition.common.script.builtin

Annotation Interface PythonBuiltinLib

@Retention(RUNTIME) @Target(TYPE) public @interface PythonBuiltinLib

A Marker interface that should be put on classes that are going to be added to the ScriptManager to provide global scripting to the system. Because these classes are so distributed throughout the various projects, this helps find all of them.

Note that because reflection isn't quite magical enough, you also should add any classes that have this annotation to the list in the DocGenerator class so that it gets automatic docs generated for it.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    mountPath
    The path that this library will be mounted at.
    String
    scope
    The scope code that this python library will be available in.

  • Element Details

    • mountPath

      String mountPath
      The path that this library will be mounted at.

    • scope

      String scope
      The scope code that this python library will be available in.