bitburner-src/doc/source/netscript/netscriptfunctions.rst
2021-06-02 21:28:07 -04:00

99 lines
4.2 KiB
ReStructuredText

.. _netscriptfunctions:
Netscript Basic Functions
=========================
This page contains the complete documentation for all functions that are available in Netscript.
This includes information such as function signatures, what they do, and their return values.
.. toctree::
:caption: Functions:
hack() <basicfunctions/hack>
grow() <basicfunctions/grow>
weaken() <basicfunctions/weaken>
hackAnalyzeThreads() <basicfunctions/hackAnalyzeThreads>
hackAnalyzePercent() <basicfunctions/hackAnalyzePercent>
hackChance() <basicfunctions/hackChance>
growthAnalyze() <basicfunctions/growthAnalyze>
sleep() <basicfunctions/sleep>
print() <basicfunctions/print>
tprint() <basicfunctions/tprint>
clearLog() <basicfunctions/clearLog>
disableLog() <basicfunctions/disableLog>
enableLog() <basicfunctions/enableLog>
isLogEnabled() <basicfunctions/isLogEnabled>
getScriptLogs() <basicfunctions/getScriptLogs>
tail() <basicfunctions/tail>
scan() <basicfunctions/scan>
nuke() <basicfunctions/nuke>
brutessh() <basicfunctions/brutessh>
ftpcrack() <basicfunctions/ftpcrack>
relaysmtp() <basicfunctions/relaysmtp>
httpworm() <basicfunctions/httpworm>
sqlinject() <basicfunctions/sqlinject>
run() <basicfunctions/run>
exec() <basicfunctions/exec>
spawn() <basicfunctions/spawn>
kill() <basicfunctions/kill>
killall() <basicfunctions/killall>
exit() <basicfunctions/exit>
scp() <basicfunctions/scp>
ls() <basicfunctions/ls>
ps() <basicfunctions/ps>
hasRootAccess() <basicfunctions/hasRootAccess>
getHostname() <basicfunctions/getHostname>
getHackingLevel() <basicfunctions/getHackingLevel>
getHackingMultipliers() <basicfunctions/getHackingMultipliers>
getHacknetMultipliers() <basicfunctions/getHacknetMultipliers>
getPlayer() <basicfunctions/getPlayer>
getServerMoneyAvailable() <basicfunctions/getServerMoneyAvailable>
getServerMaxMoney() <basicfunctions/getServerMaxMoney>
getServerGrowth() <basicfunctions/getServerGrowth>
getServerSecurityLevel() <basicfunctions/getServerSecurityLevel>
getServerBaseSecurityLevel() <basicfunctions/getServerBaseSecurityLevel>
getServerMinSecurityLevel() <basicfunctions/getServerMinSecurityLevel>
getServerRequiredHackingLevel() <basicfunctions/getServerRequiredHackingLevel>
getServerNumPortsRequired() <basicfunctions/getServerNumPortsRequired>
getServerMaxRam() <basicfunctions/getServerMaxRam>
getServerUsedRam() <basicfunctions/getServerUsedRam>
serverExists() <basicfunctions/serverExists>
fileExists() <basicfunctions/fileExists>
isRunning() <basicfunctions/isRunning>
getPurchasedServerCost() <basicfunctions/getPurchasedServerCost>
purchaseServer() <basicfunctions/purchaseServer>
deleteServer() <basicfunctions/deleteServer>
getPurchasedServers() <basicfunctions/getPurchasedServers>
getPurchasedServerLimit() <basicfunctions/getPurchasedServerLimit>
getPurchasedServerMaxRam() <basicfunctions/getPurchasedServerMaxRam>
write() <basicfunctions/write>
tryWrite() <basicfunctions/tryWrite>
read() <basicfunctions/read>
peek() <basicfunctions/peek>
clear() <basicfunctions/clear>
getPortHandle() <basicfunctions/getPortHandle>
rm() <basicfunctions/rm>
scriptRunning() <basicfunctions/scriptRunning>
scriptKill() <basicfunctions/scriptKill>
getScriptName() <basicfunctions/getScriptName>
getScriptRam() <basicfunctions/getScriptRam>
getRunningScript() <basicfunctions/getRunningScript>
getHackTime() <basicfunctions/getHackTime>
getGrowTime() <basicfunctions/getGrowTime>
getWeakenTime() <basicfunctions/getWeakenTime>
getScriptIncome() <basicfunctions/getScriptIncome>
getScriptExpGain() <basicfunctions/getScriptExpGain>
getTimeSinceLastAug() <basicfunctions/getTimeSinceLastAug>
sprintf() <basicfunctions/sprintf>
vsprintf() <basicfunctions/vsprintf>
nFormat() <basicfunctions/nFormat>
tFormat() <basicfunctions/tFormat>
prompt() <basicfunctions/prompt>
wget() <basicfunctions/wget>
getFavorToDonate() <basicfunctions/getFavorToDonate>
flags() <basicfunctions/flags>
.. toctree::
:caption: Deprecated:
getServerRam() <basicfunctions/getServerRam>