Difference between revisions of "Legacy:RequireScript"
(created from http://web.archive.org/web/20120327155800/http://spheredev.org/wiki/RequireScript) |
(filled) |
||
| Line 1: | Line 1: | ||
| − | + | The RequireScript(filename) command will do the same thing as the [[API:EvaluateScript|EvaluateScript]](filename) command, except it will only allow each filename to be loaded once. The purpose of this is to prevent a particular script from being loaded multiple times, wasting resources and possibly causing other problems, but still giving the programmer the option of using a script which might or might not have been previously loaded. In particular, this is useful if there are multiple programmers working on different systems for a game, and will need to combine them into the final project afterwards, or if the programmer is making generic scripts that will be useful in other games. | |
| − | |||
| − | The RequireScript(filename) command will do the same thing as the EvaluateScript(filename) command, except it will only allow each filename to be loaded once. The purpose of this is to prevent a particular script from being loaded multiple times, wasting resources and possibly causing other problems, but still giving the programmer the option of using a script which might or might not have been previously loaded. In particular, this is useful if there are multiple programmers working on different systems for a game, and will need to combine them into the final project afterwards, or if the programmer is making generic scripts that will be useful in other games. | ||
__TOC__ | __TOC__ | ||
==Usage== | ==Usage== | ||
| − | {{Usage | + | {{Usage|func=RequireScript|params=filename}} |
| − | * ''' | + | * '''filename''' string. The name of the file containing the code to be executed. |
| − | |||
| − | |||
==Examples== | ==Examples== | ||
| − | ( | + | Note that the following example is fictional; it's likely you don't have either JS file that are used in the example, unless you specifically made them. |
| + | |||
| + | <syntaxhighlight> | ||
| + | RequireScript("intro.js"); | ||
| + | RequireScript("game_menu.js"); | ||
| + | |||
| + | function game() | ||
| + | { | ||
| + | //A function contained in "intro.js" | ||
| + | Intro(); | ||
| + | //A function contained in "game_menu.js" | ||
| + | GameMenu(); | ||
| + | } | ||
| + | </syntaxhighlight> | ||
==Notes== | ==Notes== | ||
| − | + | See [[API:EvaluateScript|EvaluateScript]] for more details. | |
==See also== | ==See also== | ||
| − | * | + | * [[API:EvaluateScript|EvaluateScript]](filename) |
| − | * | + | * [[API:EvaluateSystemScript|EvaluateSystemScript]](filename) |
| − | * | + | * [[API:RequireSystemScript|RequireSystemScript]](filename) |
| − | + | ||
| + | {{API:Script/navbox}} | ||
Latest revision as of 02:21, 2 June 2013
The RequireScript(filename) command will do the same thing as the EvaluateScript(filename) command, except it will only allow each filename to be loaded once. The purpose of this is to prevent a particular script from being loaded multiple times, wasting resources and possibly causing other problems, but still giving the programmer the option of using a script which might or might not have been previously loaded. In particular, this is useful if there are multiple programmers working on different systems for a game, and will need to combine them into the final project afterwards, or if the programmer is making generic scripts that will be useful in other games.
Contents
Usage
- filename string. The name of the file containing the code to be executed.
Examples
Note that the following example is fictional; it's likely you don't have either JS file that are used in the example, unless you specifically made them.
RequireScript("intro.js");
RequireScript("game_menu.js");
function game()
{
//A function contained in "intro.js"
Intro();
//A function contained in "game_menu.js"
GameMenu();
}Notes
See EvaluateScript for more details.
See also
- EvaluateScript(filename)
- EvaluateSystemScript(filename)
- RequireSystemScript(filename)
