From 2be7029b5063a606b3bf50b786d33e35dcde77f2 Mon Sep 17 00:00:00 2001 From: phyzical <5182053+phyzical@users.noreply.github.com> Date: Mon, 1 Aug 2022 16:44:19 +0800 Subject: [PATCH] update mds, add missing deprecation notice hotfix/test-fixes File List: dist/bitburner.d.ts markdown/bitburner.singularity.md --- dist/bitburner.d.ts | 1 + markdown/bitburner.singularity.md | 108 +++++++++++++++--------------- 2 files changed, 54 insertions(+), 55 deletions(-) diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts index bb5ed7885..06b71388a 100644 --- a/dist/bitburner.d.ts +++ b/dist/bitburner.d.ts @@ -6800,6 +6800,7 @@ export declare interface TIX { /** * Short stocks. * @remarks + * @deprecated use sellShort * RAM cost: 2.5 GB * Attempts to purchase a short position of a stock using a Market Order. * diff --git a/markdown/bitburner.singularity.md b/markdown/bitburner.singularity.md index 9b88a27e5..a1f73252a 100644 --- a/markdown/bitburner.singularity.md +++ b/markdown/bitburner.singularity.md @@ -9,7 +9,7 @@ Singularity API Signature: ```typescript -export interface Singularity +export interface Singularity ``` ## Remarks @@ -18,58 +18,56 @@ This API requires Source-File 4 to use. The RAM cost of all these functions is m ## Methods -| Method | Description | -| --- | --- | -| [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | Apply for a job at a company. | -| [b1tflum3(nextBN, callbackScript)](./bitburner.singularity.b1tflum3.md) | b1t\_flum3 into a different BN. | -| [checkFactionInvitations()](./bitburner.singularity.checkfactioninvitations.md) | List all current faction invitations. | -| [commitCrime(crime)](./bitburner.singularity.commitcrime.md) | Commit a crime. | -| [connect(hostname)](./bitburner.singularity.connect.md) | Connect to a server. | -| [createProgram(program, focus)](./bitburner.singularity.createprogram.md) | Create a program. | -| [destroyW0r1dD43m0n(nextBN, callbackScript)](./bitburner.singularity.destroyw0r1dd43m0n.md) | Destroy the w0r1d\_d43m0n and move on to the next BN. | -| [donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) | Donate to a faction. | -| [getAugmentationCost(augName)](./bitburner.singularity.getaugmentationcost.md) | Get the price and reputation of an augmentation. | -| [getAugmentationPrereq(augName)](./bitburner.singularity.getaugmentationprereq.md) | Get the pre-requisite of an augmentation. | -| [getAugmentationPrice(augName)](./bitburner.singularity.getaugmentationprice.md) | Get price of an augmentation. | -| [getAugmentationRepReq(augName)](./bitburner.singularity.getaugmentationrepreq.md) | Get reputation requirement of an augmentation. | -| [getAugmentationsFromFaction(faction)](./bitburner.singularity.getaugmentationsfromfaction.md) | Get a list of augmentation available from a faction. | -| [getAugmentationStats(name)](./bitburner.singularity.getaugmentationstats.md) | Get the stats of an augmentation. | -| [getCharacterInformation()](./bitburner.singularity.getcharacterinformation.md) | Returns an object with various information about your character. | -| [getCompanyFavor(companyName)](./bitburner.singularity.getcompanyfavor.md) | Get company favor. | -| [getCompanyFavorGain(companyName)](./bitburner.singularity.getcompanyfavorgain.md) | Get company favor gain. | -| [getCompanyRep(companyName)](./bitburner.singularity.getcompanyrep.md) | Get company reputation. | -| [getCrimeChance(crime)](./bitburner.singularity.getcrimechance.md) | Get chance to successfully commit a crime. | -| [getCrimeStats(crime)](./bitburner.singularity.getcrimestats.md) | Get stats related to a crime. | -| [getCurrentServer()](./bitburner.singularity.getcurrentserver.md) | Get the current server. | -| [getDarkwebProgramCost(programName)](./bitburner.singularity.getdarkwebprogramcost.md) | Check the price of an exploit on the dark web | -| [getDarkwebPrograms()](./bitburner.singularity.getdarkwebprograms.md) | Get a list of programs offered on the dark web. | -| [getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) | Get faction favor. | -| [getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) | Get faction favor gain. | -| [getFactionRep(faction)](./bitburner.singularity.getfactionrep.md) | Get faction reputation. | -| [getOwnedAugmentations(purchased)](./bitburner.singularity.getownedaugmentations.md) | Get a list of owned augmentation. | -| [getStats()](./bitburner.singularity.getstats.md) | Returns an object with the Player’s stats. | -| [getUpgradeHomeCoresCost()](./bitburner.singularity.getupgradehomecorescost.md) | Get the price of upgrading home cores. | -| [getUpgradeHomeRamCost()](./bitburner.singularity.getupgradehomeramcost.md) | Get the price of upgrading home RAM. | -| [goToLocation(locationName)](./bitburner.singularity.gotolocation.md) | Go to a location. | -| [gymWorkout(gymName, stat, focus)](./bitburner.singularity.gymworkout.md) | Workout at the gym. | -| [hospitalize()](./bitburner.singularity.hospitalize.md) | Hospitalize the player. | -| [installAugmentations(cbScript)](./bitburner.singularity.installaugmentations.md) | Install your purchased augmentations. | -| [installBackdoor()](./bitburner.singularity.installbackdoor.md) | Run the backdoor command in the terminal. | -| [isBusy()](./bitburner.singularity.isbusy.md) | Check if the player is busy. | -| [isFocused()](./bitburner.singularity.isfocused.md) | Check if the player is focused. | -| [joinFaction(faction)](./bitburner.singularity.joinfaction.md) | Join a faction. | -| [manualHack()](./bitburner.singularity.manualhack.md) | Run the hack command in the terminal. | -| [purchaseAugmentation(faction, augmentation)](./bitburner.singularity.purchaseaugmentation.md) | Purchase an augmentation | -| [purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) | Purchase a program from the dark web. | -| [purchaseTor()](./bitburner.singularity.purchasetor.md) | Purchase the TOR router. | -| [quitJob(companyName)](./bitburner.singularity.quitjob.md) | Quit jobs by company. | -| [setFocus(focus)](./bitburner.singularity.setfocus.md) | Set the players focus. | -| [softReset(cbScript)](./bitburner.singularity.softreset.md) | Soft reset the game. | -| [stopAction()](./bitburner.singularity.stopaction.md) | Stop the current action. | -| [travelToCity(city)](./bitburner.singularity.traveltocity.md) | Travel to another city. | -| [universityCourse(universityName, courseName, focus)](./bitburner.singularity.universitycourse.md) | Take university class. | -| [upgradeHomeCores()](./bitburner.singularity.upgradehomecores.md) | Upgrade home computer cores. | -| [upgradeHomeRam()](./bitburner.singularity.upgradehomeram.md) | Upgrade home computer RAM. | -| [workForCompany(companyName, focus)](./bitburner.singularity.workforcompany.md) | Work for a company. | -| [workForFaction(faction, workType, focus)](./bitburner.singularity.workforfaction.md) | Work for a faction. | +| Method | Description | +| -------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | +| [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | Apply for a job at a company. | +| [b1tflum3(nextBN, callbackScript)](./bitburner.singularity.b1tflum3.md) | b1t\_flum3 into a different BN. | +| [checkFactionInvitations()](./bitburner.singularity.checkfactioninvitations.md) | List all current faction invitations. | +| [commitCrime(crime)](./bitburner.singularity.commitcrime.md) | Commit a crime. | +| [connect(hostname)](./bitburner.singularity.connect.md) | Connect to a server. | +| [createProgram(program, focus)](./bitburner.singularity.createprogram.md) | Create a program. | +| [destroyW0r1dD43m0n(nextBN, callbackScript)](./bitburner.singularity.destroyw0r1dd43m0n.md) | Destroy the w0r1d\_d43m0n and move on to the next BN. | +| [donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) | Donate to a faction. | +| [getAugmentationCost(augName)](./bitburner.singularity.getaugmentationcost.md) | Get the price and reputation of an augmentation. | +| [getAugmentationPrereq(augName)](./bitburner.singularity.getaugmentationprereq.md) | Get the pre-requisite of an augmentation. | +| [getAugmentationPrice(augName)](./bitburner.singularity.getaugmentationprice.md) | Get price of an augmentation. | +| [getAugmentationRepReq(augName)](./bitburner.singularity.getaugmentationrepreq.md) | Get reputation requirement of an augmentation. | +| [getAugmentationsFromFaction(faction)](./bitburner.singularity.getaugmentationsfromfaction.md) | Get a list of augmentation available from a faction. | +| [getAugmentationStats(name)](./bitburner.singularity.getaugmentationstats.md) | Get the stats of an augmentation. | +| [getCompanyFavor(companyName)](./bitburner.singularity.getcompanyfavor.md) | Get company favor. | +| [getCompanyFavorGain(companyName)](./bitburner.singularity.getcompanyfavorgain.md) | Get company favor gain. | +| [getCompanyRep(companyName)](./bitburner.singularity.getcompanyrep.md) | Get company reputation. | +| [getCrimeChance(crime)](./bitburner.singularity.getcrimechance.md) | Get chance to successfully commit a crime. | +| [getCrimeStats(crime)](./bitburner.singularity.getcrimestats.md) | Get stats related to a crime. | +| [getCurrentServer()](./bitburner.singularity.getcurrentserver.md) | Get the current server. | +| [getDarkwebProgramCost(programName)](./bitburner.singularity.getdarkwebprogramcost.md) | Check the price of an exploit on the dark web | +| [getDarkwebPrograms()](./bitburner.singularity.getdarkwebprograms.md) | Get a list of programs offered on the dark web. | +| [getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) | Get faction favor. | +| [getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) | Get faction favor gain. | +| [getFactionRep(faction)](./bitburner.singularity.getfactionrep.md) | Get faction reputation. | +| [getOwnedAugmentations(purchased)](./bitburner.singularity.getownedaugmentations.md) | Get a list of owned augmentation. | +| [getUpgradeHomeCoresCost()](./bitburner.singularity.getupgradehomecorescost.md) | Get the price of upgrading home cores. | +| [getUpgradeHomeRamCost()](./bitburner.singularity.getupgradehomeramcost.md) | Get the price of upgrading home RAM. | +| [goToLocation(locationName)](./bitburner.singularity.gotolocation.md) | Go to a location. | +| [gymWorkout(gymName, stat, focus)](./bitburner.singularity.gymworkout.md) | Workout at the gym. | +| [hospitalize()](./bitburner.singularity.hospitalize.md) | Hospitalize the player. | +| [installAugmentations(cbScript)](./bitburner.singularity.installaugmentations.md) | Install your purchased augmentations. | +| [installBackdoor()](./bitburner.singularity.installbackdoor.md) | Run the backdoor command in the terminal. | +| [isBusy()](./bitburner.singularity.isbusy.md) | Check if the player is busy. | +| [isFocused()](./bitburner.singularity.isfocused.md) | Check if the player is focused. | +| [joinFaction(faction)](./bitburner.singularity.joinfaction.md) | Join a faction. | +| [manualHack()](./bitburner.singularity.manualhack.md) | Run the hack command in the terminal. | +| [purchaseAugmentation(faction, augmentation)](./bitburner.singularity.purchaseaugmentation.md) | Purchase an augmentation | +| [purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) | Purchase a program from the dark web. | +| [purchaseTor()](./bitburner.singularity.purchasetor.md) | Purchase the TOR router. | +| [quitJob(companyName)](./bitburner.singularity.quitjob.md) | Quit jobs by company. | +| [setFocus(focus)](./bitburner.singularity.setfocus.md) | Set the players focus. | +| [softReset(cbScript)](./bitburner.singularity.softreset.md) | Soft reset the game. | +| [stopAction()](./bitburner.singularity.stopaction.md) | Stop the current action. | +| [travelToCity(city)](./bitburner.singularity.traveltocity.md) | Travel to another city. | +| [universityCourse(universityName, courseName, focus)](./bitburner.singularity.universitycourse.md) | Take university class. | +| [upgradeHomeCores()](./bitburner.singularity.upgradehomecores.md) | Upgrade home computer cores. | +| [upgradeHomeRam()](./bitburner.singularity.upgradehomeram.md) | Upgrade home computer RAM. | +| [workForCompany(companyName, focus)](./bitburner.singularity.workforcompany.md) | Work for a company. | +| [workForFaction(faction, workType, focus)](./bitburner.singularity.workforfaction.md) | Work for a faction. |