From f74002cce0c288d9c689a94d5aeb66a6e946c305 Mon Sep 17 00:00:00 2001 From: omuretsu <84951833+Snarling@users.noreply.github.com> Date: Fri, 7 Apr 2023 07:49:11 -0400 Subject: [PATCH] Fix and rebuild doc --- markdown/bitburner.companypositioninfo.md | 24 +++++++++ .../bitburner.companypositioninfo.name.md | 11 ++++ ...burner.companypositioninfo.nextposition.md | 11 ++++ ....companypositioninfo.requiredreputation.md | 11 ++++ ...rner.companypositioninfo.requiredskills.md | 11 ++++ .../bitburner.companypositioninfo.salary.md | 11 ++++ markdown/bitburner.md | 1 + ...rner.singularity.getcompanypositioninfo.md | 43 +++++++++++++++ ...tburner.singularity.getcompanypositions.md | 54 +++++++++++++++++++ markdown/bitburner.singularity.md | 2 + markdown/bitburner.sleeve.getnumsleeves.md | 2 +- markdown/bitburner.sleeve.md | 2 +- ...bitburner.sleeve.settobladeburneraction.md | 8 +-- markdown/bitburner.sleeve.settocompanywork.md | 4 +- markdown/bitburner.sleeve.settofactionwork.md | 4 +- src/ScriptEditor/NetscriptDefinitions.d.ts | 6 +-- 16 files changed, 192 insertions(+), 13 deletions(-) create mode 100644 markdown/bitburner.companypositioninfo.md create mode 100644 markdown/bitburner.companypositioninfo.name.md create mode 100644 markdown/bitburner.companypositioninfo.nextposition.md create mode 100644 markdown/bitburner.companypositioninfo.requiredreputation.md create mode 100644 markdown/bitburner.companypositioninfo.requiredskills.md create mode 100644 markdown/bitburner.companypositioninfo.salary.md create mode 100644 markdown/bitburner.singularity.getcompanypositioninfo.md create mode 100644 markdown/bitburner.singularity.getcompanypositions.md diff --git a/markdown/bitburner.companypositioninfo.md b/markdown/bitburner.companypositioninfo.md new file mode 100644 index 000000000..f76fd5828 --- /dev/null +++ b/markdown/bitburner.companypositioninfo.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyPositionInfo](./bitburner.companypositioninfo.md) + +## CompanyPositionInfo interface + +Company position requirements and salary. + +**Signature:** + +```typescript +export interface CompanyPositionInfo +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./bitburner.companypositioninfo.name.md) | | [JobName](./bitburner.jobname.md) | | +| [nextPosition](./bitburner.companypositioninfo.nextposition.md) | | [JobName](./bitburner.jobname.md) \| null | | +| [requiredReputation](./bitburner.companypositioninfo.requiredreputation.md) | | number | | +| [requiredSkills](./bitburner.companypositioninfo.requiredskills.md) | | [Skills](./bitburner.skills.md) | | +| [salary](./bitburner.companypositioninfo.salary.md) | | number | | + diff --git a/markdown/bitburner.companypositioninfo.name.md b/markdown/bitburner.companypositioninfo.name.md new file mode 100644 index 000000000..8d3ec7b29 --- /dev/null +++ b/markdown/bitburner.companypositioninfo.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyPositionInfo](./bitburner.companypositioninfo.md) > [name](./bitburner.companypositioninfo.name.md) + +## CompanyPositionInfo.name property + +**Signature:** + +```typescript +name: JobName; +``` diff --git a/markdown/bitburner.companypositioninfo.nextposition.md b/markdown/bitburner.companypositioninfo.nextposition.md new file mode 100644 index 000000000..0684548dc --- /dev/null +++ b/markdown/bitburner.companypositioninfo.nextposition.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyPositionInfo](./bitburner.companypositioninfo.md) > [nextPosition](./bitburner.companypositioninfo.nextposition.md) + +## CompanyPositionInfo.nextPosition property + +**Signature:** + +```typescript +nextPosition: JobName | null; +``` diff --git a/markdown/bitburner.companypositioninfo.requiredreputation.md b/markdown/bitburner.companypositioninfo.requiredreputation.md new file mode 100644 index 000000000..90785bf94 --- /dev/null +++ b/markdown/bitburner.companypositioninfo.requiredreputation.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyPositionInfo](./bitburner.companypositioninfo.md) > [requiredReputation](./bitburner.companypositioninfo.requiredreputation.md) + +## CompanyPositionInfo.requiredReputation property + +**Signature:** + +```typescript +requiredReputation: number; +``` diff --git a/markdown/bitburner.companypositioninfo.requiredskills.md b/markdown/bitburner.companypositioninfo.requiredskills.md new file mode 100644 index 000000000..2ce6b88e7 --- /dev/null +++ b/markdown/bitburner.companypositioninfo.requiredskills.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyPositionInfo](./bitburner.companypositioninfo.md) > [requiredSkills](./bitburner.companypositioninfo.requiredskills.md) + +## CompanyPositionInfo.requiredSkills property + +**Signature:** + +```typescript +requiredSkills: Skills; +``` diff --git a/markdown/bitburner.companypositioninfo.salary.md b/markdown/bitburner.companypositioninfo.salary.md new file mode 100644 index 000000000..f118d55e7 --- /dev/null +++ b/markdown/bitburner.companypositioninfo.salary.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyPositionInfo](./bitburner.companypositioninfo.md) > [salary](./bitburner.companypositioninfo.salary.md) + +## CompanyPositionInfo.salary property + +**Signature:** + +```typescript +salary: number; +``` diff --git a/markdown/bitburner.md b/markdown/bitburner.md index e11c85677..7039f9f4c 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -31,6 +31,7 @@ | [Bladeburner](./bitburner.bladeburner.md) | Bladeburner API | | [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) | Bladeburner current action. | | [CodingContract](./bitburner.codingcontract.md) | Coding Contract API | +| [CompanyPositionInfo](./bitburner.companypositioninfo.md) | Company position requirements and salary. | | [CorpConstants](./bitburner.corpconstants.md) | Corporation related constants | | [CorpIndustryData](./bitburner.corpindustrydata.md) | Data for an individual industry | | [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) | Corporation material information | diff --git a/markdown/bitburner.singularity.getcompanypositioninfo.md b/markdown/bitburner.singularity.getcompanypositioninfo.md new file mode 100644 index 000000000..bf749b512 --- /dev/null +++ b/markdown/bitburner.singularity.getcompanypositioninfo.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCompanyPositionInfo](./bitburner.singularity.getcompanypositioninfo.md) + +## Singularity.getCompanyPositionInfo() method + +Get Requirements for Company Position. + +**Signature:** + +```typescript +getCompanyPositionInfo(companyName: string, positionName: JobName): CompanyPositionInfo; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | string | Name of company to get the requirements for. Must be an exact match. | +| positionName | [JobName](./bitburner.jobname.md) | Name of position to get the requirements for. Must be an exact match. | + +**Returns:** + +[CompanyPositionInfo](./bitburner.companypositioninfo.md) + +CompanyPositionInfo object. + +## Remarks + +RAM cost: 2 GB \* 16/4/1 + +This function will return an object that contains the requirements for a specific position at a specific country. + +## Example + + +```js +const companyName = "ECorp"; +const position = "Chief Executive Officer"; + +let requirements = ns.singularity.getCompanyPositionInfo(companyName, position); +``` + diff --git a/markdown/bitburner.singularity.getcompanypositions.md b/markdown/bitburner.singularity.getcompanypositions.md new file mode 100644 index 000000000..046513aaa --- /dev/null +++ b/markdown/bitburner.singularity.getcompanypositions.md @@ -0,0 +1,54 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCompanyPositions](./bitburner.singularity.getcompanypositions.md) + +## Singularity.getCompanyPositions() method + +Get List of Company Positions. + +**Signature:** + +```typescript +getCompanyPositions(companyName: string): JobName[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | string | Name of company to get the position list for. Must be an exact match. | + +**Returns:** + +[JobName](./bitburner.jobname.md)\[\] + +The position list if the company name is valid. + +## Remarks + +RAM cost: 2 GB \* 16/4/1 + +This function will return a list of positions at a specific company. + +This function will return the position list if the company name is valid. + +## Example 1 + + +```js +// NS1: +var COMPANY_NAME = "Noodle Bar"; + +var jobList = singularity.getCompanyPositions(COMPANY_NAME); +``` + +## Example 2 + + +```js +// NS2: +const COMPANY_NAME = "Noodle Bar"; + +let jobList = ns.singularity.getCompanyPositions(COMPANY_NAME); +``` + diff --git a/markdown/bitburner.singularity.md b/markdown/bitburner.singularity.md index f5a9d52af..adf1e26dc 100644 --- a/markdown/bitburner.singularity.md +++ b/markdown/bitburner.singularity.md @@ -38,6 +38,8 @@ This API requires Source-File 4 to use. The RAM cost of all these functions is m | [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. | +| [getCompanyPositionInfo(companyName, positionName)](./bitburner.singularity.getcompanypositioninfo.md) | Get Requirements for Company Position. | +| [getCompanyPositions(companyName)](./bitburner.singularity.getcompanypositions.md) | Get List of Company Positions. | | [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. | diff --git a/markdown/bitburner.sleeve.getnumsleeves.md b/markdown/bitburner.sleeve.getnumsleeves.md index b6b1f9c60..d2fe507c7 100644 --- a/markdown/bitburner.sleeve.getnumsleeves.md +++ b/markdown/bitburner.sleeve.getnumsleeves.md @@ -15,7 +15,7 @@ getNumSleeves(): number; number -number of duplicate sleeves the player has. +Number of duplicate sleeves the player has. ## Remarks diff --git a/markdown/bitburner.sleeve.md b/markdown/bitburner.sleeve.md index f18c4a79c..dfe8d29f9 100644 --- a/markdown/bitburner.sleeve.md +++ b/markdown/bitburner.sleeve.md @@ -28,7 +28,7 @@ If you are not in BitNode-10, then you must have Source-File 10 in order to use | [getSleevePurchasableAugs(sleeveNumber)](./bitburner.sleeve.getsleevepurchasableaugs.md) | List purchasable augs for a sleeve. | | [getTask(sleeveNumber)](./bitburner.sleeve.gettask.md) | Get task of a sleeve. | | [purchaseSleeveAug(sleeveNumber, augName)](./bitburner.sleeve.purchasesleeveaug.md) | Purchase an aug for a sleeve. | -| [setToBladeburnerAction(sleeveNumber, action, contract)](./bitburner.sleeve.settobladeburneraction.md) | Set a sleeve to perform bladeburner actions. | +| [setToBladeburnerAction(sleeveNumber, action, contract)](./bitburner.sleeve.settobladeburneraction.md) | Set a sleeve to perform Bladeburner actions. | | [setToCommitCrime(sleeveNumber, crimeType)](./bitburner.sleeve.settocommitcrime.md) | Set a sleeve to commit crime. | | [setToCompanyWork(sleeveNumber, companyName)](./bitburner.sleeve.settocompanywork.md) | Set a sleeve to work for a company. | | [setToFactionWork(sleeveNumber, factionName, factionWorkType)](./bitburner.sleeve.settofactionwork.md) | Set a sleeve to work for a faction. | diff --git a/markdown/bitburner.sleeve.settobladeburneraction.md b/markdown/bitburner.sleeve.settobladeburneraction.md index 96b8cc734..08a176749 100644 --- a/markdown/bitburner.sleeve.settobladeburneraction.md +++ b/markdown/bitburner.sleeve.settobladeburneraction.md @@ -4,7 +4,7 @@ ## Sleeve.setToBladeburnerAction() method -Set a sleeve to perform bladeburner actions. +Set a sleeve to perform Bladeburner actions. **Signature:** @@ -16,7 +16,7 @@ setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): | Parameter | Type | Description | | --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to workout at the gym. | +| sleeveNumber | number | Index of the sleeve to perform a Bladeburner action. | | action | string | Name of the action to be performed. | | contract | string | _(Optional)_ Name of the contract if applicable. | @@ -24,11 +24,11 @@ setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): boolean -True if the sleeve started working out, false otherwise. +True if the sleeve started the given Bladeburner action, false otherwise. ## Remarks RAM cost: 4 GB -Return a boolean indicating whether or not the sleeve started working out. +Return a boolean indicating whether or not the sleeve started a Bladeburner action. diff --git a/markdown/bitburner.sleeve.settocompanywork.md b/markdown/bitburner.sleeve.settocompanywork.md index 72691b7c9..1a122ba6b 100644 --- a/markdown/bitburner.sleeve.settocompanywork.md +++ b/markdown/bitburner.sleeve.settocompanywork.md @@ -23,11 +23,11 @@ setToCompanyWork(sleeveNumber: number, companyName: string): boolean; boolean -True if the sleeve started working on this company, false otherwise. +True if the sleeve started working for this company, false otherwise. ## Remarks RAM cost: 4 GB -Return a boolean indicating whether or not the sleeve started working or this company. +Return a boolean indicating whether or not the sleeve started working for a company. diff --git a/markdown/bitburner.sleeve.settofactionwork.md b/markdown/bitburner.sleeve.settofactionwork.md index f6d4b0619..897c4f538 100644 --- a/markdown/bitburner.sleeve.settofactionwork.md +++ b/markdown/bitburner.sleeve.settofactionwork.md @@ -28,11 +28,11 @@ setToFactionWork( boolean \| undefined -True if the sleeve started working on this faction, false otherwise, can also throw on errors +True if the sleeve started working for this faction, false otherwise. Can also throw on errors. ## Remarks RAM cost: 4 GB -Return a boolean indicating whether or not the sleeve started working or this faction. +Return a boolean indicating whether or not the sleeve started working for a faction. diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 8a3a35d08..104aadbb8 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -1747,7 +1747,7 @@ export interface Singularity { * @param companyName - Name of company to get the position list for. Must be an exact match. * @returns The position list if the company name is valid. */ - getCompanyPositions(companyName: string): CompanyPosName[]; + getCompanyPositions(companyName: string): JobName[]; /** * Work for a company. @@ -2389,8 +2389,8 @@ export interface Singularity { * @returns - An object representing the requirements and salary for a company/position combination. */ export interface CompanyPositionInfo { - name: CompanyPosName; - nextPosition: CompanyPosName | null; + name: JobName; + nextPosition: JobName | null; salary: number; requiredReputation: number; requiredSkills: Skills;