libutils
Utility functions for working with libraries.
LibUtils.get( library ) static
LibUtils.print( library ) static
LibUtils.register( library ) static
LibUtils.isRegistered( library ) static
LibUtils.exists( library ) static
LibUtils.getRegisteredLibraries( library ) static
LibUtils.help( [library] ) static

Utility functions for working with libraries.

LibUtils.get( library ) static

Returns the source code of a library as a string.

library the desired library's identifier

LibUtils.print( library ) static

Print the contents of a library to the console.

library the desired library's identifier

LibUtils.register( library ) static

Register a library. A list of registered libraries can be fetched by calling LibUtils.getRegisteredLibraries(). If you write a library of scripting functions, plug-ins that rely on that library can check if it is available through the registry service.

library the library to register

LibUtils.isRegistered( library ) static

Returns true if library is a registered library. If the library has not been previously registered, but the library exists and can be read, then it will be registered immediately and this function will return true. Otherwise, this method returns false.

library the library to register

LibUtils.exists( library ) static

Returns true if library exists, that is, if it can be loaded by calling uselibrary( library ).

library the library to register

LibUtils.getRegisteredLibraries( library ) static

Returns an array of the names of all registered libraries.

library the library to register

LibUtils.help( [library] ) static

Automatically generate documentation from the comments in a library and display it in a new window.

library the desired library's identifier

Index    Contents