bitburner-src/doc/source/netscript/netscriptfunctions.rst

99 lines
4.2 KiB
ReStructuredText
Raw Normal View History

2018-12-04 02:20:58 +01:00
.. _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>
2021-06-03 03:28:07 +02:00
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>
v0.51.6 (#905) * Make command `cd` without arguments an alias for `cd /` (#853) In most shells `cd` without arguments takes you to the home directory of the current user. I keep trying to do this due to muscle memory from working in terminals, so I figured I'd make it do something useful. There is no home directory in the game, but going to / is the closest thing we have, since that is the starting point for the user in the game. * Add new `backdoor` terminal command (#852) * Add the backdoor command to the terminal This command will perform a manual hack without rewarding money. It will be used for the story, mainly for faction hacking tests * Add tab completion for backdoor command * Add help text for backdoor command * Change condition syntax to be more consistent with others * Extract reused code block so it is always called after actions * Update documentation for new backdoor command Modified references to manual hack as it isn't for factions anymore * Remove extra parenthesis * Rename manuallyHacked to backdoorInstalled * Fix typo * Change faction test messages to use backdoor instad of hack * Rename more instances of manuallyHacked * fixed typo in helptext of darkweb buy (#858) * Fix typos and unify descriptions of augmentations (#859) Made an attempt to... - give all "+rep% company/faction" the same text - make all augmentations with a single effect use a single line to describe the effect - make all effects end with a period * Made Cashroot starter kit display its tooltip with the money formatted properly and in gold * fix typo in docs (#860) * Initial code for Casino Card Deck implementation * Casino Blackjack Implementation * Update some tools (eslint, typescript) * Blackjack code cleanup * Update README_contribution * Update ScriptHelpers.js (#861) expand error message * More augmentation typo fixes (#862) * Add Netscript function getCurrentScript (#856) Add netscript function that returns the current script. * Added milestones menu to guide new players. (#865) Milestone menu * fix typos in milestones (#866) Co-authored-by: sschmidTU <s.schmid@phonicscore.com> * Corrupt location title when backdoor is installed (#864) * Add corruptableText component * Corrupt location title if backdoor is installed * Formatting * Add helper to check value of backdoorInstalled Helper could be oneline but it would make it less readable * Fix some formatting * Add settings option to disable text effects * Import useState * getRunningScript (#867) * Replaced getCurrentScript with getRunningScript * Bunch of smaller fixes (#904) Fix #884 Fix #879 Fix #878 Fix #876 Fix #874 Fix #873 Fix #887 Fix #891 Fix #895 * rework the early servers to be more noob friendly (#903) * v0.51.6 Co-authored-by: Andreas Eriksson <2691182+AndreasTPC@users.noreply.github.com> Co-authored-by: Jack <jackdewinter1@gmail.com> Co-authored-by: Teun Pronk <5228255+Crownie88@users.noreply.github.com> Co-authored-by: Pimvgd <Pimvgd@gmail.com> Co-authored-by: Daniel Xie <daniel.xie@flockfreight.com> Co-authored-by: Simon <33069673+sschmidTU@users.noreply.github.com> Co-authored-by: sschmidTU <s.schmid@phonicscore.com>
2021-04-29 02:07:26 +02:00
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>
2021-04-21 14:20:26 +02:00
flags() <basicfunctions/flags>
.. toctree::
:caption: Deprecated:
getServerRam() <basicfunctions/getServerRam>