Eyeon:Script/Reference/Libraries/eyeon
From VFXPedia
Contents |
Description
The eyeon library provides a unified namespace for functions that are not part of eyeonScripts base scripting language, Lua. By collecting these functions into one namespace it becomes more apparent where the base language has been modified or extended.
The functions in the eyeon namespace are sourced from two different locations. The embedded functions are compiled directly into eyeonScript, and thus are always available. An additional set of non-embedded functions are provided by an external file, called eyeon.scriptlib. Typically this file is installed with Fusion, Vision, Rotation, or the Render Slave.
Embedded
Many of the functions found below were originally implemented as global functions within the eyeonscript language. For example, rather than typing eyeon.createdir(), you could have just used createdir() in Fusion 5.0. Over time it became evident that it would be clearer if all the extra functions were organized into their own namespace. That was done in Fusion 5.1. However, in order to maintain compatibility for many of the older scripts many of the eyeon namespace functions are still available from the global namespace as well.
That use is deprecated, and is not assured for future versions. All scripts should be written using the eyeon.namespace, unless otherwise noted.
eyeon.scriptlib
Historically, the file eyeon.scriptlib pre-dates the embedded functions. As the QA and support teams at eyeon wrote scripts for distribution, they started putting useful functions into a file called eyeon.scriptlib. Like all scriptlib files, the eyeon.scriptlib file is executed each time a new composition is opened, and in the case of Fusion 5.2 or later, when Fusion is opened for the first time. This makes it easy for scripts to re-use those function. Over time a large library of scripts grew to depend on these functions, so the file is distributed with the applications Fusion, Vision and Rotation.
That scriptlib also inserts its functions into the eyeon namespace, but they will only be available if the file eyeon.scriptlib is found in the same folder as eyeonScript.exe, or the Application:\Scripts subfolder.
For this reason they are documented in a separate section below.
The listing below separates these into
eyeon Library Functions (Embedded):
- asyncscriptapp
- crash
- createdir
- createuuid
- defragfile
- defragsequence
- direxists
- dump
- exit
- executebg
- fileexists
- fullpath
- getappname
- getappuuid
- getclipboard
- getcurrentdir
- getpid
- getusing
- noise
- obtaingloballock
- pinghosts
- readdir
- readfile
- readstring
- releasegloballock
- removedir
- sendnotify
- startserver
- stripname
- using
- setclipboard
- scriptapp
- setcurrentdir
- tounc
- wait
- writefile
- writestring
eyeon Library Functions (Scriptlib):
Coming soon.
