Difference between revisions of "API:Import"
(Created page with "{{lowercase title}} Sphere uses the CommonJS standard for dependency management. In CommonJS, each script is run as a function, which isolates modules from one another and en...") |
m (→Examples: Added comment) |
||
| Line 21: | Line 21: | ||
import { from, Delegate, Music, Scene } from 'miniRT'; | import { from, Delegate, Music, Scene } from 'miniRT'; | ||
| − | Music.play('sounds/music/somefile.ogg'); | + | Music.play('sounds/music/somefile.ogg'); //Use the imported Music function |
</syntaxhighlight> | </syntaxhighlight> | ||
[[Category:Sphere 2 API]] | [[Category:Sphere 2 API]] | ||
[[Category:Sphere 2 native functions]] | [[Category:Sphere 2 native functions]] | ||
Revision as of 11:52, 19 June 2017
Sphere uses the CommonJS standard for dependency management. In CommonJS, each script is run as a function, which isolates modules from one another and enables more granular control of exports. In addition, because the code importing a module decides under what name to store the imports (if at all), naming conflicts between modules are avoided entirely.
Usage
import { FunctionName } from 'module';Loads a CommonJS module. `module_id` is an abstract path (a string) identifying the module to load, with the same semantics as in, e.g. Node.js. If the module cannot be found, an error will be thrown. The engine will look for modules in the following locations:
@/lib/ #/modules/
If require() is provided with a module ID beginning with either `./` or `../`, this indicates a path relative to the location of the calling module.
Examples
import { from, Delegate, Music, Scene } from 'miniRT';
Music.play('sounds/music/somefile.ogg'); //Use the imported Music function
