Commit Graph

322 Commits

Author SHA1 Message Date
Olivier Gagnon
12d5f55aec unknown-ify the rest of the basic API. 2022-03-29 22:14:56 -04:00
Olivier Gagnon
aa0425a23d unknown-ify half the basic API. 2022-03-29 21:42:27 -04:00
Olivier Gagnon
bbbaa89f74 unknown-ify singularity API 2022-03-29 20:05:40 -04:00
Olivier Gagnon
725c8234c9 unknown-ify the singularity API. 2022-03-29 19:49:37 -04:00
Olivier Gagnon
a6e256ad5a Step 1 of moving singularity functions 2022-03-29 17:48:45 -04:00
Olivier Gagnon
24ede1c68d allbuild commit /usr/bin/git 2022-03-29 15:49:31 -04:00
Olivier Gagnon
443b0b6a89 rename functions in staneks gift 2022-03-29 14:20:40 -04:00
Olivier Gagnon
680081c548 post-grafting changes 2022-03-29 14:09:17 -04:00
hydroflame
fb1bce579f
Merge pull request #3170 from nickofolas/feature/grafting
[Feature] Grafting
2022-03-29 13:25:41 -04:00
nickofolas
bd3f256536 Update doc for some grafting API funcs 2022-03-27 15:44:25 -04:00
nickofolas
3b32811f5e Grafting API RAM cost & doc update 2022-03-27 15:33:31 -04:00
phyzical
7c5097ee83 added ns functions
* refactored out logic to be reused by api
2022-03-27 15:53:13 +08:00
DavidGrinberg
4497fbdda0
Update documentation for purchaseTor
Reflect the changes to the logic
2022-03-25 23:02:23 -04:00
nickofolas
3476f0f0eb Grafting API (no RAM costs yet) 2022-03-23 12:35:15 -05:00
Olivier Gagnon
fb7c65957d Added dark web functions to ns api 2022-03-20 22:49:46 -04:00
Olivier Gagnon
00d1d294ed fix lint errors 2022-03-20 22:14:32 -04:00
hydroflame
7e3a5e76c3
Merge pull request #3193 from t-wolfeadam/feature/corp-api-bonustime
Implement getBonusTime in Corporation API
2022-03-20 14:13:35 -04:00
t.wolfeadam
5702cb04b6 Implement getBonusTime in Corporation
Used documentation from other 'getBonusTime' methods
2022-03-19 15:22:29 -05:00
parax
ac38e715aa Fixed Lint Errors 2022-03-18 22:52:09 -06:00
parax
e46c67a78a Added NS functions to buy WSE and TIX 2022-03-18 21:58:18 -06:00
Olivier Gagnon
3cdf0452a4 fix up the new prompt UI 2022-03-17 16:44:44 -04:00
hydroflame
83ef5a940b
Merge branch 'dev' into prompt-additions 2022-03-17 15:38:13 -04:00
Master-Guy
eb847d1580 Fix typo 2022-03-17 13:25:47 +01:00
phyzical
3cbb926fd8 expose the inBladeburner on the player object 2022-03-12 12:36:47 +08:00
hydroflame
b7ffdeb5e2
Merge pull request #3076 from ApamNapat/turned_two_eslint_rules_on
Trailing whitespace and files not ending with \n are now illegal
2022-03-10 22:12:17 -05:00
hydroflame
9d080c9901
Merge pull request #2934 from phyzical/bugfix/1955
added check for NS interface with user defined guard
2022-03-10 21:44:37 -05:00
BB
2f4d879c16 Trailing whitespace and files not ending with \n are now illegal 2022-03-08 22:51:02 +01:00
hydroflame
92909689b3
Merge pull request #2891 from tigercat2000/autocomplete_documentation
Terminal: There is now an interface definition for the autocomplete() 'data' argument.
2022-03-08 16:34:57 -05:00
hydroflame
1ceb8b24f6
Merge pull request #3067 from phyzical/hotfix/2951
added CorporationSoftCap to NetscriptDefinitions
2022-03-08 16:32:28 -05:00
hydroflame
4921cdea24
Merge branch 'dev' into phyzical/Corp-Api-Updates 2022-03-07 17:44:43 -05:00
phyzical
bdca45388d added CorporationSoftCap to NetscriptDefinitions 2022-03-05 12:49:32 +08:00
hydroflame
14fef142c5
Merge pull request #3047 from DJ-Laser/patch-1
Fix typo (await ed => awaited)
2022-03-01 10:49:40 -05:00
hydroflame
213b03523b
Merge pull request #2869 from SagePtr/patch-1
Fix ps documentation
2022-03-01 10:47:58 -05:00
hydroflame
6a1af43555
Merge pull request #2972 from factubsio/patch-2
Clarify units for RunningScript.*RunningTime
2022-03-01 10:38:26 -05:00
hydroflame
fe20a98763
Merge pull request #2983 from factubsio/patch-4
Clarify some of the fields in `GangMemberInfo`
2022-03-01 10:36:44 -05:00
hydroflame
c5c48a96b3
Merge pull request #3033 from ChrissiQ/fix-documentation-stopaction-add-gym
📝  (TSDoc Definitions) Add gym workout to stopAction actions.
2022-03-01 10:32:59 -05:00
DJ_Laser
f3f86ff102
Fix typo (await ed => awaited)
I fixed a typo.
2022-02-28 13:48:09 -05:00
ChrissiQ
8ab5ff9565 📝 (TSDoc Definitions) Add gym workout to stopAction actions. 2022-02-24 14:57:05 -07:00
ChrissiQ
a2fd6736f4 📝 (TSDoc Definitions) Inherits doc for overloaded NS methods.
The overloaded methods `NS.kill()`, `NS.getScriptExpGain()`,
`NS.getScriptIncome()`, and `NS.scp()` have broken documentation because the
overloaded function is not documented correctly. I've added `@inheritDoc` tags to
the declarations in order to associate the documentation to the overloaded method.

As shown in these files with broken documentation:
https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.ns.kill_1.md
https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.ns.scp_1.md
https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.ns.getscriptexpgain_1.md
https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.ns.getscriptincome_1.md
2022-02-22 18:36:30 -07:00
Jonathan Beverley
922aafb115 Expose product and material details in API match UI 2022-02-17 23:49:59 -05:00
phyzical
a2b4a63c2e merge latest dev 2022-02-15 20:24:24 +08:00
factubsio
5193ff3156
Clarify some of the fields in GangMemberInfo
The most misleading of these is `str_mult`, which is actually the multiplier from equipment.
2022-02-14 20:00:49 +00:00
factubsio
7902699f99
Clarify units for RunningScript.*RunningTime
Most other times are specified in milliseconds, rather than the seconds used for the running time - this should be made clear in the docs.
2022-02-13 22:22:03 +00:00
phyzical
e8954bc1ee added basic type check to tryWritePort 2022-02-07 22:14:48 +08:00
tigercat2000
f0557eadf7
Terminal: There is now an interface definition for the autocomplete() 'data' argument. 2022-01-31 20:47:15 -08:00
Phil
378f67097c Amending NetscriptDefinitions 2022-01-31 18:15:13 +00:00
Sage Pointer
ac054b0065
Fix ps documentation 2022-01-29 22:20:27 +02:00
smolgumball
d3ac29609d Merge branch 'dev' into add-ns-getRecentScripts 2022-01-29 10:11:55 -07:00
Matthew Thornton
48d4f698c2
Spelling fixes in comments
This just fixes some misspelling in the comments, doesn't change any code or variables.
2022-01-28 14:57:52 -06:00
smolgumball
2add4e9112 Merge branch 'dev' into add-ns-getRecentScripts 2022-01-26 19:07:02 -07:00
hydroflame
1a34d5e363
Merge pull request #2703 from lethern/patch-1
purchaseServer error message fix + small docs change
2022-01-26 00:50:42 -05:00
hydroflame
ae2c6a4c7c
Merge pull request #2737 from pd/crimestats-name
NetscriptDefinitions: Fix type of CrimeStats.name
2022-01-26 00:49:04 -05:00
hydroflame
77ba45df40
Merge pull request #2735 from Ninetailed/ns_printf
Add ns.printf function
2022-01-26 00:45:18 -05:00
hydroflame
2ecc71ba28
Merge pull request #2738 from pd/corp-jsdoc
NetscriptDefinitions: fix jsdoc for Corp research functions
2022-01-26 00:44:43 -05:00
hydroflame
bbef8452b3
Merge pull request #2771 from zeddrak/patch-3
Documentation edit in response to Issue #2678
2022-01-26 00:40:28 -05:00
hydroflame
13453e678f
Merge pull request #2809 from pd/corp-api-leftovers
Corp API: Add setSmartSupplyUseLeftovers
2022-01-26 00:31:58 -05:00
Alex Aubuchon
6342ccbad5 Indicate that getRunningScript can return null 2022-01-25 18:28:47 -05:00
Phil Despotos
65ffbcc27e Corp API: Add setSmartSupplyUseLeftovers
The API can already toggle smart supply on/off, but can't manage the
related controls for whether smart supply will draw from the existing
materials in the warehouse. Without it, we can't keep some resources in
storage to boost the production multiplier without disabling smart
supply entirely.
2022-01-25 12:51:07 -06:00
zeddrak
56fe63cdd5
In response to Issue #2678
Added some clarifications in response to Issue #2678.
Did not rebuild the md files (I didn't want to cause unnecessary file conflicts).
2022-01-22 21:41:53 -08:00
Kyle Hargraves
b7604709e5 NetscriptDefinitions: fix jsdoc for Corp research functions 2022-01-21 07:37:16 -06:00
Kyle Hargraves
267a7144cb Fix type of CrimeStats.name 2022-01-21 07:32:39 -06:00
Terrana
f2c4109211
Add ns.printf function
Behaviour is consistent with that of tprintf versus tprint and
should be equivalent to ns.print(ns.sprintf(...))
2022-01-21 12:08:47 +00:00
smolgumball
1a6300b287 Cleanup @usage docs 2022-01-19 13:32:07 -07:00
smolgumball
74e2acfa6f Add ns.getRecentScripts() 2022-01-19 00:04:48 -07:00
phyzical
71ac4aacf1 updated buyback and sells functions docs 2022-01-19 08:25:12 +08:00
Olivier Gagnon
69cf98ff34 doc 2022-01-18 19:12:52 -05:00
hydroflame
bb34d6b582
Merge pull request #2618 from pigalot/Corp-Api-Updates
Corp api updates
2022-01-18 18:05:23 -05:00
Olivier Gagnon
05cbc25a8f 1.4 2022-01-18 14:03:24 -05:00
lethern
1dcae1aeec
Update NetscriptDefinitions.d.ts
grow/weaken/hack: removed threads part from example - confuses newbies
2022-01-18 16:15:40 +01:00
hydroflame
574c541b2e
Merge pull request #2656 from SagePtr/patch-2
Minor fix to growth parameter description
2022-01-17 15:56:35 -05:00
hydroflame
b5357ec04e
Merge pull request #2665 from MartinFournier/feature/ns-ui-getgameinfo
Add ns.ui.getGameInfo() to retrieve game version
2022-01-17 15:53:43 -05:00
phyzical
6f2924dc0d generated docs 2022-01-17 18:24:42 +08:00
phyzical
d50e199171 added buybackShares, sellShares and bulkPurchase 2022-01-17 18:03:29 +08:00
pigalot
d34d720ab9 Office Size Upgrade Cost 2022-01-16 16:12:03 +00:00
pigalot
2246dd7fe6 Update src/ScriptEditor/NetscriptDefinitions.d.ts
Co-authored-by: Jack <phyzicaly@hotmail.com>
2022-01-16 16:12:00 +00:00
pigalot
4562102448 Fix for js docs 2022-01-16 16:11:32 +00:00
pigalot
62f40b3dc1 Add bribe 2022-01-16 16:11:32 +00:00
pigalot
ea88f5f150 spelling mistake 2022-01-16 16:11:32 +00:00
pigalot
6533913b3b add docs for create corp self fund 2022-01-16 16:11:32 +00:00
pigalot
19ecda1607 Fix doc bug 2022-01-16 16:11:32 +00:00
pigalot
1384b86810 Added better job assignment function, and fix docs 2022-01-16 16:11:32 +00:00
pigalot
98e8910c3a Research func, gopublic function, and validation 2022-01-16 16:11:31 +00:00
pigalot
2269f79b15 Add investments to the api 2022-01-16 16:11:31 +00:00
pigalot
1b8c715a5e Add costs and count function for ads 2022-01-16 16:11:31 +00:00
pigalot
74019bc2be Make list of divisions accessable on the corp 2022-01-16 16:11:31 +00:00
pigalot
360b8d8d16 Add has corp to the api player object 2022-01-16 16:11:31 +00:00
pigalot
e2bb76ae6d Add createCorp 2022-01-16 16:11:31 +00:00
Martin Fournier
739294da1d Remove duplicated 'cost' keyword for RAM cost.
Only some of the entries had this, so I assume they were introduced by a bad find & replace.
2022-01-16 10:51:34 -05:00
Martin Fournier
07403eaaaa Add ns.ui.getGameInfo() to retrieve game version
Returns { version, commit, platform }
2022-01-16 10:49:01 -05:00
Sage Pointer
32982f4ee8
Minor fix to growth parameter description 2022-01-16 04:44:50 +02:00
Olivier Gagnon
8b69fd7faa doc 2022-01-15 18:39:37 -05:00
hydroflame
f1c2dc2693 Merge pull request #2650 from BuckAMayzing/update-hacknet-constant-typing
Fix `constants()` function typing for hacknet nodes/servers
2022-01-15 18:29:13 -05:00
hydroflame
c0f6399a96
Merge pull request #2590 from deathly809/feature/ns_support_rm
Add support for the mv command in NS
2022-01-15 18:26:31 -05:00
hydroflame
7a84fa4d29
Merge pull request #2591 from nickofolas/improvement/singularity-focus-args
Add focus arg to Singularity functions
2022-01-15 18:25:56 -05:00
hydroflame
0b36c9a4b2
Merge pull request #2648 from SlyCedix/scp-def
Add function signature for scp(files, destination)
2022-01-15 18:23:56 -05:00
Olivier Gagnon
58fa091dd5 fix mc 2022-01-15 17:53:19 -05:00
Olivier Gagnon
de64777c75 some chagens 2022-01-15 17:52:50 -05:00
hydroflame
f621dd4a14
Merge branch 'dev' into documentation-updates 2022-01-15 17:47:17 -05:00
Buck Mayzes
71fa6dd2fd Fix constants() function typing for hacknet nodes/servers 2022-01-15 17:03:17 -05:00
Cyn
78fa85a24e Add function signature for scp(files, destination) 2022-01-15 16:28:58 -05:00
Olivier Gagnon
5126d72742 rm some stuff from netdef to make it work in-game 2022-01-13 14:26:05 -05:00
hydroflame
d274e21a10
Merge pull request #2596 from MartinFournier/feature/ns-ui-styles
Add ns.ui.[getStyles, setStyles, resetStyles]
2022-01-12 19:18:54 -05:00
Martin Fournier
9b638b911f Add ns.ui.[getStyles, setStyles, resetStyles]
Adds three Netscript functions to manipulate the user's styles like the
player can with theme.
2022-01-12 18:34:05 -05:00
nickofolas
415f922a37 Add focus arg to Singularity functions 2022-01-12 12:03:49 -06:00
Jeffrey A. Robinson
bedea0ac73 Add support for the mv command in NS 2022-01-12 09:53:54 -08:00
Andriy Mykhaylyk
d2ea934c8e
change defs 2022-01-12 13:51:21 +01:00
daan flore
66fbec5365 Cleanup of code 2022-01-10 22:33:50 +01:00
daan flore
51edac414e Adding IPort interface and correcting return value of getPortHandle in NetscriptDefinitions file 2022-01-10 22:31:30 +01:00
Russell Stringer
a16fad7f01 Add documentation about using PID for some ns functions
Fixes #2219
2022-01-10 16:23:06 -05:00
Russell Stringer
3276cf3c32 Add documentation for NetscriptPort to NetscriptDefinitions 2022-01-10 16:23:06 -05:00
Russell Stringer
26ae4345cf Try to clear up confusing documentation for TIX.getOrders()
api-documenter won't generate property lists for [key: string]: type
interfaces, so I tried to put explanations and @links in the appropriate
remarks sections.

Since the list of stock symbols is known, this could also be fixed by
setting each symbol as an optional property of the StockOrder interface

Fixes #2269
2022-01-10 16:23:06 -05:00
Russell Stringer
2989306ac8 Add (in GB) note to params/return values documentation where missing
fixes #2403
2022-01-10 16:23:06 -05:00
Russell Stringer
cfa1b9e236 adds missing bitnode mults to definitions file
fixes #2424
2022-01-10 16:23:06 -05:00
zeddrak
02e9ae6e8e
Commit Crime Returns updated
Updated the text for the return value of commitCrime to match the description (and not the create programs hold-over)
2022-01-10 02:58:16 -08:00
Olivier Gagnon
d8a5f5b03c many fixes 2022-01-09 15:24:32 -05:00
nickofolas
357258261a Use codeblocks for null 2022-01-08 14:59:28 -06:00
nickofolas
a971921417 Document null duration for toasts 2022-01-08 14:56:29 -06:00
Olivier Gagnon
fb90e21a31 Merge branch 'dev' of github.com:danielyxie/bitburner into dev 2022-01-08 13:19:44 -05:00
Olivier Gagnon
5a1cabdb34 typo 2022-01-08 13:19:35 -05:00
Jens
ede37767ac Doc formatting updates & fixing a few spelling errors. 2022-01-06 20:52:15 -08:00
tigercat2000
6e96428643
Update print and tprint signatures to match code
In https://github.com/danielyxie/bitburner/pull/1380, print() and
tprint() were both changed to allow for variadic arguments, but this
wasn't documented in NetscriptDefinitions.d.ts.
2022-01-06 04:13:36 -08:00
Martin Fournier
c9ca1e9d37 Add ns.ui.setTheme() and ns.ui.resetTheme() 2022-01-04 20:33:18 -05:00
Woody Lam
d7cd5b0d96 Fix #2230 typo (again) 2022-01-04 22:40:41 +00:00
Olivier Gagnon
dfae337d26 Merge branch 'dev' of github.com:danielyxie/bitburner into dev 2022-01-03 15:49:05 -05:00
hydroflame
69ed320b93
Merge pull request #2287 from daanflore/dev
Saw in vscode that some typedefenitions where not the same as how they work in the game
2022-01-03 15:44:08 -05:00
hydroflame
8e0b5e3ecd
Merge pull request #2288 from pan-kuleczka/dev
ns.hackAnalyze definition fix to match markdown
2022-01-03 15:43:48 -05:00
Andriy Mykhaylyk
38923af436
fix ns.run args type definition 2022-01-03 16:10:22 +01:00
daan flore
8c851b577a Adding correct types at run args command 2022-01-02 20:40:57 +01:00
daan flore
74ee7f371d String value should also be possible to write 2022-01-02 19:24:16 +01:00
pan-kuleczka
62c19c9078 hackAnalyze definition fix to match markdown 2022-01-02 18:56:52 +01:00
daan flore
f8607ce73e Adding dorgotten typescript defenitions to file 2022-01-02 18:54:11 +01:00
hydroflame
a6be7ecc3e
Merge pull request #2243 from TheMas3212/dev
Add Function Call signatures to ns.kill so typescript is able to call ns.kill correctly
2022-01-02 11:39:56 -05:00
Brandon Bothell
dd4b548917
docs: comma for good measure 2022-01-02 02:40:03 -05:00
TheMas3212
8707dc7079
remove extra function signature for ns.kill() 2021-12-31 23:33:23 +11:00
TheMas3212
e3e1770439
Fix Typedef for getScriptIncome/getScriptExpGain
Current Typedef does not allow using the run with no arguments for
totals versions
2021-12-31 23:31:46 +11:00
TheMas3212
31ed5d8f64
Add Function Call signatures to ns.kill so typescript is able to call
ns.kill(pid)
previously it will fail to compile due to not providing a host argument
2021-12-31 10:58:56 +11:00
hydroflame
cc4f07d037
Merge pull request #2175 from Xynrati/patch-3
Removing old comment about removed parameter
2021-12-28 11:59:41 -05:00
Alexander Morland
aaf1ad4ae5
Fixed typo
needed to fix docs
2021-12-28 17:27:21 +01:00
Xynrati
26ab62eea6
More comments to be removed 2021-12-28 08:04:50 -08:00
hydroflame
9f9ce40ef0
Merge pull request #2179 from antonvmironov/fix-CorporationInfo.state
Fix CorporationInfo.state
2021-12-28 10:37:42 -05:00
ReeseJones
1087db9f33 changed setting to selling in getSaleGain 2021-12-26 14:35:46 -08:00
Anton Mironov
3dd818cb7b
Updating doc for CorporationInfo.state
Now includes a list of possible values.
2021-12-24 17:35:23 +01:00
Hedrauta
3eedd9df88 empty host = current host 2021-12-24 00:23:38 +01:00
TheMas3212
e0aaa383a4
modify BasicHGWOptions definition to mark threads parameter as optional
this is used by hack, grow and weaken all of which dont require it to be defined
2021-12-23 14:42:06 +11:00
hydroflame
bfdfee2a68
Merge branch 'dev' into mychanges 2021-12-22 16:16:24 -05:00
Olivier Gagnon
d2d6c33fc8 mychanges 2021-12-22 16:15:56 -05:00
hydroflame
fba2265cce
Merge pull request #2118 from Icehawk78/feat/add-ns2-examples-docs
Add ns2 examples to the netscript docs
2021-12-22 15:21:06 -05:00
Nicholas Galauxy
35cfa9492e Fix unintended spacing change 2021-12-22 13:38:32 -06:00
Nicholas Galauxy
ed4d4d091c Update docs to include NS2 examples 2021-12-22 13:36:44 -06:00
hydroflame
dbf8c788e0
Merge pull request #2111 from mikomyazaki/2027-documentation-updates
Documentation updates
2021-12-22 14:30:14 -05:00