application.getCustomModulesDirectory

Returns the path string the the user's custom module directory.

Prototype

  1. sFolderPath = application.getCustomModulesDirectory ( )

Description

Apart from the Resources/Modules directory that comes with ShiVa, there is another Modules directory in Appdata/Local/ShiVa, (Windows), ~/Library/Application Support/ShiVa, and ~/.ShiVa (Linux) where your custom modules are stored and the default modules are copied to on first start. You should only work from this directory as Resources/Modules is most likely write protected.


Parameters


Return values

sFolderPath - path string


Sample

  1. -- copy the template to the destination
  2. system.copyDirectory ( module.getRootDirectory ( this.getModule ( ) ).."templates/"..sTemplateName, application.getCustomModulesDirectory ( )..sModuleIdentifier )

Available since ShiVa 2.0