mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-12-24 07:02:26 +01:00
Improved documentation for Netscript. Added a link to Netscript documentation in script editor
This commit is contained in:
parent
24eda61ae3
commit
708b800e36
@ -41,6 +41,19 @@
|
|||||||
display: inline-block;
|
display: inline-block;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#script-editor-netscript-doc-button {
|
||||||
|
float: right;
|
||||||
|
display: inline-block;
|
||||||
|
}
|
||||||
|
|
||||||
|
#script-editor-netscript-doc-warning {
|
||||||
|
background-color: #555;
|
||||||
|
color: #FFFFFF;
|
||||||
|
}
|
||||||
|
#script-editor-netscript-doc-warning:hover {
|
||||||
|
background-color: #666;
|
||||||
|
}
|
||||||
|
|
||||||
#script-editor-filename {
|
#script-editor-filename {
|
||||||
float: left;
|
float: left;
|
||||||
resize: none;
|
resize: none;
|
||||||
|
@ -14,6 +14,7 @@ p {
|
|||||||
}
|
}
|
||||||
|
|
||||||
h1 {
|
h1 {
|
||||||
|
font-size: 22px;
|
||||||
color: #66ff33;
|
color: #66ff33;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -139,7 +139,9 @@
|
|||||||
<div id="script-editor-container">
|
<div id="script-editor-container">
|
||||||
<div>
|
<div>
|
||||||
<p id="script-editor-filename-tag"> Script name: </p>
|
<p id="script-editor-filename-tag"> Script name: </p>
|
||||||
<span id="script-editor-save-and-close-button" float="right" class="a-link-button">Save & Close (Ctrl + b)</span>
|
<span id="script-editor-save-and-close-button" class="a-link-button">Save & Close (Ctrl + b)</span>
|
||||||
|
<span id="script-editor-netscript-doc-button" class="a-link-button"> Netscript Documentation
|
||||||
|
<p id="script-editor-netscript-doc-warning" style="font-size:12px"> Warning: You will lose unsaved content! </p> </span>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<input id="script-editor-filename" type="text" maxlength="30" tabindex="1"> </input>
|
<input id="script-editor-filename" type="text" maxlength="30" tabindex="1"> </input>
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
CONSTANTS = {
|
CONSTANTS = {
|
||||||
Version: "0.3",
|
Version: "0.4",
|
||||||
|
|
||||||
//Max level for any skill, assuming no multipliers. Determined by max numerical value in javascript for experience
|
//Max level for any skill, assuming no multipliers. Determined by max numerical value in javascript for experience
|
||||||
//and the skill level formula in Player.js. Note that all this means it that when experience hits MAX_INT, then
|
//and the skill level formula in Player.js. Note that all this means it that when experience hits MAX_INT, then
|
||||||
@ -203,7 +203,7 @@ CONSTANTS = {
|
|||||||
"top - Displays all active scripts and their RAM usage <br><br>",
|
"top - Displays all active scripts and their RAM usage <br><br>",
|
||||||
TutorialNetscriptText: "Netscript is a very simple programming language implemented for this game. The language has " +
|
TutorialNetscriptText: "Netscript is a very simple programming language implemented for this game. The language has " +
|
||||||
"your basic programming constructs and several built-in commands that are used to hack. <br><br>" +
|
"your basic programming constructs and several built-in commands that are used to hack. <br><br>" +
|
||||||
"<strong> Variables and data types </strong><br>" +
|
"<u><h1> Variables and data types </h1></u><br>" +
|
||||||
"The following data types are supported by Netscript: <br>" +
|
"The following data types are supported by Netscript: <br>" +
|
||||||
"numeric - Integers and floats (6, 10.4999)<br>" +
|
"numeric - Integers and floats (6, 10.4999)<br>" +
|
||||||
"string - Encapsulated by single or double quotes ('this is a string')<br>" +
|
"string - Encapsulated by single or double quotes ('this is a string')<br>" +
|
||||||
@ -214,7 +214,7 @@ CONSTANTS = {
|
|||||||
"In the first example above, we are creating the variable i and assigning it a value of 5. In the second, " +
|
"In the first example above, we are creating the variable i and assigning it a value of 5. In the second, " +
|
||||||
"we are creating the variable s and assigning it the value of a string. Note that all expressions must be " +
|
"we are creating the variable s and assigning it the value of a string. Note that all expressions must be " +
|
||||||
"ended with a semicolon. <br><br>" +
|
"ended with a semicolon. <br><br>" +
|
||||||
"<strong> Operators </strong> <br>" +
|
"<u><h1> Operators</h1> </u><br>" +
|
||||||
"The following operators are supported by Netscript: <br>" +
|
"The following operators are supported by Netscript: <br>" +
|
||||||
" +<br>" +
|
" +<br>" +
|
||||||
" -<br>" +
|
" -<br>" +
|
||||||
@ -229,7 +229,7 @@ CONSTANTS = {
|
|||||||
" >=<br>" +
|
" >=<br>" +
|
||||||
" ==<br>" +
|
" ==<br>" +
|
||||||
" !=<br><br>" +
|
" !=<br><br>" +
|
||||||
"<strong> Functions </strong><br>" +
|
"<u><h1> Functions </h1></u><br>" +
|
||||||
"You can NOT define you own functions in Netscript (yet), but there are several built in functions that " +
|
"You can NOT define you own functions in Netscript (yet), but there are several built in functions that " +
|
||||||
"you may use: <br><br> " +
|
"you may use: <br><br> " +
|
||||||
"<i>hack(hostname/ip)</i><br>Core function that is used to hack servers to steal money and gain hacking experience. The argument passed in must be a string with " +
|
"<i>hack(hostname/ip)</i><br>Core function that is used to hack servers to steal money and gain hacking experience. The argument passed in must be a string with " +
|
||||||
@ -237,28 +237,30 @@ CONSTANTS = {
|
|||||||
"<i>sleep(n)</i><br>Suspends the script for n milliseconds. <br>Example: sleep(5000);<br><br>" +
|
"<i>sleep(n)</i><br>Suspends the script for n milliseconds. <br>Example: sleep(5000);<br><br>" +
|
||||||
"<i>grow(hostname/ip)</i><br>Use your hacking skills to increase the amount of money available on a server. The argument passed in " +
|
"<i>grow(hostname/ip)</i><br>Use your hacking skills to increase the amount of money available on a server. The argument passed in " +
|
||||||
"must be a string with either the IP or hostname of the target server. <br> Example: grow('foodnstuff');<br><br>" +
|
"must be a string with either the IP or hostname of the target server. <br> Example: grow('foodnstuff');<br><br>" +
|
||||||
"<i>print(x)</i> <br> Prints a value or a variable to the scripts logs (which can be viewed with the 'tail [script]' terminal command <br><br>" +
|
"<i>print(x)</i> <br> Prints a value or a variable to the scripts logs (which can be viewed with the 'tail [script]' terminal command )<br><br>" +
|
||||||
"<i>nuke(hostname/ip)</i><br>Run NUKE.exe on the target server. NUKE.exe must exist on your home computer. <br> Example: nuke('foodnstuff'); <br><br>" +
|
"<i>nuke(hostname/ip)</i><br>Run NUKE.exe on the target server. NUKE.exe must exist on your home computer. <br> Example: nuke('foodnstuff'); <br><br>" +
|
||||||
"<i>brutessh(hostname/ip)</i><br>Run BruteSSH.exe on the target server. BruteSSH.exe must exist on your home computer <br> Example: brutessh('foodnstuff');<br><br>" +
|
"<i>brutessh(hostname/ip)</i><br>Run BruteSSH.exe on the target server. BruteSSH.exe must exist on your home computer <br> Example: brutessh('foodnstuff');<br><br>" +
|
||||||
"<i>ftpcrack(hostname/ip)</i><br>Run FTPCrack.exe on the target server. FTPCrack.exe must exist on your home computer <br> Example: ftpcrack('foodnstuff');<br><br>" +
|
"<i>ftpcrack(hostname/ip)</i><br>Run FTPCrack.exe on the target server. FTPCrack.exe must exist on your home computer <br> Example: ftpcrack('foodnstuff');<br><br>" +
|
||||||
"<i>relaysmtp(hostname/ip)</i><br>Run relaySMTP.exe on the target server. relaySMTP.exe must exist on your home computer <br> Example: relaysmtp('foodnstuff');<br><br>" +
|
"<i>relaysmtp(hostname/ip)</i><br>Run relaySMTP.exe on the target server. relaySMTP.exe must exist on your home computer <br> Example: relaysmtp('foodnstuff');<br><br>" +
|
||||||
"<i>httpworm(hostname/ip)</i><br>Run HTTPWorm.exe on the target server. HTTPWorm.exe must exist on your home computer <br> Example: httpworm('foodnstuff');<br><br>" +
|
"<i>httpworm(hostname/ip)</i><br>Run HTTPWorm.exe on the target server. HTTPWorm.exe must exist on your home computer <br> Example: httpworm('foodnstuff');<br><br>" +
|
||||||
"<i>sqlinject(hostname/ip)</i><br>Run SQLInject.exe on the target server. SQLInject.exe must exist on your home computer <br> Example: sqlinject('foodnstuff');<br><br>" +
|
"<i>sqlinject(hostname/ip)</i><br>Run SQLInject.exe on the target server. SQLInject.exe must exist on your home computer <br> Example: sqlinject('foodnstuff');<br><br>" +
|
||||||
"<strong>While loop </strong><br>" +
|
"<u><h1>While loops </h1></u><br>" +
|
||||||
"A while loop is a control flow statement that repeatedly executes code as long as a condition is met. <br><br> " +
|
"A while loop is a control flow statement that repeatedly executes code as long as a condition is met. <br><br> " +
|
||||||
"while (<i>[cond]</i>) {<br> <i>[code]</i><br>}<br><br>" +
|
"<i>while (<i>[cond]</i>) {<br> <i>[code]</i><br>}</i><br><br>" +
|
||||||
"As long as <i>[cond]</i> remains true, the code block <i>[code]</i> will continuously execute. Example: <br><br>" +
|
"As long as <i>[cond]</i> remains true, the code block <i>[code]</i> will continuously execute. Example: <br><br>" +
|
||||||
"i = 0; <br> while (i < 10) { <br> hack('foodnstuff');<br> i = i + 1;<br> }; <br><br>" +
|
"<i>i = 0; <br> while (i < 10) { <br> hack('foodnstuff');<br> i = i + 1;<br> }; </i><br><br>" +
|
||||||
"This code repeat the 'hack('foodnstuff')' command 10 times before it stops and exits. " +
|
"This code above repeats the 'hack('foodnstuff')' command 10 times before it stops and exits. <br><br>" +
|
||||||
|
"<i>while(true) { <br> hack('foodnstuff'); <br> }; </i><br><br> " +
|
||||||
|
"This while loop above is an infinite loop (continuously runs until the script is manually stopped) that repeatedly runs the 'hack('foodnstuff')' command. " +
|
||||||
"Note that a semicolon is needed at closing bracket of the while loop, UNLESS it is at the end of the code<br><br> " +
|
"Note that a semicolon is needed at closing bracket of the while loop, UNLESS it is at the end of the code<br><br> " +
|
||||||
"<strong>For loop</strong><br>" +
|
"<u><h1>For loops</h1></u><br>" +
|
||||||
"A for loop is another control flow statement that allows code to by repeated by iterations. The structure is: <br><br> " +
|
"A for loop is another control flow statement that allows code to by repeated by iterations. The structure is: <br><br> " +
|
||||||
"for (<i>[init]</i>; <i>[cond]</i>; <i>[post]</i>) {<br> <i>code</i> <br> }<br><br>" +
|
"<i>for (<i>[init]</i>; <i>[cond]</i>; <i>[post]</i>) {<br> <i>code</i> <br> }; </i><br><br>" +
|
||||||
"The <i>[init]</i> expression evaluates before the for loop begins. The for loop will continue to execute " +
|
"The <i>[init]</i> expression evaluates before the for loop begins. The for loop will continue to execute " +
|
||||||
"as long as <i>[cond]</i> is met. The <i>[post]</i> expression will evaluate at the end of every iteration " +
|
"as long as <i>[cond]</i> is met. The <i>[post]</i> expression will evaluate at the end of every iteration " +
|
||||||
"of the for loop. The following example shows code that will do the same thing as the while loop example above, " +
|
"of the for loop. The following example shows code that will do the same thing as the while loop example above, " +
|
||||||
"except using a for loop instead: <br><br>" +
|
"except using a for loop instead: <br><br>" +
|
||||||
"for (i = 0; i < 10; i = i+1) { <br> hack('foodnstuff');<br>}; <br><br><br>",
|
"<i>for (i = 0; i < 10; i = i+1) { <br> hack('foodnstuff');<br>}; </i><br><br><br>",
|
||||||
|
|
||||||
TutorialTravelingText:"There are six major cities in the world that you are able to travel to: <br><br> " +
|
TutorialTravelingText:"There are six major cities in the world that you are able to travel to: <br><br> " +
|
||||||
" Aevum<br>" +
|
" Aevum<br>" +
|
||||||
|
@ -10,6 +10,14 @@ function scriptEditorSaveCloseInit() {
|
|||||||
saveAndCloseScriptEditor();
|
saveAndCloseScriptEditor();
|
||||||
return false;
|
return false;
|
||||||
});
|
});
|
||||||
|
|
||||||
|
var netscriptDocButton = document.getElementById("script-editor-netscript-doc-button");
|
||||||
|
netscriptDocButton.addEventListener("click", function() {
|
||||||
|
Engine.loadTutorialContent();
|
||||||
|
Engine.displayTutorialContent();
|
||||||
|
Engine.displayTutorialPage(CONSTANTS.TutorialNetscriptText);
|
||||||
|
return false;
|
||||||
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
document.addEventListener("DOMContentLoaded", scriptEditorSaveCloseInit, false);
|
document.addEventListener("DOMContentLoaded", scriptEditorSaveCloseInit, false);
|
||||||
|
@ -110,6 +110,7 @@ var Engine = {
|
|||||||
document.getElementById("script-editor-filename").value = filename;
|
document.getElementById("script-editor-filename").value = filename;
|
||||||
}
|
}
|
||||||
document.getElementById("script-editor-text").value = code;
|
document.getElementById("script-editor-text").value = code;
|
||||||
|
|
||||||
Engine.currentPage = Engine.Page.ScriptEditor;
|
Engine.currentPage = Engine.Page.ScriptEditor;
|
||||||
},
|
},
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user