Using Scripting Help
Contents
Calling a function but can’t figure out what you need to define? Don’t panic! We are proud of our interactive scripting help that is fully integrated with our powerful auto-completion tool. Not only will the Iguana Translator auto-complete modules, functions and variables as you type, but now it also provides extensive, on-the-spot help to make sure that you are using these items correctly.Iguana can explain what you need, what is optional, and the syntax required to complete the function correctly:
How it Works
Start typing out the item that you wish to add to your script. Based on what you are typing, Iguana’s handy auto-completion tool instantly lists all the possible items that you can include.
But, what if you are unsure which item to select or how to use it correctly? With our new help system in place, Iguana can also provide instant information about the variables, arguments and additional parameters that you may need to define in order to use your auto-completion selections correctly.
In this example, Iguana’s auto-completion tool is telling us that in order to call queue.push correctly, we must define which message will be pushed (and that we must use the data variable to do it). Notice that, unlike regular auto-completion suggestions, this information is displayed in a yellow help dialog. This indicates that we have access to additional help about this topic, should we need it:
Still not sure how to use the data parameter properly, we decide to take advantage of this additional help! By simply clicking the expand icon in the top right-hand corner of the help dialog, we gain instant access to Iguana’s new help system. A pop-window opens, listing all the information we might need to make our decisions:
By pairing this new help system with the robust auto-complete feature, Iguana helps you script with confidence.