doc n steam copypaste

This commit is contained in:
Olivier Gagnon 2021-12-02 18:42:30 -05:00
parent ffd1bd3ab0
commit 773f50ba67
10 changed files with 72 additions and 57 deletions

24
dist/bitburner.d.ts vendored

@ -1032,7 +1032,7 @@ export declare interface Gang {
* Get the name of all possible equipment/upgrades you can purchase for your Gang Members.
* This includes Augmentations.
*
* @returns Names of all Equpiment/Augmentations.
* @returns Names of all Equipments/Augmentations.
*/
getEquipmentNames(): string[];
@ -3313,6 +3313,17 @@ export declare interface NS extends Singularity {
*/
getBitNodeMultipliers(): BitNodeMultipliers;
/**
* Get a list of acquired Source-Files.
* @remarks
* RAM cost: 5 GB
*
* Returns an array of source files
*
* @returns Array containing an object with number and level of the source file.
*/
getOwnedSourceFiles(): SourceFileLvl[];
/**
* Get information about the player.
* @returns Player info
@ -4080,17 +4091,6 @@ export declare interface Singularity {
*/
getOwnedAugmentations(purchased?: boolean): string[];
/**
* Get a list of acquired Source-Files.
* @remarks
* RAM cost: 5 GB
*
* Returns an array of source files
*
* @returns Array containing an object with number and level of the source file.
*/
getOwnedSourceFiles(): SourceFileLvl[];
/**
* Get a list of augmentation available from a faction.
* @remarks

@ -9,7 +9,6 @@ if (greenworks.init()) {
const debug = false;
Menu.setApplicationMenu(false);
function createWindow() {
const win = new BrowserWindow({
show: false,
@ -41,6 +40,24 @@ function createWindow() {
shell.openExternal(url);
});
// Create the Application's main menu
Menu.setApplicationMenu(
Menu.buildFromTemplate([
{
label: "Edit",
submenu: [
{ label: "Undo", accelerator: "CmdOrCtrl+Z", selector: "undo:" },
{ label: "Redo", accelerator: "Shift+CmdOrCtrl+Z", selector: "redo:" },
{ type: "separator" },
{ label: "Cut", accelerator: "CmdOrCtrl+X", selector: "cut:" },
{ label: "Copy", accelerator: "CmdOrCtrl+C", selector: "copy:" },
{ label: "Paste", accelerator: "CmdOrCtrl+V", selector: "paste:" },
{ label: "Select All", accelerator: "CmdOrCtrl+A", selector: "selectAll:" },
],
},
]),
);
// This is backward but the game fills in an array called `document.achievements` and we retrieve it from
// here. Hey if it works it works.
const achievements = greenworks.getAchievementNames();

@ -6088,7 +6088,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Gang#getEquipmentNames:member(1)",
"docComment": "/**\n * List equipment names.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations.\n *\n * @returns Names of all Equpiment/Augmentations.\n */\n",
"docComment": "/**\n * List equipment names.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations.\n *\n * @returns Names of all Equipments/Augmentations.\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -12675,6 +12675,39 @@
"parameters": [],
"name": "getHostname"
},
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!NS#getOwnedSourceFiles:member(1)",
"docComment": "/**\n * Get a list of acquired Source-Files.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Returns an array of source files\n *\n * @returns Array containing an object with number and level of the source file.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "getOwnedSourceFiles(): "
},
{
"kind": "Reference",
"text": "SourceFileLvl",
"canonicalReference": "bitburner!SourceFileLvl:interface"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "getOwnedSourceFiles"
},
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!NS#getPlayer:member(1)",
@ -20953,39 +20986,6 @@
],
"name": "getOwnedAugmentations"
},
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getOwnedSourceFiles:member(1)",
"docComment": "/**\n * Get a list of acquired Source-Files.\n *\n * @remarks\n *\n * RAM cost: 5 GB\n *\n * Singularity - Level 3\n *\n * Returns an array of source files\n *\n * @returns Array containing an object with number and level of the source file.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "getOwnedSourceFiles(): "
},
{
"kind": "Reference",
"text": "SourceFileLvl",
"canonicalReference": "bitburner!SourceFileLvl:interface"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "getOwnedSourceFiles"
},
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Singularity#getStats:member(1)",

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

@ -15,7 +15,7 @@ getEquipmentNames(): string[];
string\[\]
Names of all Equpiment/Augmentations.
Names of all Equipments/Augmentations.
## Remarks

@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Singularity](./bitburner.singularity.md) &gt; [getOwnedSourceFiles](./bitburner.singularity.getownedsourcefiles.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [getOwnedSourceFiles](./bitburner.ns.getownedsourcefiles.md)
## Singularity.getOwnedSourceFiles() method
## NS.getOwnedSourceFiles() method
Get a list of acquired Source-Files.
@ -21,7 +21,5 @@ Array containing an object with number and level of the source file.
RAM cost: 5 GB
Singularity - Level 3
Returns an array of source files

@ -53,6 +53,7 @@ export interface NS extends Singularity
| [getHacknetMultipliers()](./bitburner.ns.gethacknetmultipliers.md) | Get hacknet related multipliers. |
| [getHackTime(host)](./bitburner.ns.gethacktime.md) | Get the execution time of a hack() call. |
| [getHostname()](./bitburner.ns.gethostname.md) | Returns a string with the hostname of the server that the script is running on. |
| [getOwnedSourceFiles()](./bitburner.ns.getownedsourcefiles.md) | Get a list of acquired Source-Files. |
| [getPlayer()](./bitburner.ns.getplayer.md) | Get information about the player. |
| [getPortHandle(port)](./bitburner.ns.getporthandle.md) | Get all data on a port. |
| [getPurchasedServerCost(ram)](./bitburner.ns.getpurchasedservercost.md) | Get cost of purchasing a server. |

@ -43,7 +43,6 @@ This API requires Source-File 4 level 1 / 2 / 3 to use.
| [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. |
| [getOwnedSourceFiles()](./bitburner.singularity.getownedsourcefiles.md) | Get a list of acquired Source-Files. |
| [getStats()](./bitburner.singularity.getstats.md) | |
| [getUpgradeHomeCoresCost()](./bitburner.singularity.getupgradehomecorescost.md) | Get the price of upgrading home cores. |
| [getUpgradeHomeRamCost()](./bitburner.singularity.getupgradehomeramcost.md) | Get the price of upgrading home RAM. |

@ -3006,7 +3006,7 @@ export interface Gang {
* Get the name of all possible equipment/upgrades you can purchase for your Gang Members.
* This includes Augmentations.
*
* @returns Names of all Equpiment/Augmentations.
* @returns Names of all Equipments/Augmentations.
*/
getEquipmentNames(): string[];
@ -4974,7 +4974,7 @@ export interface NS extends Singularity {
*
* @returns Array containing an object with number and level of the source file.
*/
getOwnedSourceFiles(): SourceFileLvl[];
getOwnedSourceFiles(): SourceFileLvl[];
/**
* Get information about the player.