felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-28 03:47:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Minor fixes in and cleaning up typoes in license

Browse Source
This commit is contained in:
danielyxie
2018-03-03 15:22:50 -06:00
parent 2c68d17bc3
commit 99d774cf5a
7 changed files with 88 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/netscriptfunctions.rst
+17 -28
View File
@@ -742,7 +742,7 @@ rm
:param string fn: Filename of file to remove. Must include the extension
:returns: True if it successfully deletes the file, and false otherwise
Removes the specified file from the current server. This function works for every file type except message (.msg) files.
Removes the specified file from the current server. This function works for every file type except message (.msg) files.
scriptRunning
^^^^^^^^^^^^^
@@ -900,40 +900,34 @@ Functions should have some return value. Here is an example of defining and usin
return res;
}
print(sum([1, 2, 3, 4, 5]));
print(sum([1, 10]));
print(sum([1, 2, 3, 4, 5])); //Prints 15
print(sum([1, 10])); //Prints 11
The example above prints the following in its log::
15
11
For those with experience in other languages, especially Javascript it may be important to note that function declarations are not hoisted and must be declared BEFORE you use them.
For those with experience in other languages, especially Javascript, it may be important to note that
function declarations are not hoisted and must be declared BEFORE you use them.
For example, the following will cause an error saying `variable hello not defined`::
print(hello());
function hello() {
return "world";
}
Will cause an error saying `variable hello not defined` whereas::
The following will work fine::
function hello() {
return "world";
}
print(hello());
Will print out
world
print(hello()); //Prints out "world"
**Note about variable scope in functions:**
Functions can access "global" variables declared outside of the function's scope. However, they cannot change the value of any "global" variables.
Any changes to "global" variables will only be applied locally to the function.
Any changes to "global" variables will only be applied locally to the function.
The following example shows that any change to "global" variable inside a function only applies in the function's local scope::
The following example shows that any change to a "global" variable
from inside a function only applies in the function's local scope::
function foo() {
i = 5;
@@ -941,16 +935,12 @@ The following example shows that any change to "global" variable inside a functi
}
i = 0;
print(i);
print(i); //Prints 0
foo();
print(i);
print(i); //Prints 0
Results in the following log::
0
0
Furthermore, this also means that any variable that is first defined inside a function will NOT be accessible outside of the function as shown in the following example::
Furthermore, this also means that any variable that is first defined inside a
function will NOT be accessible outside of the function as shown in the following example::
function sum(values) {
res = 0;
@@ -970,7 +960,6 @@ results in the following runtime error::
variable res not defined
**Other Notes about creating your own functions:**
Defining a function does not create a Javascript function object in the underlying game code. This means that you cannot use any function