Auto-Completion
- Aryn Wiebe
Our goal is to make scripting easy for all our users, regardless of their expertise. One big way we achieve this is through the Translator’s Auto-Completion.
Auto-completion provides intuitive, interactive support that you can lean on while scripting so you can code faster and more accurately.
As you type in Translator editor, auto-completion offers immediate suggestions for any globally or locally defined item: modules, functions, variables, parameters, etc.
Auto-completion is also fully integrated with the Help System that provides extensive on-the-spot scripting support.
Auto-completion can be used with:
When working in the Translator, auto-completion helps you discover functionality of modules and functions, providing you with assistance in completing different tasks.
For example, say you are working with JSON data. By typing in the JSON, autocomplete will populate all the functions for that module. You can see below, the JSON module has three associated functions:
By choosing a function, you can then see the required parameters to complete that function and access the Help Files (*.help).
When it comes to data transformation or mapping, auto-complete can help you to familiarize yourself with the data structure and speed up the mappings process. It can be used with any data format to quickly find any data or field without having to know its exact location in advance.
For example, when parsing and mapping a JSON object you can quickly see the data structure and fields and click through to capture a particular field:
If you know the name of the data field you, can begin typing the name and auto-complete will suggest the corresponding data field:
Or if you know the data value you want to use, you can begin typing in the value and auto-complete will suggest the field:
Auto-complete helps you work quickly with your own custom variables that you create in your script, whether it's local or global or defined in main or an another Lua file.
For example, if you define the variable var, as soon as you begin typing v, autocomplete will suggest the variable or functions beginning with v.
