Package com.inductiveautomation.ignition.common.script.hints

Annotation Interface SystemLibrary

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

A marker interface that should be put on classes that provide system functions or fields to scripting, e.g. system.db. Because these classes are so distributed throughout the various projects, this helps find all of them.

See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    mountPath
    The path that this library will be mounted at.

  • Element Details

    • mountPath

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

      Note: This is a purely informational attribute, and does not determine where the library is mounted. The sole source of truth for that is the path provided in ScriptManager.addScriptModule(String, Object), or whichever overload you choose.

      Note, however, that PropertiesFileDocProvider will hide your entire library if the actual mount path does not match the path given in this annotation, under the assumption that it's a "legacy" library that should not be exposed to the user.