Skip to main content

Setting up help for global functions

Say you have a global helper function like FOOmap which you want to provide help for. Then Iguana X makes that especially easy.

STEP 1: Make an editable component, go to the translator and make a directory called FOO.

  • To make an editable component:

  • To enter the translator, double click the new component and click edit script:

  • Then add a new directory/folder called FOO:

STEP 2: Create a file FOOmain.lua in your FOO directory.

FOOmain

STEP 3: Write/Copy your FOOmap(T) function into FOOmain.lua

function FOOmap(T)   
  --testing the mapping   
end

STEP 4: Add require 'FOO.FOOmain' to the main.lua file.

require 'FOO.FOOmain'

STEP 5: Create a file FOOmap.help in your FOO directory.

  • FOOmap

  • Select Create File:

  • Name the file like below, and make sure it is a .help extension:

STEP 6: Edit the FOOmap.help and set the summary of the function.

  • Set the summary, set it accept table parameters and define two table parameters data and live, then save:

STEP 7: Now when you type in FOOmap in the main function the help should come up for the function.