API:Import - Revision history

Fatcerberus: miniRT -> sphere-runtime rename

2017-06-20T20:41:54Z

miniRT -> sphere-runtime rename

DaVince: Edited display title

2017-06-20T18:27:16Z

Edited display title

DaVince: attempt 3

2017-06-20T18:24:27Z

attempt 3

DaVince: attempt 2

2017-06-20T18:23:46Z

attempt 2

DaVince: test change how name is displayed

2017-06-20T18:23:08Z

test change how name is displayed

DaVince at 18:22, 20 June 2017

2017-06-20T18:22:27Z

DaVince: /* Examples */ Added comment

2017-06-19T11:52:42Z

‎Examples: Added comment

DaVince: 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..."

2017-06-19T10:48:02Z

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..."

New page

{{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 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 ===

<syntaxhighlight>import { FunctionName } from 'module';</syntaxhighlight>

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 <tt>require()</tt> is provided with a module ID beginning with either `./` or `../`, this indicates a path relative to the location of the calling module.

=== Examples ===

<syntaxhighlight>
import { from, Delegate, Music, Scene } from 'miniRT';

Music.play('sounds/music/somefile.ogg');
</syntaxhighlight>

[[Category:Sphere 2 API]]
[[Category:Sphere 2 native functions]]

← Older revision		Revision as of 18:24, 20 June 2017
Line 25:		Line 25:
	[[Category:Sphere 2 native functions]]		[[Category:Sphere 2 native functions]]

−	{{DISPLAYTITLE:import()}}	+	{{DISPLAYTITLE:import}}

← Older revision		Revision as of 18:23, 20 June 2017
Line 1:		Line 1:
−	{{DISPLAYTITLE:~~API:~~import()}}	+	{{DISPLAYTITLE:'import()'}}

	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.		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.

← Older revision		Revision as of 18:22, 20 June 2017
Line 1:		Line 1:
−	{{~~lowercase title~~}}	+	{{DISPLAYTITLE:API:import()}}

	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.		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.

@@ Line 19: / Line 19: @@
 <syntaxhighlight>
-import { from, Delegate, Music, Scene } from 'miniRT';
+import { from, Delegate, Music, Scene } from 'sphere-runtime';
-Music.play('sounds/music/somefile.ogg'); //Use the imported Music function
+Music.play('music/somefile.ogg'); //Use the imported Music object
 </syntaxhighlight>
 [[Category:Sphere 2 API]]
 [[Category:Sphere 2 native functions]]

@@ Line 1: / Line 1: @@
 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.
@@ Line 24: / Line 26: @@
 [[Category:Sphere 2 API]]
 [[Category:Sphere 2 native functions]]