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

Annotation Interface ScriptArg

@Retention(RUNTIME) @Target(PARAMETER) public @interface ScriptArg
Annotates an argument of a function being added to the scripting system.

Provides the name of the argument that will be used in the script hints auto-complete system. This annotation is essential for methods that don't use KeywordArgs but still want descriptive parameter names in autocomplete.

See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    optional
     

  • Element Details

    • value

      String value
      Returns:
      The name of this argument, e.g. "opcServerName" or "rowCount".

    • optional

      boolean optional
      Returns:
      True if this argument is optionally present. If specified, the parameter will appear wrapped in brackets (e.g. [optionalArg]) in script hints.
      Default:
      false