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

Interface ScriptFunctionHint

All Superinterfaces:
Serializable
All Known Implementing Classes:
PackageHint
public interface ScriptFunctionHint extends Serializable

  • Method Details

    • getAutocompleteText

      String getAutocompleteText()
      Returns:
      The String to insert if the user chooses to auto-complete this hint.

    • getMethodSignature

      String getMethodSignature()
      Returns:
      The formatted String to use as the method signature.

    • getMethodDescription

      String getMethodDescription()
      Returns:
      A description of what the function does.

    • getParameterDescriptions

      Map<String,String> getParameterDescriptions()
      Returns:
      Map of parameter names matched to their descriptions.

    • getReturnValueDescription

      String getReturnValueDescription()
      Returns:
      A description of the function's return value.