com.inductiveautomation.ignition.common.script.hints

Annotation Type ScriptArg

@Retention(value=RUNTIME)
 @Target(value=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.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	optional

Element Detail

value

public abstract java.lang.String value

Returns:

The name of this argument, e.g. "opcServerName" or "rowCount".

optional

public abstract boolean optional

Returns:

True if this argument is optionally present.

Default:

false