Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Introduced in

Version:3.9.2

Description

Description:Calls a component function.

Syntax

Syntax:componentFunction [componentName, args]
Parameters:
  • componentName: String - The name of the API component (case sensitive).
  • args: String - The arguments passed into the component function. The form is: "functionName [param1, param2, ...]", where:
    • functionName - The function name.
    • param1, param2, ... - The parameters passed to the function.
Return Value:Anything - Based on the return value of the component function. Any data returned is contained in an Array.

Alternative Syntax

Syntax:componentFunction [componentName, args, object] (V18.1+)
Parameters:
  • componentName: String - The name of the API component (case sensitive).
  • args: String - The arguments passed into the component function. The form is: "functionName [param1, param2, ...]", where:
    • functionName - The function name.
    • param1, param2, ... - The parameters passed to the function.
  • object: ObjectObject that is passed to the component, without the need to serialize it to a string, and pass it as part of args.
Return Value:Anything - Based on the return value of the component function. Any data returned is contained in an Array.

Examples

Examples:
_ret = componentFunction ["xMirror", "mirror [horizontal,true]"];

Additional Information

See also: pluginFunction, fusionFunction
Multiplayer:
Problems:

Notes