Commit Graph

789 Commits

Author SHA1 Message Date
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