mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-12-18 12:15:44 +01:00
doc
This commit is contained in:
parent
f1c2dc2693
commit
8b69fd7faa
520
dist/bitburner.d.ts
vendored
520
dist/bitburner.d.ts
vendored
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
13
markdown/bitburner.bitnodemultipliers.gangsoftcap.md
Normal file
13
markdown/bitburner.bitnodemultipliers.gangsoftcap.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [GangSoftcap](./bitburner.bitnodemultipliers.gangsoftcap.md)
|
||||
|
||||
## BitNodeMultipliers.GangSoftcap property
|
||||
|
||||
Influences the respect gain and money gain of your gang.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
GangSoftcap: number;
|
||||
```
|
@ -37,6 +37,7 @@ export interface BitNodeMultipliers
|
||||
| [FactionWorkRepGain](./bitburner.bitnodemultipliers.factionworkrepgain.md) | number | Influences how much rep the player gains when performing work for a faction. |
|
||||
| [FourSigmaMarketDataApiCost](./bitburner.bitnodemultipliers.foursigmamarketdataapicost.md) | number | Influences how much it costs to unlock the stock market's 4S Market Data API |
|
||||
| [FourSigmaMarketDataCost](./bitburner.bitnodemultipliers.foursigmamarketdatacost.md) | number | Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) |
|
||||
| [GangSoftcap](./bitburner.bitnodemultipliers.gangsoftcap.md) | number | Influences the respect gain and money gain of your gang. |
|
||||
| [HackExpGain](./bitburner.bitnodemultipliers.hackexpgain.md) | number | Influences the experienced gained when hacking a server. |
|
||||
| [HackingLevelMultiplier](./bitburner.bitnodemultipliers.hackinglevelmultiplier.md) | number | Influences how quickly the player's hacking level (not experience) scales |
|
||||
| [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md) | number | Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9) |
|
||||
@ -47,12 +48,17 @@ export interface BitNodeMultipliers
|
||||
| [PurchasedServerCost](./bitburner.bitnodemultipliers.purchasedservercost.md) | number | Influence how much it costs to purchase a server |
|
||||
| [PurchasedServerLimit](./bitburner.bitnodemultipliers.purchasedserverlimit.md) | number | Influences the maximum number of purchased servers you can have |
|
||||
| [PurchasedServerMaxRam](./bitburner.bitnodemultipliers.purchasedservermaxram.md) | number | Influences the maximum allowed RAM for a purchased server |
|
||||
| [PurchasedServerSoftCap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md) | number | Influences cost of any purchased server at or above 128GB |
|
||||
| [RepToDonateToFaction](./bitburner.bitnodemultipliers.reptodonatetofaction.md) | number | Influences the minimum favor the player must have with a faction before they can donate to gain rep. |
|
||||
| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | number | Influences how much money can be stolen from a server when a script performs a hack against it. |
|
||||
| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | number | Influences how much the money on a server can be reduced when a script performs a hack against it. |
|
||||
| [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) | number | Influences how much of the money stolen by a scripted hack will be added to the player's money. |
|
||||
| [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md) | number | Influences the growth percentage per cycle against a server. |
|
||||
| [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) | number | Influences the maxmimum money that a server can grow to. |
|
||||
| [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md) | number | Influences the initial money that a server starts with. |
|
||||
| [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md) | number | Influences the initial security level (hackDifficulty) of a server. |
|
||||
| [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md) | number | Influences the weaken amount per invocation against a server. |
|
||||
| [StaneksGiftExtraSize](./bitburner.bitnodemultipliers.staneksgiftextrasize.md) | number | Influences the size of the gift |
|
||||
| [StaneksGiftPowerMultiplier](./bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md) | number | Influences the power of the gift |
|
||||
| [StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md) | number | Influences how quickly the player's strength level (not exp) scales |
|
||||
| [WorldDaemonDifficulty](./bitburner.bitnodemultipliers.worlddaemondifficulty.md) | number | Influences the hacking skill required to backdoor the world daemon. |
|
||||
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [PurchasedServerSoftCap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md)
|
||||
|
||||
## BitNodeMultipliers.PurchasedServerSoftCap property
|
||||
|
||||
Influences cost of any purchased server at or above 128GB
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
PurchasedServerSoftCap: number;
|
||||
```
|
@ -4,7 +4,7 @@
|
||||
|
||||
## BitNodeMultipliers.ScriptHackMoney property
|
||||
|
||||
Influences how much money can be stolen from a server when a script performs a hack against it.
|
||||
Influences how much the money on a server can be reduced when a script performs a hack against it.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
13
markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md
Normal file
13
markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md)
|
||||
|
||||
## BitNodeMultipliers.ScriptHackMoneyGain property
|
||||
|
||||
Influences how much of the money stolen by a scripted hack will be added to the player's money.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ScriptHackMoneyGain: number;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [StaneksGiftExtraSize](./bitburner.bitnodemultipliers.staneksgiftextrasize.md)
|
||||
|
||||
## BitNodeMultipliers.StaneksGiftExtraSize property
|
||||
|
||||
Influences the size of the gift
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
StaneksGiftExtraSize: number;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [StaneksGiftPowerMultiplier](./bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md)
|
||||
|
||||
## BitNodeMultipliers.StaneksGiftPowerMultiplier property
|
||||
|
||||
Influences the power of the gift
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
StaneksGiftPowerMultiplier: number;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [WorldDaemonDifficulty](./bitburner.bitnodemultipliers.worlddaemondifficulty.md)
|
||||
|
||||
## BitNodeMultipliers.WorldDaemonDifficulty property
|
||||
|
||||
Influences the hacking skill required to backdoor the world daemon.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
WorldDaemonDifficulty: number;
|
||||
```
|
12
markdown/bitburner.filenameorpid.md
Normal file
12
markdown/bitburner.filenameorpid.md
Normal file
@ -0,0 +1,12 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [FilenameOrPID](./bitburner.filenameorpid.md)
|
||||
|
||||
## FilenameOrPID type
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
type FilenameOrPID = number | string;
|
||||
```
|
13
markdown/bitburner.hacknetnodeconstants.basecost.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.basecost.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [BaseCost](./bitburner.hacknetnodeconstants.basecost.md)
|
||||
|
||||
## HacknetNodeConstants.BaseCost property
|
||||
|
||||
Base cost for a new node
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
BaseCost: number;
|
||||
```
|
13
markdown/bitburner.hacknetnodeconstants.corebasecost.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.corebasecost.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [CoreBaseCost](./bitburner.hacknetnodeconstants.corebasecost.md)
|
||||
|
||||
## HacknetNodeConstants.CoreBaseCost property
|
||||
|
||||
Base cost to increase cores
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
CoreBaseCost: number;
|
||||
```
|
13
markdown/bitburner.hacknetnodeconstants.levelbasecost.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.levelbasecost.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [LevelBaseCost](./bitburner.hacknetnodeconstants.levelbasecost.md)
|
||||
|
||||
## HacknetNodeConstants.LevelBaseCost property
|
||||
|
||||
Base cost per level
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
LevelBaseCost: number;
|
||||
```
|
13
markdown/bitburner.hacknetnodeconstants.maxcores.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.maxcores.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MaxCores](./bitburner.hacknetnodeconstants.maxcores.md)
|
||||
|
||||
## HacknetNodeConstants.MaxCores property
|
||||
|
||||
Max number of cores
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
MaxCores: number;
|
||||
```
|
13
markdown/bitburner.hacknetnodeconstants.maxlevel.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.maxlevel.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MaxLevel](./bitburner.hacknetnodeconstants.maxlevel.md)
|
||||
|
||||
## HacknetNodeConstants.MaxLevel property
|
||||
|
||||
Max node level
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
MaxLevel: number;
|
||||
```
|
13
markdown/bitburner.hacknetnodeconstants.maxram.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.maxram.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MaxRam](./bitburner.hacknetnodeconstants.maxram.md)
|
||||
|
||||
## HacknetNodeConstants.MaxRam property
|
||||
|
||||
Max amount of RAM in GB
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
MaxRam: number;
|
||||
```
|
31
markdown/bitburner.hacknetnodeconstants.md
Normal file
31
markdown/bitburner.hacknetnodeconstants.md
Normal file
@ -0,0 +1,31 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md)
|
||||
|
||||
## HacknetNodeConstants interface
|
||||
|
||||
Hacknet node related constants
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface HacknetNodeConstants
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [BaseCost](./bitburner.hacknetnodeconstants.basecost.md) | number | Base cost for a new node |
|
||||
| [CoreBaseCost](./bitburner.hacknetnodeconstants.corebasecost.md) | number | Base cost to increase cores |
|
||||
| [LevelBaseCost](./bitburner.hacknetnodeconstants.levelbasecost.md) | number | Base cost per level |
|
||||
| [MaxCores](./bitburner.hacknetnodeconstants.maxcores.md) | number | Max number of cores |
|
||||
| [MaxLevel](./bitburner.hacknetnodeconstants.maxlevel.md) | number | Max node level |
|
||||
| [MaxRam](./bitburner.hacknetnodeconstants.maxram.md) | number | Max amount of RAM in GB |
|
||||
| [MoneyGainPerLevel](./bitburner.hacknetnodeconstants.moneygainperlevel.md) | number | Amount of money gained per level |
|
||||
| [PurchaseNextMult](./bitburner.hacknetnodeconstants.purchasenextmult.md) | number | Multiplier to purchase new node |
|
||||
| [RamBaseCost](./bitburner.hacknetnodeconstants.rambasecost.md) | number | Base cost to incrase RAM |
|
||||
| [UpgradeCoreMult](./bitburner.hacknetnodeconstants.upgradecoremult.md) | number | Multiplier to increase cores |
|
||||
| [UpgradeLevelMult](./bitburner.hacknetnodeconstants.upgradelevelmult.md) | number | Multiplier to increase node level |
|
||||
| [UpgradeRamMult](./bitburner.hacknetnodeconstants.upgraderammult.md) | number | Multiplier to increase RAM |
|
||||
|
13
markdown/bitburner.hacknetnodeconstants.moneygainperlevel.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.moneygainperlevel.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MoneyGainPerLevel](./bitburner.hacknetnodeconstants.moneygainperlevel.md)
|
||||
|
||||
## HacknetNodeConstants.MoneyGainPerLevel property
|
||||
|
||||
Amount of money gained per level
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
MoneyGainPerLevel: number;
|
||||
```
|
13
markdown/bitburner.hacknetnodeconstants.purchasenextmult.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.purchasenextmult.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [PurchaseNextMult](./bitburner.hacknetnodeconstants.purchasenextmult.md)
|
||||
|
||||
## HacknetNodeConstants.PurchaseNextMult property
|
||||
|
||||
Multiplier to purchase new node
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
PurchaseNextMult: number;
|
||||
```
|
13
markdown/bitburner.hacknetnodeconstants.rambasecost.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.rambasecost.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [RamBaseCost](./bitburner.hacknetnodeconstants.rambasecost.md)
|
||||
|
||||
## HacknetNodeConstants.RamBaseCost property
|
||||
|
||||
Base cost to incrase RAM
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
RamBaseCost: number;
|
||||
```
|
13
markdown/bitburner.hacknetnodeconstants.upgradecoremult.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.upgradecoremult.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [UpgradeCoreMult](./bitburner.hacknetnodeconstants.upgradecoremult.md)
|
||||
|
||||
## HacknetNodeConstants.UpgradeCoreMult property
|
||||
|
||||
Multiplier to increase cores
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
UpgradeCoreMult: number;
|
||||
```
|
13
markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [UpgradeLevelMult](./bitburner.hacknetnodeconstants.upgradelevelmult.md)
|
||||
|
||||
## HacknetNodeConstants.UpgradeLevelMult property
|
||||
|
||||
Multiplier to increase node level
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
UpgradeLevelMult: number;
|
||||
```
|
13
markdown/bitburner.hacknetnodeconstants.upgraderammult.md
Normal file
13
markdown/bitburner.hacknetnodeconstants.upgraderammult.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [UpgradeRamMult](./bitburner.hacknetnodeconstants.upgraderammult.md)
|
||||
|
||||
## HacknetNodeConstants.UpgradeRamMult property
|
||||
|
||||
Multiplier to increase RAM
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
UpgradeRamMult: number;
|
||||
```
|
@ -9,11 +9,11 @@ All constants used by the game.
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
constants(): number;
|
||||
constants(): HacknetNodeConstants;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
number
|
||||
[HacknetNodeConstants](./bitburner.hacknetnodeconstants.md)
|
||||
|
||||
An object with all hacknet node constants used by the game.
|
||||
|
||||
|
13
markdown/bitburner.hacknetserverconstants.basecost.md
Normal file
13
markdown/bitburner.hacknetserverconstants.basecost.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [BaseCost](./bitburner.hacknetserverconstants.basecost.md)
|
||||
|
||||
## HacknetServerConstants.BaseCost property
|
||||
|
||||
Base cost for a new server
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
BaseCost: number;
|
||||
```
|
13
markdown/bitburner.hacknetserverconstants.cachebasecost.md
Normal file
13
markdown/bitburner.hacknetserverconstants.cachebasecost.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [CacheBaseCost](./bitburner.hacknetserverconstants.cachebasecost.md)
|
||||
|
||||
## HacknetServerConstants.CacheBaseCost property
|
||||
|
||||
Base cost to upgrade cache
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
CacheBaseCost: number;
|
||||
```
|
13
markdown/bitburner.hacknetserverconstants.corebasecost.md
Normal file
13
markdown/bitburner.hacknetserverconstants.corebasecost.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [CoreBaseCost](./bitburner.hacknetserverconstants.corebasecost.md)
|
||||
|
||||
## HacknetServerConstants.CoreBaseCost property
|
||||
|
||||
Base cost to increase cores
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
CoreBaseCost: number;
|
||||
```
|
13
markdown/bitburner.hacknetserverconstants.hashesperlevel.md
Normal file
13
markdown/bitburner.hacknetserverconstants.hashesperlevel.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [HashesPerLevel](./bitburner.hacknetserverconstants.hashesperlevel.md)
|
||||
|
||||
## HacknetServerConstants.HashesPerLevel property
|
||||
|
||||
Number of hashes calculated per level
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
HashesPerLevel: number;
|
||||
```
|
13
markdown/bitburner.hacknetserverconstants.maxcache.md
Normal file
13
markdown/bitburner.hacknetserverconstants.maxcache.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxCache](./bitburner.hacknetserverconstants.maxcache.md)
|
||||
|
||||
## HacknetServerConstants.MaxCache property
|
||||
|
||||
Max cache size
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
MaxCache: number;
|
||||
```
|
13
markdown/bitburner.hacknetserverconstants.maxcores.md
Normal file
13
markdown/bitburner.hacknetserverconstants.maxcores.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxCores](./bitburner.hacknetserverconstants.maxcores.md)
|
||||
|
||||
## HacknetServerConstants.MaxCores property
|
||||
|
||||
Max number of cores
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
MaxCores: number;
|
||||
```
|
13
markdown/bitburner.hacknetserverconstants.maxlevel.md
Normal file
13
markdown/bitburner.hacknetserverconstants.maxlevel.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxLevel](./bitburner.hacknetserverconstants.maxlevel.md)
|
||||
|
||||
## HacknetServerConstants.MaxLevel property
|
||||
|
||||
Max level for a server
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
MaxLevel: number;
|
||||
```
|
13
markdown/bitburner.hacknetserverconstants.maxram.md
Normal file
13
markdown/bitburner.hacknetserverconstants.maxram.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxRam](./bitburner.hacknetserverconstants.maxram.md)
|
||||
|
||||
## HacknetServerConstants.MaxRam property
|
||||
|
||||
Max amount of RAM in GB
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
MaxRam: number;
|
||||
```
|
13
markdown/bitburner.hacknetserverconstants.maxservers.md
Normal file
13
markdown/bitburner.hacknetserverconstants.maxservers.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxServers](./bitburner.hacknetserverconstants.maxservers.md)
|
||||
|
||||
## HacknetServerConstants.MaxServers property
|
||||
|
||||
Max number of servers
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
MaxServers: number;
|
||||
```
|
34
markdown/bitburner.hacknetserverconstants.md
Normal file
34
markdown/bitburner.hacknetserverconstants.md
Normal file
@ -0,0 +1,34 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md)
|
||||
|
||||
## HacknetServerConstants interface
|
||||
|
||||
Hacknet server related constants
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface HacknetServerConstants
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [BaseCost](./bitburner.hacknetserverconstants.basecost.md) | number | Base cost for a new server |
|
||||
| [CacheBaseCost](./bitburner.hacknetserverconstants.cachebasecost.md) | number | Base cost to upgrade cache |
|
||||
| [CoreBaseCost](./bitburner.hacknetserverconstants.corebasecost.md) | number | Base cost to increase cores |
|
||||
| [HashesPerLevel](./bitburner.hacknetserverconstants.hashesperlevel.md) | number | Number of hashes calculated per level |
|
||||
| [MaxCache](./bitburner.hacknetserverconstants.maxcache.md) | number | Max cache size |
|
||||
| [MaxCores](./bitburner.hacknetserverconstants.maxcores.md) | number | Max number of cores |
|
||||
| [MaxLevel](./bitburner.hacknetserverconstants.maxlevel.md) | number | Max level for a server |
|
||||
| [MaxRam](./bitburner.hacknetserverconstants.maxram.md) | number | Max amount of RAM in GB |
|
||||
| [MaxServers](./bitburner.hacknetserverconstants.maxservers.md) | number | Max number of servers |
|
||||
| [PurchaseMult](./bitburner.hacknetserverconstants.purchasemult.md) | number | Multiplier to purchase a new server |
|
||||
| [RamBaseCost](./bitburner.hacknetserverconstants.rambasecost.md) | number | Base cost to increase RAM |
|
||||
| [UpgradeCacheMult](./bitburner.hacknetserverconstants.upgradecachemult.md) | number | Multiplier to upgrade cache |
|
||||
| [UpgradeCoreMult](./bitburner.hacknetserverconstants.upgradecoremult.md) | number | Multiplier to increase cores |
|
||||
| [UpgradeLevelMult](./bitburner.hacknetserverconstants.upgradelevelmult.md) | number | Multiplier to increase server level |
|
||||
| [UpgradeRamMult](./bitburner.hacknetserverconstants.upgraderammult.md) | number | Multiplier to increase RAM |
|
||||
|
13
markdown/bitburner.hacknetserverconstants.purchasemult.md
Normal file
13
markdown/bitburner.hacknetserverconstants.purchasemult.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [PurchaseMult](./bitburner.hacknetserverconstants.purchasemult.md)
|
||||
|
||||
## HacknetServerConstants.PurchaseMult property
|
||||
|
||||
Multiplier to purchase a new server
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
PurchaseMult: number;
|
||||
```
|
13
markdown/bitburner.hacknetserverconstants.rambasecost.md
Normal file
13
markdown/bitburner.hacknetserverconstants.rambasecost.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [RamBaseCost](./bitburner.hacknetserverconstants.rambasecost.md)
|
||||
|
||||
## HacknetServerConstants.RamBaseCost property
|
||||
|
||||
Base cost to increase RAM
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
RamBaseCost: number;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeCacheMult](./bitburner.hacknetserverconstants.upgradecachemult.md)
|
||||
|
||||
## HacknetServerConstants.UpgradeCacheMult property
|
||||
|
||||
Multiplier to upgrade cache
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
UpgradeCacheMult: number;
|
||||
```
|
13
markdown/bitburner.hacknetserverconstants.upgradecoremult.md
Normal file
13
markdown/bitburner.hacknetserverconstants.upgradecoremult.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeCoreMult](./bitburner.hacknetserverconstants.upgradecoremult.md)
|
||||
|
||||
## HacknetServerConstants.UpgradeCoreMult property
|
||||
|
||||
Multiplier to increase cores
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
UpgradeCoreMult: number;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeLevelMult](./bitburner.hacknetserverconstants.upgradelevelmult.md)
|
||||
|
||||
## HacknetServerConstants.UpgradeLevelMult property
|
||||
|
||||
Multiplier to increase server level
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
UpgradeLevelMult: number;
|
||||
```
|
13
markdown/bitburner.hacknetserverconstants.upgraderammult.md
Normal file
13
markdown/bitburner.hacknetserverconstants.upgraderammult.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeRamMult](./bitburner.hacknetserverconstants.upgraderammult.md)
|
||||
|
||||
## HacknetServerConstants.UpgradeRamMult property
|
||||
|
||||
Multiplier to increase RAM
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
UpgradeRamMult: number;
|
||||
```
|
@ -9,11 +9,11 @@ All constants used by the game.
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
constants(): any;
|
||||
constants(): HacknetServerConstants;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
any
|
||||
[HacknetServerConstants](./bitburner.hacknetserverconstants.md)
|
||||
|
||||
An object with all hacknet server constants used by the game.
|
||||
|
||||
|
@ -4,6 +4,13 @@
|
||||
|
||||
## bitburner package
|
||||
|
||||
## Enumerations
|
||||
|
||||
| Enumeration | Description |
|
||||
| --- | --- |
|
||||
| [OrderTypes](./bitburner.ordertypes.md) | |
|
||||
| [PositionTypes](./bitburner.positiontypes.md) | |
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
@ -41,9 +48,12 @@
|
||||
| [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. |
|
||||
| [Hacknet](./bitburner.hacknet.md) | Hacknet API |
|
||||
| [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. |
|
||||
| [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) | Hacknet node related constants |
|
||||
| [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas |
|
||||
| [HacknetServerConstants](./bitburner.hacknetserverconstants.md) | Hacknet server related constants |
|
||||
| [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas |
|
||||
| [Material](./bitburner.material.md) | Material in a warehouse |
|
||||
| [NetscriptPort](./bitburner.netscriptport.md) | Object representing a port. A port is a serialized queue. |
|
||||
| [NodeStats](./bitburner.nodestats.md) | Object representing all the values related to a hacknet node. |
|
||||
| [NS](./bitburner.ns.md) | Collection of all functions passed to scripts |
|
||||
| [Office](./bitburner.office.md) | Office for a division in a city. |
|
||||
@ -63,10 +73,16 @@
|
||||
| [SleeveWorkGains](./bitburner.sleeveworkgains.md) | |
|
||||
| [SourceFileLvl](./bitburner.sourcefilelvl.md) | |
|
||||
| [Stanek](./bitburner.stanek.md) | Stanek's Gift API. |
|
||||
| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md) |
|
||||
| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md)<!-- -->Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) |
|
||||
| [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) |
|
||||
| [TIX](./bitburner.tix.md) | Stock market API |
|
||||
| [UserInterface](./bitburner.userinterface.md) | User Interface API. |
|
||||
| [Warehouse](./bitburner.warehouse.md) | Warehouse for a division in a city |
|
||||
| [WarehouseAPI](./bitburner.warehouseapi.md) | Corporation Warehouse API |
|
||||
|
||||
## Type Aliases
|
||||
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [FilenameOrPID](./bitburner.filenameorpid.md) | |
|
||||
|
||||
|
21
markdown/bitburner.netscriptport.clear.md
Normal file
21
markdown/bitburner.netscriptport.clear.md
Normal file
@ -0,0 +1,21 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [clear](./bitburner.netscriptport.clear.md)
|
||||
|
||||
## NetscriptPort.clear() method
|
||||
|
||||
Empties all data from the port.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
clear(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
void
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0 GB
|
||||
|
23
markdown/bitburner.netscriptport.empty.md
Normal file
23
markdown/bitburner.netscriptport.empty.md
Normal file
@ -0,0 +1,23 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [empty](./bitburner.netscriptport.empty.md)
|
||||
|
||||
## NetscriptPort.empty() method
|
||||
|
||||
Check if the port is empty.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
empty(): boolean;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
boolean
|
||||
|
||||
true if the port is empty, otherwise false
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0 GB
|
||||
|
23
markdown/bitburner.netscriptport.full.md
Normal file
23
markdown/bitburner.netscriptport.full.md
Normal file
@ -0,0 +1,23 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [full](./bitburner.netscriptport.full.md)
|
||||
|
||||
## NetscriptPort.full() method
|
||||
|
||||
Check if the port is full.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
full(): boolean;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
boolean
|
||||
|
||||
true if the port is full, otherwise false
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0 GB
|
||||
|
26
markdown/bitburner.netscriptport.md
Normal file
26
markdown/bitburner.netscriptport.md
Normal file
@ -0,0 +1,26 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md)
|
||||
|
||||
## NetscriptPort interface
|
||||
|
||||
Object representing a port. A port is a serialized queue.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface NetscriptPort
|
||||
```
|
||||
|
||||
## Methods
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [clear()](./bitburner.netscriptport.clear.md) | Empties all data from the port. |
|
||||
| [empty()](./bitburner.netscriptport.empty.md) | Check if the port is empty. |
|
||||
| [full()](./bitburner.netscriptport.full.md) | Check if the port is full. |
|
||||
| [peek()](./bitburner.netscriptport.peek.md) | Retrieve the first element from the port without removing it. |
|
||||
| [read()](./bitburner.netscriptport.read.md) | Shift an element out of the port. |
|
||||
| [tryWrite(value)](./bitburner.netscriptport.trywrite.md) | Attempt to write data to the port. |
|
||||
| [write(value)](./bitburner.netscriptport.write.md) | Write data to a port. |
|
||||
|
25
markdown/bitburner.netscriptport.peek.md
Normal file
25
markdown/bitburner.netscriptport.peek.md
Normal file
@ -0,0 +1,25 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [peek](./bitburner.netscriptport.peek.md)
|
||||
|
||||
## NetscriptPort.peek() method
|
||||
|
||||
Retrieve the first element from the port without removing it.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
peek(): string | number;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
string \| number
|
||||
|
||||
the data read
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0 GB
|
||||
|
||||
This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned.
|
||||
|
25
markdown/bitburner.netscriptport.read.md
Normal file
25
markdown/bitburner.netscriptport.read.md
Normal file
@ -0,0 +1,25 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [read](./bitburner.netscriptport.read.md)
|
||||
|
||||
## NetscriptPort.read() method
|
||||
|
||||
Shift an element out of the port.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
read(): string | number;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
string \| number
|
||||
|
||||
the data read.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0 GB
|
||||
|
||||
This function will remove the first element from the port and return it. If the port is empty, then the string “NULL PORT DATA” will be returned.
|
||||
|
30
markdown/bitburner.netscriptport.trywrite.md
Normal file
30
markdown/bitburner.netscriptport.trywrite.md
Normal file
@ -0,0 +1,30 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [tryWrite](./bitburner.netscriptport.trywrite.md)
|
||||
|
||||
## NetscriptPort.tryWrite() method
|
||||
|
||||
Attempt to write data to the port.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
tryWrite(value: string | number): boolean;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| value | string \| number | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
boolean
|
||||
|
||||
True if the data was added to the port, false if the port was full
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0 GB
|
||||
|
30
markdown/bitburner.netscriptport.write.md
Normal file
30
markdown/bitburner.netscriptport.write.md
Normal file
@ -0,0 +1,30 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [write](./bitburner.netscriptport.write.md)
|
||||
|
||||
## NetscriptPort.write() method
|
||||
|
||||
Write data to a port.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
write(value: string | number): null | string | number;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| value | string \| number | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
null \| string \| number
|
||||
|
||||
The data popped off the queue if it was full.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0 GB
|
||||
|
@ -22,8 +22,8 @@ export interface NodeStats
|
||||
| [level](./bitburner.nodestats.level.md) | number | Node's level |
|
||||
| [name](./bitburner.nodestats.name.md) | string | Node's name |
|
||||
| [production](./bitburner.nodestats.production.md) | number | Node's production per second |
|
||||
| [ram](./bitburner.nodestats.ram.md) | number | Node's RAM |
|
||||
| [ramUsed](./bitburner.nodestats.ramused.md) | number | Node's used RAM |
|
||||
| [ram](./bitburner.nodestats.ram.md) | number | Node's RAM (GB) |
|
||||
| [ramUsed](./bitburner.nodestats.ramused.md) | number | Node's used RAM (GB) |
|
||||
| [timeOnline](./bitburner.nodestats.timeonline.md) | number | Number of seconds since Node has been purchased |
|
||||
| [totalProduction](./bitburner.nodestats.totalproduction.md) | number | Total number of money Node has produced |
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## NodeStats.ram property
|
||||
|
||||
Node's RAM
|
||||
Node's RAM (GB)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## NodeStats.ramUsed property
|
||||
|
||||
Node's used RAM
|
||||
Node's used RAM (GB)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
@ -9,7 +9,7 @@ Get all data on a port.
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getPortHandle(port: number): any[];
|
||||
getPortHandle(port: number): NetscriptPort;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
@ -20,9 +20,7 @@ getPortHandle(port: number): any[];
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
any\[\]
|
||||
|
||||
Data in the specified port.
|
||||
[NetscriptPort](./bitburner.netscriptport.md)
|
||||
|
||||
## Remarks
|
||||
|
||||
|
@ -16,7 +16,7 @@ getPurchasedServerCost(ram: number): number;
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| ram | number | Amount of RAM of a potential purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). |
|
||||
| ram | number | Amount of RAM of a potential purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
|
@ -15,7 +15,7 @@ getPurchasedServerMaxRam(): number;
|
||||
|
||||
number
|
||||
|
||||
Returns the maximum RAM that a purchased server can have.
|
||||
Returns the maximum RAM (in GB) that a purchased server can have.
|
||||
|
||||
## Remarks
|
||||
|
||||
|
@ -9,16 +9,16 @@ Get general info about a running script.
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getRunningScript(filename?: string | number, hostname?: string, ...args: (string | number)[]): RunningScript;
|
||||
getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string | number)[]): RunningScript;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| filename | string \| number | |
|
||||
| hostname | string | |
|
||||
| args | (string \| number)\[\] | |
|
||||
| filename | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script. |
|
||||
| hostname | string | Optional. Name of host server the script is running on. |
|
||||
| args | (string \| number)\[\] | Arguments to identify the script |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
@ -30,5 +30,5 @@ info about a running script
|
||||
|
||||
RAM cost: 0.3 GB
|
||||
|
||||
Running with no args returns curent script.
|
||||
Running with no args returns curent script. If you use a PID as the first parameter, the hostname and args parameters are unnecessary.
|
||||
|
||||
|
@ -23,7 +23,7 @@ getScriptRam(script: string, host?: string): number;
|
||||
|
||||
number
|
||||
|
||||
Amount of RAM required to run the specified script on the target server, and 0 if the script does not exist.
|
||||
Amount of RAM (in GB) required to run the specified script on the target server, and 0 if the script does not exist.
|
||||
|
||||
## Remarks
|
||||
|
||||
|
@ -22,7 +22,7 @@ getServerMaxRam(host: string): number;
|
||||
|
||||
number
|
||||
|
||||
max ram
|
||||
max ram (GB)
|
||||
|
||||
## Remarks
|
||||
|
||||
|
@ -25,7 +25,7 @@ getServerRam(host: string): [number, number];
|
||||
|
||||
\[number, number\]
|
||||
|
||||
Array with total and used memory on the specified server.
|
||||
Array with total and used memory on the specified server, in GB.
|
||||
|
||||
## Remarks
|
||||
|
||||
|
@ -22,7 +22,7 @@ getServerUsedRam(host: string): number;
|
||||
|
||||
number
|
||||
|
||||
used ram
|
||||
used ram (GB)
|
||||
|
||||
## Remarks
|
||||
|
||||
|
@ -9,14 +9,14 @@ Check if a script is running.
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
isRunning(script: string, host: string, ...args: string[]): boolean;
|
||||
isRunning(script: FilenameOrPID, host: string, ...args: string[]): boolean;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| script | string | Filename of script to check. This is case-sensitive. |
|
||||
| script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. |
|
||||
| host | string | Host of target server. |
|
||||
| args | string\[\] | Arguments to specify/identify which scripts to search for. |
|
||||
|
||||
@ -30,7 +30,7 @@ True if specified script is running on the target server, and false otherwise.
|
||||
|
||||
RAM cost: 0.1 GB
|
||||
|
||||
Returns a boolean indicating whether the specified script is running on the target server. Remember that a script is uniquely identified by both its name and its arguments.
|
||||
Returns a boolean indicating whether the specified script is running on the target server. If you use a PID instead of a filename, the hostname and args parameters are unnecessary. Remember that a script is uniquely identified by both its name and its arguments.
|
||||
|
||||
## Example 1
|
||||
|
||||
|
@ -125,6 +125,7 @@ export async function main(ns) {
|
||||
| [kill(script, host, args)](./bitburner.ns.kill_1.md) | |
|
||||
| [killall(host)](./bitburner.ns.killall.md) | Terminate all scripts on a server. |
|
||||
| [ls(host, grep)](./bitburner.ns.ls.md) | List files on a server. |
|
||||
| [mv(host, source, destination)](./bitburner.ns.mv.md) | Move a file on the target server. |
|
||||
| [nFormat(n, format)](./bitburner.ns.nformat.md) | Format a number |
|
||||
| [nuke(host)](./bitburner.ns.nuke.md) | Runs NUKE.exe on a server. |
|
||||
| [peek(port)](./bitburner.ns.peek.md) | Get a copy of the data from a port without popping it. |
|
||||
@ -138,7 +139,8 @@ export async function main(ns) {
|
||||
| [rm(name, host)](./bitburner.ns.rm.md) | Delete a file. |
|
||||
| [run(script, numThreads, args)](./bitburner.ns.run.md) | Start another script on the current server. |
|
||||
| [scan(host)](./bitburner.ns.scan.md) | Get the list of servers connected to a server. |
|
||||
| [scp(files, source, destination)](./bitburner.ns.scp.md) | Copy file between servers. |
|
||||
| [scp(files, destination)](./bitburner.ns.scp.md) | Copy file between servers. |
|
||||
| [scp(files, source, destination)](./bitburner.ns.scp_1.md) | |
|
||||
| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kill all scripts with a filename. |
|
||||
| [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Check if any script with a filename is running. |
|
||||
| [serverExists(host)](./bitburner.ns.serverexists.md) | Returns a boolean denoting whether or not the specified server exists. |
|
||||
|
@ -1,6 +1,6 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [atExit](./bitburner.ns.atexit.md)
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [mv](./bitburner.ns.mv.md)
|
||||
|
||||
## NS.mv() method
|
||||
|
||||
@ -32,7 +32,7 @@ NS2 exclusive
|
||||
|
||||
Move the source file to the specified destination on the target server.
|
||||
|
||||
This command only works for scripts and text files (.txt). It cannot, however, be used
|
||||
to convert from script to text file, or vice versa.
|
||||
This command only works for scripts and text files (.txt). It cannot, however, be used to convert from script to text file, or vice versa.
|
||||
|
||||
This function can also be used to rename files.
|
||||
|
||||
|
@ -17,7 +17,7 @@ purchaseServer(hostname: string, ram: number): string;
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| hostname | string | Host of the purchased server. |
|
||||
| ram | number | Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). |
|
||||
| ram | number | Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
|
@ -16,19 +16,19 @@ read(handle: string): any;
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| handle | string | Port or text file to read from. |
|
||||
| handle | string | Filename to read from. |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
any
|
||||
|
||||
Data in the specified text file or port.
|
||||
Data in the specified text file.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0 GB
|
||||
|
||||
This function is used to read data from a port or from a text file (.txt).
|
||||
This function is used to read data from a text file (.txt).
|
||||
|
||||
This function will return the data in the specified text file. If the text file does not exist, an empty string will be returned.
|
||||
|
||||
|
@ -9,7 +9,7 @@ Copy file between servers.
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
scp(files: string | string[], source: string, destination: string): Promise<boolean>;
|
||||
scp(files: string | string[], destination: string): Promise<boolean>;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
@ -17,7 +17,6 @@ scp(files: string | string[], source: string, destination: string): Promise<bool
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| files | string \| string\[\] | Filename or an array of filenames of script/literature files to copy. |
|
||||
| source | string | Host of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server. |
|
||||
| destination | string | Host of the destination server, which is the server to which the file will be copied. |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
24
markdown/bitburner.ns.scp_1.md
Normal file
24
markdown/bitburner.ns.scp_1.md
Normal file
@ -0,0 +1,24 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scp](./bitburner.ns.scp_1.md)
|
||||
|
||||
## NS.scp() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
scp(files: string | string[], source: string, destination: string): Promise<boolean>;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| files | string \| string\[\] | |
|
||||
| source | string | |
|
||||
| destination | string | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
Promise<boolean>
|
||||
|
@ -14,10 +14,10 @@ sprintf(format: string, ...args: any[]): string;
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ------- | -------------------- |
|
||||
| format | string | String to format. |
|
||||
| args | any\[\] | Formating arguments. |
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| format | string | String to format. |
|
||||
| args | any\[\] | Formating arguments. |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
@ -30,3 +30,4 @@ Formated text.
|
||||
RAM cost: 0 GB
|
||||
|
||||
see: https://github.com/alexei/sprintf.js
|
||||
|
||||
|
@ -9,14 +9,14 @@ Open the tail window of a script.
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
tail(fn?: string, host?: string, ...args: any[]): void;
|
||||
tail(fn?: FilenameOrPID, host?: string, ...args: any[]): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| fn | string | Optional. Filename of the script being tailed. If omitted, the current script is tailed. |
|
||||
| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. |
|
||||
| host | string | Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. |
|
||||
| args | any\[\] | Arguments for the script being tailed. |
|
||||
|
||||
|
@ -9,7 +9,7 @@ Queue a toast (bottom-right notification).
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
toast(msg: any, variant?: string, duration?: number): void;
|
||||
toast(msg: any, variant?: string, duration?: number | null): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
@ -18,7 +18,7 @@ toast(msg: any, variant?: string, duration?: number): void;
|
||||
| --- | --- | --- |
|
||||
| msg | any | Message in the toast. |
|
||||
| variant | string | Type of toast, must be one of success, info, warning, error. Defaults to success. |
|
||||
| duration | number | Duration of toast in ms, defaults to 2000 |
|
||||
| duration | number \| null | Duration of toast in ms. Can also be <code>null</code> to create a persistent toast. Defaults to 2000 |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
|
@ -14,10 +14,10 @@ vsprintf(format: string, args: any[]): string;
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ------- | -------------------- |
|
||||
| format | string | String to format. |
|
||||
| args | any\[\] | Formating arguments. |
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| format | string | String to format. |
|
||||
| args | any\[\] | Formating arguments. |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
@ -30,3 +30,4 @@ Formated text.
|
||||
RAM cost: 0 GB
|
||||
|
||||
see: https://github.com/alexei/sprintf.js
|
||||
|
||||
|
@ -16,7 +16,7 @@ write(handle: string, data?: string[] | number | string, mode?: "w" | "a"): Prom
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| handle | string | Port or text file that will be written to. |
|
||||
| handle | string | Filename of the text file that will be written to. |
|
||||
| data | string\[\] \| number \| string | Data to write. |
|
||||
| mode | "w" \| "a" | Defines the write mode. Only valid when writing to text files. |
|
||||
|
||||
@ -28,7 +28,7 @@ Promise<void>
|
||||
|
||||
RAM cost: 0 GB
|
||||
|
||||
This function can be used to either write data to a text file (.txt).
|
||||
This function can be used to write data to a text file (.txt).
|
||||
|
||||
This function will write data to that text file. If the specified text file does not exist, then it will be created. The third argument mode, defines how the data will be written to the text file. If \*mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the text file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the text file.
|
||||
|
||||
|
22
markdown/bitburner.ordertypes.md
Normal file
22
markdown/bitburner.ordertypes.md
Normal file
@ -0,0 +1,22 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [OrderTypes](./bitburner.ordertypes.md)
|
||||
|
||||
## OrderTypes enum
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export enum OrderTypes
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| LimitBuy | <code>"Limit Buy Order"</code> | |
|
||||
| LimitSell | <code>"Limit Sell Order"</code> | |
|
||||
| StopBuy | <code>"Stop Buy Order"</code> | |
|
||||
| StopSell | <code>"Stop Sell Order"</code> | |
|
||||
|
20
markdown/bitburner.positiontypes.md
Normal file
20
markdown/bitburner.positiontypes.md
Normal file
@ -0,0 +1,20 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [PositionTypes](./bitburner.positiontypes.md)
|
||||
|
||||
## PositionTypes enum
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export enum PositionTypes
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| Long | <code>"L"</code> | |
|
||||
| Short | <code>"S"</code> | |
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.applyToCompany() method
|
||||
|
||||
SF4.2 - Apply for a job at a company.
|
||||
Apply for a job at a company.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -27,7 +27,7 @@ True if the player successfully get a job/promotion, and false otherwise.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 3 GB
|
||||
RAM cost: 3 GB \* 16/4/1
|
||||
|
||||
This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.checkFactionInvitations() method
|
||||
|
||||
SF4.2 - List all current faction invitations.
|
||||
List all current faction invitations.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -19,7 +19,7 @@ Array with the name of all Factions you currently have oustanding invitations fr
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 3 GB
|
||||
RAM cost: 3 GB \* 16/4/1
|
||||
|
||||
Returns an array with the name of all Factions you currently have oustanding invitations from.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.commitCrime() method
|
||||
|
||||
SF4.3 - Commit a crime.
|
||||
Commit a crime.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -22,11 +22,11 @@ commitCrime(crime: string): number;
|
||||
|
||||
number
|
||||
|
||||
True if you successfully start working on the specified program, and false otherwise.
|
||||
The number of milliseconds it takes to attempt the specified crime.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 5 GB
|
||||
RAM cost: 5 GB \* 16/4/1
|
||||
|
||||
This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.connect() method
|
||||
|
||||
SF4.1 - Connect to a server.
|
||||
Connect to a server.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ True if the connect command was successful, false otherwise.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 2 GB
|
||||
RAM cost: 2 GB \* 16/4/1
|
||||
|
||||
Run the connect HOSTNAME command in the terminal. Can only connect to neighbors.
|
||||
|
||||
|
@ -4,12 +4,12 @@
|
||||
|
||||
## Singularity.createProgram() method
|
||||
|
||||
SF4.3 - Create a program.
|
||||
Create a program.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
createProgram(program: string): boolean;
|
||||
createProgram(program: string, focus?: boolean): boolean;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
@ -17,6 +17,7 @@ createProgram(program: string): boolean;
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| program | string | Name of program to create. |
|
||||
| focus | boolean | Acquire player focus on this program creation. Optional. Defaults to true. |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
@ -26,7 +27,7 @@ True if you successfully start working on the specified program, and false other
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 5 GB
|
||||
RAM cost: 5 GB \* 16/4/1
|
||||
|
||||
This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.donateToFaction() method
|
||||
|
||||
SF4.3 - Donate to a faction.
|
||||
Donate to a faction.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -27,7 +27,7 @@ True if the money was donated, and false otherwise.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 5 GB
|
||||
RAM cost: 5 GB \* 16/4/1
|
||||
|
||||
Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise.
|
||||
|
||||
|
@ -9,7 +9,7 @@
|
||||
> use getAugmentationPrice getAugmentationRepCost
|
||||
>
|
||||
|
||||
SF4.3 - Get the price and reputation of an augmentation.
|
||||
Get the price and reputation of an augmentation.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -31,7 +31,7 @@ Array with first element as a reputation requirement and second element as the m
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 5 GB
|
||||
RAM cost: 5 GB \* 16/4/1
|
||||
|
||||
This function returns an array with two elements that gives the cost for the specified Augmentation. The first element in the returned array is the reputation requirement of the Augmentation, and the second element is the money cost.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getAugmentationPrereq() method
|
||||
|
||||
SF4.3 - Get the pre-requisite of an augmentation.
|
||||
Get the pre-requisite of an augmentation.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ Array with the names of the prerequisite Augmentation(s) for the specified Augme
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 5 GB
|
||||
RAM cost: 5 GB \* 16/4/1
|
||||
|
||||
This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getAugmentationPrice() method
|
||||
|
||||
SF4.3 - Get price of an augmentation.
|
||||
Get price of an augmentation.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,5 +26,5 @@ Price of the augmentation.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 2.5 GB
|
||||
RAM cost: 2.5 GB \* 16/4/1
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getAugmentationRepReq() method
|
||||
|
||||
SF4.3 - Get reputation requirement of an augmentation.
|
||||
Get reputation requirement of an augmentation.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,5 +26,5 @@ Reputation requirement of the augmentation.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 2.5 GB
|
||||
RAM cost: 2.5 GB \* 16/4/1
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getAugmentationsFromFaction() method
|
||||
|
||||
SF4.3 - Get a list of augmentation available from a faction.
|
||||
Get a list of augmentation available from a faction.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ Array containing the names of all Augmentations.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 5 GB
|
||||
RAM cost: 5 GB \* 16/4/1
|
||||
|
||||
Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getAugmentationStats() method
|
||||
|
||||
SF4.3 - Get the stats of an augmentation.
|
||||
Get the stats of an augmentation.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ Augmentation stats.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 5 GB
|
||||
RAM cost: 5 GB \* 16/4/1
|
||||
|
||||
This function returns augmentation stats.
|
||||
|
||||
|
@ -9,7 +9,7 @@
|
||||
> use getPlayer
|
||||
>
|
||||
|
||||
SF4.1 - Returns an object with various information about your character.
|
||||
Returns an object with various information about your character.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -24,5 +24,5 @@ Object with various information about your character.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0.5 GB
|
||||
RAM cost: 0.5 GB \* 16/4/1
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getCompanyFavor() method
|
||||
|
||||
SF4.2 - Get company favor.
|
||||
Get company favor.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ Amount of favor you have at the specified company.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 1 GB
|
||||
RAM cost: 1 GB \* 16/4/1
|
||||
|
||||
This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getCompanyFavorGain() method
|
||||
|
||||
SF4.2 - Get company favor gain.
|
||||
Get company favor gain.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ Amount of favor you gain at the specified company when you reset by installing A
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0.75 GB
|
||||
RAM cost: 0.75 GB \* 16/4/1
|
||||
|
||||
This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getCompanyRep() method
|
||||
|
||||
SF4.2 - Get company reputation.
|
||||
Get company reputation.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ Amount of reputation you have at the specified company.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 1 GB
|
||||
RAM cost: 1 GB \* 16/4/1
|
||||
|
||||
This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getCrimeChance() method
|
||||
|
||||
SF4.3 - Get chance to successfully commit a crime.
|
||||
Get chance to successfully commit a crime.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ Chance of success at commiting the specified crime.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 5 GB
|
||||
RAM cost: 5 GB \* 16/4/1
|
||||
|
||||
This function returns your chance of success at commiting the specified crime.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getCrimeStats() method
|
||||
|
||||
SF4.3 - Get stats related to a crime.
|
||||
Get stats related to a crime.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ The stats of the crime.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 5 GB
|
||||
RAM cost: 5 GB \* 16/4/1
|
||||
|
||||
Returns the stats of the crime.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getCurrentServer() method
|
||||
|
||||
SF4.1 - Get the current server.
|
||||
Get the current server.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -19,5 +19,5 @@ Name of the current server.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 2 GB
|
||||
RAM cost: 2 GB \* 16/4/1
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getFactionFavor() method
|
||||
|
||||
SF4.2 - Get faction favor.
|
||||
Get faction favor.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ Amount of favor you have for the specified faction.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 1 GB
|
||||
RAM cost: 1 GB \* 16/4/1
|
||||
|
||||
This function returns the amount of favor you have for the specified faction.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getFactionFavorGain() method
|
||||
|
||||
SF4.2 - Get faction favor gain.
|
||||
Get faction favor gain.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ Amount of favor you will gain for the specified faction when you reset by instal
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0.75 GB
|
||||
RAM cost: 0.75 GB \* 16/4/1
|
||||
|
||||
This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getFactionRep() method
|
||||
|
||||
SF4.2 - Get faction reputation.
|
||||
Get faction reputation.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ Amount of reputation you have for the specified faction.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 1 GB
|
||||
RAM cost: 1 GB \* 16/4/1
|
||||
|
||||
This function returns the amount of reputation you have for the specified faction.
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
## Singularity.getOwnedAugmentations() method
|
||||
|
||||
SF4.3 - Get a list of owned augmentation.
|
||||
Get a list of owned augmentation.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -26,7 +26,7 @@ Array containing the names (as strings) of all Augmentations you have.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 5 GB
|
||||
RAM cost: 5 GB \* 16/4/1
|
||||
|
||||
This function returns an array containing the names (as strings) of all Augmentations you have.
|
||||
|
||||
|
@ -9,7 +9,7 @@
|
||||
> use getPlayer
|
||||
>
|
||||
|
||||
SF4.1 - Returns an object with the Player’s stats.
|
||||
Returns an object with the Player’s stats.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
@ -24,7 +24,7 @@ Object with the Player’s stats.
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0.5 GB
|
||||
RAM cost: 0.5 GB \* 16/4/1
|
||||
|
||||
## Example
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user