Here are a few thoughts about organising scripts.
For my own sanity I look after my scripts each within their own folder under the GP Content folder. On windows this looks something like C:\Users\<username>\Documents\Gig Performer\Scripts\<myfolder>\. This allows me to add version control, reduce the risk of overwriting a script with the same name and keeping any assets associated to the script (documents, screenshots etc.) all together. Also, bug fixes or feature adds to the scripts are easily picked up.
The next thing I do when using/reusing a script, I do not load it into the script editor, for scriptlets I just include it.
scriptlet
Include "<myfolder>/<myscript.gpscript>"
This will pull the script into GP at compile time. In the scriptlet, in the wiring view, this may be the only line of code needed when reusing scripts.
The same can be used when loading functional elements into a larger script such as rackspace or global script editors. It is much easier when using scriptlets as they generally have a single functional requirement.
largescript
Include "<myfolder1>/<myscript1.gpscript>"
Include "<myfolder2>/<myscript2.gpscript>"
Include "<myfolder3>/<myscript3.gpscript>"
Care should be taken when loading functional fragments in this way, in that, a variable declared outside of the functions are “global scope”. So if a variable called myVar declared in more than one place will cause problems. Fortunately there is a simple rule to get round this problem, in each script always declare these “global scoped” variables starting with the name (or initials) of the containing script. The same rule applies for function names.
myscript1
const ms1_VERSION : String = "V1.0.0" // Good name
var myVar : Integer = 0 // This will cause problems if in other included files
Function myFunc()
// Function name may be an issue if a function with the same name is loaded
End
myscript2
const VERSION : String = "V1.0.0" // This is highly likely to be reused
var myVar : Integer = 0 // This variable has already been declared in myscript1
Function ms2_myFunc()
// Good name
End
myscript3
const ms3_VERSION : String = "V1.0.0" // Good name
var ms3_myVar : Integer = 0 // Good name
Function myFunc()
// Function has already been defined in myscript1
End
On <callbacks> should be used with care as it is easy to include multiple callbacks with the same name. If possible always use the Matching extension or be clear on functional splitting.
