From 22ee7fca2c2ed4493ce207b848c967b2d9bd4ad8 Mon Sep 17 00:00:00 2001 From: catloversg <152669316+catloversg@users.noreply.github.com> Date: Sat, 10 May 2025 16:28:48 +0700 Subject: [PATCH] MISC: Change how enums are exposed in NetscriptDefinitions.d.ts (#1998) --- markdown/bitburner._valueof.md | 12 + ...itburner.bladeburner.getactionautolevel.md | 9 +- ...ner.bladeburner.getactioncountremaining.md | 9 +- ...urner.bladeburner.getactioncurrentlevel.md | 9 +- ...eburner.getactionestimatedsuccesschance.md | 8 +- ...bitburner.bladeburner.getactionmaxlevel.md | 9 +- .../bitburner.bladeburner.getactionrepgain.md | 10 +- ...itburner.bladeburner.getactionsuccesses.md | 9 +- .../bitburner.bladeburner.getactiontime.md | 9 +- .../bitburner.bladeburner.getcitychaos.md | 4 +- ...itburner.bladeburner.getcitycommunities.md | 4 +- ....bladeburner.getcityestimatedpopulation.md | 4 +- .../bitburner.bladeburner.getskilllevel.md | 4 +- ...tburner.bladeburner.getskillupgradecost.md | 4 +- markdown/bitburner.bladeburner.getteamsize.md | 9 +- ...itburner.bladeburner.setactionautolevel.md | 10 +- .../bitburner.bladeburner.setactionlevel.md | 10 +- markdown/bitburner.bladeburner.setteamsize.md | 10 +- markdown/bitburner.bladeburner.startaction.md | 9 +- markdown/bitburner.bladeburner.switchcity.md | 4 +- .../bitburner.bladeburner.upgradeskill.md | 4 +- .../bitburner.bladeburneractionenumtype.md | 18 + markdown/bitburner.bladeburneractiontype.md | 15 +- ...itburner.bladeburneractiontypeforsleeve.md | 4 +- markdown/bitburner.bladeburnerblackopname.md | 32 +- ...itburner.bladeburnerblackopnameenumtype.md | 35 + markdown/bitburner.bladeburnercontractname.md | 14 +- ...tburner.bladeburnercontractnameenumtype.md | 17 + ...ladeburnerformulas.skillmaxupgradecount.md | 8 +- .../bitburner.bladeburnergeneralactionname.md | 17 +- ...er.bladeburnergeneralactionnameenumtype.md | 20 + .../bitburner.bladeburneroperationname.md | 17 +- ...burner.bladeburneroperationnameenumtype.md | 20 + markdown/bitburner.bladeburnerskillname.md | 23 +- .../bitburner.bladeburnerskillnameenumtype.md | 26 + markdown/bitburner.cityname.md | 17 +- markdown/bitburner.citynameenumtype.md | 20 + ...itburner.codingcontract.getcontracttype.md | 4 +- ...tburner.codingcontract.getcontracttypes.md | 4 +- markdown/bitburner.codingcontractname.md | 39 +- .../bitburner.codingcontractnameenumtype.md | 40 + .../bitburner.codingcontractsignatures.md | 58 +- markdown/bitburner.companyname.md | 49 +- markdown/bitburner.companynameenumtype.md | 52 + markdown/bitburner.corporation.expandcity.md | 4 +- ...itburner.creatingcorporationcheckresult.md | 15 +- ....creatingcorporationcheckresultenumtype.md | 18 + markdown/bitburner.crimeenumtype.md | 25 + markdown/bitburner.crimetype.md | 22 +- markdown/bitburner.factionname.md | 47 +- markdown/bitburner.factionnameenumtype.md | 50 + markdown/bitburner.factionworkenumtype.md | 16 + markdown/bitburner.factionworktype.md | 13 +- markdown/bitburner.gymenumtype.md | 17 + markdown/bitburner.gymlocationname.md | 16 +- markdown/bitburner.gymlocationnameenumtype.md | 21 + markdown/bitburner.gymtype.md | 14 +- .../bitburner.infiltration.getinfiltration.md | 4 +- markdown/bitburner.jobfield.md | 23 +- markdown/bitburner.jobfieldenumtype.md | 26 + markdown/bitburner.jobname.md | 46 +- markdown/bitburner.jobnameenumtype.md | 49 + markdown/bitburner.locationname.md | 67 +- markdown/bitburner.locationnameenumtype.md | 77 ++ markdown/bitburner.md | 78 +- markdown/bitburner.ns.toast.md | 4 +- markdown/bitburner.nsenums.md | 28 +- markdown/bitburner.officeapi.buytea.md | 4 +- markdown/bitburner.officeapi.getoffice.md | 4 +- ...rner.officeapi.getofficesizeupgradecost.md | 4 +- markdown/bitburner.officeapi.hireemployee.md | 4 +- ...itburner.officeapi.setautojobassignment.md | 4 +- markdown/bitburner.officeapi.throwparty.md | 4 +- .../bitburner.officeapi.upgradeofficesize.md | 4 +- markdown/bitburner.orderenumtype.md | 17 + markdown/bitburner.ordertype.md | 14 +- markdown/bitburner.positionenumtype.md | 15 + markdown/bitburner.positiontype.md | 12 +- .../bitburner.singularity.applytocompany.md | 6 +- markdown/bitburner.singularity.commitcrime.md | 4 +- .../bitburner.singularity.getcompanyfavor.md | 4 +- ...tburner.singularity.getcompanyfavorgain.md | 4 +- ...rner.singularity.getcompanypositioninfo.md | 9 +- ...tburner.singularity.getcompanypositions.md | 4 +- .../bitburner.singularity.getcompanyrep.md | 4 +- .../bitburner.singularity.getcrimechance.md | 4 +- .../bitburner.singularity.getcrimestats.md | 4 +- .../bitburner.singularity.gotolocation.md | 4 +- markdown/bitburner.singularity.gymworkout.md | 6 +- markdown/bitburner.singularity.quitjob.md | 4 +- .../bitburner.singularity.traveltocity.md | 4 +- .../bitburner.singularity.universitycourse.md | 10 +- .../bitburner.singularity.workforfaction.md | 4 +- ...bitburner.sleeve.settobladeburneraction.md | 4 +- markdown/bitburner.sleeve.settocommitcrime.md | 4 +- markdown/bitburner.sleeve.settocompanywork.md | 4 +- markdown/bitburner.sleeve.settofactionwork.md | 8 +- markdown/bitburner.sleeve.settogymworkout.md | 10 +- .../bitburner.sleeve.settouniversitycourse.md | 8 +- markdown/bitburner.sleeve.travel.md | 4 +- markdown/bitburner.sleeveclasstask.md | 4 +- markdown/bitburner.sleevecrimetask.md | 2 +- markdown/bitburner.sleevefactiontask.md | 2 +- ...ecialbladeburneractionenumtypeforsleeve.md | 17 + ...r.specialbladeburneractiontypeforsleeve.md | 14 +- markdown/bitburner.studytask.location.md | 2 +- markdown/bitburner.studytask.md | 2 +- markdown/bitburner.toastvariant.md | 14 +- markdown/bitburner.toastvariantenumtype.md | 17 + markdown/bitburner.universityclassenumtype.md | 19 + markdown/bitburner.universityclasstype.md | 16 +- markdown/bitburner.universitylocationname.md | 14 +- ...itburner.universitylocationnameenumtype.md | 19 + .../bitburner.warehouseapi.bulkpurchase.md | 4 +- .../bitburner.warehouseapi.buymaterial.md | 4 +- ...urner.warehouseapi.cancelexportmaterial.md | 8 +- .../bitburner.warehouseapi.exportmaterial.md | 8 +- .../bitburner.warehouseapi.getmaterial.md | 4 +- markdown/bitburner.warehouseapi.getproduct.md | 4 +- ...er.warehouseapi.getupgradewarehousecost.md | 4 +- .../bitburner.warehouseapi.getwarehouse.md | 4 +- .../bitburner.warehouseapi.haswarehouse.md | 4 +- ...er.warehouseapi.limitmaterialproduction.md | 9 +- ...ner.warehouseapi.limitproductproduction.md | 4 +- .../bitburner.warehouseapi.makeproduct.md | 4 +- ...itburner.warehouseapi.purchasewarehouse.md | 4 +- .../bitburner.warehouseapi.sellmaterial.md | 10 +- .../bitburner.warehouseapi.sellproduct.md | 4 +- ...urner.warehouseapi.setmaterialmarketta1.md | 4 +- ...urner.warehouseapi.setmaterialmarketta2.md | 4 +- .../bitburner.warehouseapi.setsmartsupply.md | 4 +- ...urner.warehouseapi.setsmartsupplyoption.md | 9 +- ...bitburner.warehouseapi.upgradewarehouse.md | 4 +- .../bitburner.workformulas.companygains.md | 11 +- markdown/bitburner.workformulas.crimegains.md | 4 +- ...tburner.workformulas.crimesuccesschance.md | 4 +- .../bitburner.workformulas.factiongains.md | 4 +- markdown/bitburner.workformulas.gymgains.md | 6 +- .../bitburner.workformulas.universitygains.md | 10 +- src/Corporation/Actions.ts | 12 +- src/Corporation/Enums.ts | 14 +- src/Corporation/helpers.ts | 23 +- src/NetscriptFunctions/Corporation.ts | 4 +- src/ScriptEditor/NetscriptDefinitions.d.ts | 1156 ++++++++--------- 144 files changed, 1628 insertions(+), 1458 deletions(-) create mode 100644 markdown/bitburner._valueof.md create mode 100644 markdown/bitburner.bladeburneractionenumtype.md create mode 100644 markdown/bitburner.bladeburnerblackopnameenumtype.md create mode 100644 markdown/bitburner.bladeburnercontractnameenumtype.md create mode 100644 markdown/bitburner.bladeburnergeneralactionnameenumtype.md create mode 100644 markdown/bitburner.bladeburneroperationnameenumtype.md create mode 100644 markdown/bitburner.bladeburnerskillnameenumtype.md create mode 100644 markdown/bitburner.citynameenumtype.md create mode 100644 markdown/bitburner.codingcontractnameenumtype.md create mode 100644 markdown/bitburner.companynameenumtype.md create mode 100644 markdown/bitburner.creatingcorporationcheckresultenumtype.md create mode 100644 markdown/bitburner.crimeenumtype.md create mode 100644 markdown/bitburner.factionnameenumtype.md create mode 100644 markdown/bitburner.factionworkenumtype.md create mode 100644 markdown/bitburner.gymenumtype.md create mode 100644 markdown/bitburner.gymlocationnameenumtype.md create mode 100644 markdown/bitburner.jobfieldenumtype.md create mode 100644 markdown/bitburner.jobnameenumtype.md create mode 100644 markdown/bitburner.locationnameenumtype.md create mode 100644 markdown/bitburner.orderenumtype.md create mode 100644 markdown/bitburner.positionenumtype.md create mode 100644 markdown/bitburner.specialbladeburneractionenumtypeforsleeve.md create mode 100644 markdown/bitburner.toastvariantenumtype.md create mode 100644 markdown/bitburner.universityclassenumtype.md create mode 100644 markdown/bitburner.universitylocationnameenumtype.md diff --git a/markdown/bitburner._valueof.md b/markdown/bitburner._valueof.md new file mode 100644 index 000000000..87a79b6f1 --- /dev/null +++ b/markdown/bitburner._valueof.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [\_ValueOf](./bitburner._valueof.md) + +## \_ValueOf type + + +**Signature:** + +```typescript +type _ValueOf = T[keyof T]; +``` diff --git a/markdown/bitburner.bladeburner.getactionautolevel.md b/markdown/bitburner.bladeburner.getactionautolevel.md index 50161a7f2..2e96de5eb 100644 --- a/markdown/bitburner.bladeburner.getactionautolevel.md +++ b/markdown/bitburner.bladeburner.getactionautolevel.md @@ -9,18 +9,15 @@ Get whether an action is set to autolevel. **Signature:** ```typescript -getActionAutolevel( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): boolean; +getActionAutolevel(type: BladeburnerActionType, name: BladeburnerActionName): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | **Returns:** diff --git a/markdown/bitburner.bladeburner.getactioncountremaining.md b/markdown/bitburner.bladeburner.getactioncountremaining.md index 1395e8b3d..668c966cc 100644 --- a/markdown/bitburner.bladeburner.getactioncountremaining.md +++ b/markdown/bitburner.bladeburner.getactioncountremaining.md @@ -9,18 +9,15 @@ Get action count remaining. **Signature:** ```typescript -getActionCountRemaining( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; +getActionCountRemaining(type: BladeburnerActionType, name: BladeburnerActionName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | **Returns:** diff --git a/markdown/bitburner.bladeburner.getactioncurrentlevel.md b/markdown/bitburner.bladeburner.getactioncurrentlevel.md index e991ff523..47333fd1b 100644 --- a/markdown/bitburner.bladeburner.getactioncurrentlevel.md +++ b/markdown/bitburner.bladeburner.getactioncurrentlevel.md @@ -9,18 +9,15 @@ Get the current level of an action. **Signature:** ```typescript -getActionCurrentLevel( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; +getActionCurrentLevel(type: BladeburnerActionType, name: BladeburnerActionName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | **Returns:** diff --git a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md index 14895c357..afeb3b74c 100644 --- a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md +++ b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md @@ -10,8 +10,8 @@ Get estimate success chance of an action. ```typescript getActionEstimatedSuccessChance( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, + type: BladeburnerActionType, + name: BladeburnerActionName, sleeveNumber?: number, ): [number, number]; ``` @@ -20,8 +20,8 @@ getActionEstimatedSuccessChance( | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | | sleeveNumber | number | _(Optional)_ Optional. Index of the sleeve to retrieve information. | **Returns:** diff --git a/markdown/bitburner.bladeburner.getactionmaxlevel.md b/markdown/bitburner.bladeburner.getactionmaxlevel.md index 10ce0c9c9..fa4f0bd9c 100644 --- a/markdown/bitburner.bladeburner.getactionmaxlevel.md +++ b/markdown/bitburner.bladeburner.getactionmaxlevel.md @@ -9,18 +9,15 @@ Get the maximum level of an action. **Signature:** ```typescript -getActionMaxLevel( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; +getActionMaxLevel(type: BladeburnerActionType, name: BladeburnerActionName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | **Returns:** diff --git a/markdown/bitburner.bladeburner.getactionrepgain.md b/markdown/bitburner.bladeburner.getactionrepgain.md index b8a302900..a00ab51a9 100644 --- a/markdown/bitburner.bladeburner.getactionrepgain.md +++ b/markdown/bitburner.bladeburner.getactionrepgain.md @@ -9,19 +9,15 @@ Get the reputation gain of an action. **Signature:** ```typescript -getActionRepGain( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - level?: number, - ): number; +getActionRepGain(type: BladeburnerActionType, name: BladeburnerActionName, level?: number): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | | level | number | _(Optional)_ Optional number. Action level at which to calculate the gain. Will be the action's current level if not given. | **Returns:** diff --git a/markdown/bitburner.bladeburner.getactionsuccesses.md b/markdown/bitburner.bladeburner.getactionsuccesses.md index b1ce5a332..917525012 100644 --- a/markdown/bitburner.bladeburner.getactionsuccesses.md +++ b/markdown/bitburner.bladeburner.getactionsuccesses.md @@ -9,18 +9,15 @@ Get action successes. **Signature:** ```typescript -getActionSuccesses( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; +getActionSuccesses(type: BladeburnerActionType, name: BladeburnerActionName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | **Returns:** diff --git a/markdown/bitburner.bladeburner.getactiontime.md b/markdown/bitburner.bladeburner.getactiontime.md index c53a89d45..af31601b5 100644 --- a/markdown/bitburner.bladeburner.getactiontime.md +++ b/markdown/bitburner.bladeburner.getactiontime.md @@ -9,18 +9,15 @@ Get the time to complete an action. **Signature:** ```typescript -getActionTime( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; +getActionTime(type: BladeburnerActionType, name: BladeburnerActionName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | **Returns:** diff --git a/markdown/bitburner.bladeburner.getcitychaos.md b/markdown/bitburner.bladeburner.getcitychaos.md index 4787aea95..c4d77b1ab 100644 --- a/markdown/bitburner.bladeburner.getcitychaos.md +++ b/markdown/bitburner.bladeburner.getcitychaos.md @@ -9,14 +9,14 @@ Get chaos of a city. **Signature:** ```typescript -getCityChaos(city: CityName | `${CityName}`): number; +getCityChaos(city: CityName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of city. Case-sensitive | +| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive | **Returns:** diff --git a/markdown/bitburner.bladeburner.getcitycommunities.md b/markdown/bitburner.bladeburner.getcitycommunities.md index c432d1435..63e67f656 100644 --- a/markdown/bitburner.bladeburner.getcitycommunities.md +++ b/markdown/bitburner.bladeburner.getcitycommunities.md @@ -9,14 +9,14 @@ Get number of communities in a city. **Signature:** ```typescript -getCityCommunities(city: CityName | `${CityName}`): number; +getCityCommunities(city: CityName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of city. Case-sensitive | +| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive | **Returns:** diff --git a/markdown/bitburner.bladeburner.getcityestimatedpopulation.md b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md index 3ca677225..d7cce4421 100644 --- a/markdown/bitburner.bladeburner.getcityestimatedpopulation.md +++ b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md @@ -9,14 +9,14 @@ Get estimated population in city. **Signature:** ```typescript -getCityEstimatedPopulation(city: CityName | `${CityName}`): number; +getCityEstimatedPopulation(city: CityName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of city. Case-sensitive | +| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive | **Returns:** diff --git a/markdown/bitburner.bladeburner.getskilllevel.md b/markdown/bitburner.bladeburner.getskilllevel.md index 8976dd348..d11da0cb1 100644 --- a/markdown/bitburner.bladeburner.getskilllevel.md +++ b/markdown/bitburner.bladeburner.getskilllevel.md @@ -9,14 +9,14 @@ Get skill level. **Signature:** ```typescript -getSkillLevel(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`): number; +getSkillLevel(skillName: BladeburnerSkillName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)}\` | Name of skill. Case-sensitive and must be an exact match. | +| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Name of skill. Case-sensitive and must be an exact match. | **Returns:** diff --git a/markdown/bitburner.bladeburner.getskillupgradecost.md b/markdown/bitburner.bladeburner.getskillupgradecost.md index 23750202b..c363e2bd6 100644 --- a/markdown/bitburner.bladeburner.getskillupgradecost.md +++ b/markdown/bitburner.bladeburner.getskillupgradecost.md @@ -9,14 +9,14 @@ Get cost to upgrade skill. **Signature:** ```typescript -getSkillUpgradeCost(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`, count?: number): number; +getSkillUpgradeCost(skillName: BladeburnerSkillName, count?: number): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)}\` | Name of skill. Case-sensitive and must be an exact match. | +| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Name of skill. Case-sensitive and must be an exact match. | | count | number | _(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. | **Returns:** diff --git a/markdown/bitburner.bladeburner.getteamsize.md b/markdown/bitburner.bladeburner.getteamsize.md index 8a9a93574..bde617b9f 100644 --- a/markdown/bitburner.bladeburner.getteamsize.md +++ b/markdown/bitburner.bladeburner.getteamsize.md @@ -9,18 +9,15 @@ Get team size. **Signature:** ```typescript -getTeamSize( - type?: BladeburnerActionType | `${BladeburnerActionType}`, - name?: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; +getTeamSize(type?: BladeburnerActionType, name?: BladeburnerActionName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | _(Optional)_ Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | _(Optional)_ Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | _(Optional)_ Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | _(Optional)_ Name of action. Must be an exact match. | **Returns:** diff --git a/markdown/bitburner.bladeburner.setactionautolevel.md b/markdown/bitburner.bladeburner.setactionautolevel.md index 9958f487c..0a371f0bd 100644 --- a/markdown/bitburner.bladeburner.setactionautolevel.md +++ b/markdown/bitburner.bladeburner.setactionautolevel.md @@ -9,19 +9,15 @@ Set an action autolevel. **Signature:** ```typescript -setActionAutolevel( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - autoLevel: boolean, - ): void; +setActionAutolevel(type: BladeburnerActionType, name: BladeburnerActionName, autoLevel: boolean): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | | autoLevel | boolean | Whether or not to autolevel this action | **Returns:** diff --git a/markdown/bitburner.bladeburner.setactionlevel.md b/markdown/bitburner.bladeburner.setactionlevel.md index e9eafd0a8..79b42e0f7 100644 --- a/markdown/bitburner.bladeburner.setactionlevel.md +++ b/markdown/bitburner.bladeburner.setactionlevel.md @@ -9,19 +9,15 @@ Set the level of an action. **Signature:** ```typescript -setActionLevel( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - level: number, - ): void; +setActionLevel(type: BladeburnerActionType, name: BladeburnerActionName, level: number): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | | level | number | Level to set this action to. | **Returns:** diff --git a/markdown/bitburner.bladeburner.setteamsize.md b/markdown/bitburner.bladeburner.setteamsize.md index ce1066637..9585a79d9 100644 --- a/markdown/bitburner.bladeburner.setteamsize.md +++ b/markdown/bitburner.bladeburner.setteamsize.md @@ -9,19 +9,15 @@ Set team size. **Signature:** ```typescript -setTeamSize( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - size: number, - ): number; +setTeamSize(type: BladeburnerActionType, name: BladeburnerActionName, size: number): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match. | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | | size | number | Number of team members to set. Must be a non-negative integer. | **Returns:** diff --git a/markdown/bitburner.bladeburner.startaction.md b/markdown/bitburner.bladeburner.startaction.md index f6c5f6577..775b4632f 100644 --- a/markdown/bitburner.bladeburner.startaction.md +++ b/markdown/bitburner.bladeburner.startaction.md @@ -9,18 +9,15 @@ Start an action. **Signature:** ```typescript -startAction( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): boolean; +startAction(type: BladeburnerActionType, name: BladeburnerActionName): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)}\` | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)}\` | Name of action. Must be an exact match | +| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | +| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match | **Returns:** diff --git a/markdown/bitburner.bladeburner.switchcity.md b/markdown/bitburner.bladeburner.switchcity.md index c27d2786e..f0df65280 100644 --- a/markdown/bitburner.bladeburner.switchcity.md +++ b/markdown/bitburner.bladeburner.switchcity.md @@ -9,14 +9,14 @@ Travel to another city in Bladeburner. **Signature:** ```typescript -switchCity(city: CityName | `${CityName}`): boolean; +switchCity(city: CityName): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of city. Case-sensitive | +| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive | **Returns:** diff --git a/markdown/bitburner.bladeburner.upgradeskill.md b/markdown/bitburner.bladeburner.upgradeskill.md index 15f958df0..eb5ad9216 100644 --- a/markdown/bitburner.bladeburner.upgradeskill.md +++ b/markdown/bitburner.bladeburner.upgradeskill.md @@ -9,14 +9,14 @@ Upgrade skill. **Signature:** ```typescript -upgradeSkill(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`, count?: number): boolean; +upgradeSkill(skillName: BladeburnerSkillName, count?: number): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)}\` | Name of skill to be upgraded. Case-sensitive and must be an exact match. | +| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Name of skill to be upgraded. Case-sensitive and must be an exact match. | | count | number | _(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. | **Returns:** diff --git a/markdown/bitburner.bladeburneractionenumtype.md b/markdown/bitburner.bladeburneractionenumtype.md new file mode 100644 index 000000000..c90469b9c --- /dev/null +++ b/markdown/bitburner.bladeburneractionenumtype.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerActionEnumType](./bitburner.bladeburneractionenumtype.md) + +## BladeburnerActionEnumType type + +Action types of Bladeburner + +**Signature:** + +```typescript +type BladeburnerActionEnumType = { + General: "General"; + Contract: "Contracts"; + Operation: "Operations"; + BlackOp: "Black Operations"; +}; +``` diff --git a/markdown/bitburner.bladeburneractiontype.md b/markdown/bitburner.bladeburneractiontype.md index 900098568..af264c702 100644 --- a/markdown/bitburner.bladeburneractiontype.md +++ b/markdown/bitburner.bladeburneractiontype.md @@ -2,22 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerActionType](./bitburner.bladeburneractiontype.md) -## BladeburnerActionType enum +## BladeburnerActionType type -Action types of Bladeburner **Signature:** ```typescript -declare enum BladeburnerActionType +type BladeburnerActionType = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| BlackOp | "Black Operations" | | -| Contract | "Contracts" | | -| General | "General" | | -| Operation | "Operations" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [BladeburnerActionEnumType](./bitburner.bladeburneractionenumtype.md) diff --git a/markdown/bitburner.bladeburneractiontypeforsleeve.md b/markdown/bitburner.bladeburneractiontypeforsleeve.md index dcfd5f57d..d10f469f9 100644 --- a/markdown/bitburner.bladeburneractiontypeforsleeve.md +++ b/markdown/bitburner.bladeburneractiontypeforsleeve.md @@ -9,8 +9,8 @@ ```typescript export type BladeburnerActionTypeForSleeve = - | Exclude + | Exclude | SpecialBladeburnerActionTypeForSleeve; ``` -**References:** [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md), [BladeburnerGeneralActionName.InciteViolence](./bitburner.bladeburnergeneralactionname.md), [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md) +**References:** [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md), [BladeburnerGeneralActionNameEnumType](./bitburner.bladeburnergeneralactionnameenumtype.md), [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md) diff --git a/markdown/bitburner.bladeburnerblackopname.md b/markdown/bitburner.bladeburnerblackopname.md index 366752ccb..269daa25e 100644 --- a/markdown/bitburner.bladeburnerblackopname.md +++ b/markdown/bitburner.bladeburnerblackopname.md @@ -2,39 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) -## BladeburnerBlackOpName enum +## BladeburnerBlackOpName type -Black Operation names of Bladeburner **Signature:** ```typescript -declare enum BladeburnerBlackOpName +type BladeburnerBlackOpName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| OperationAnnihilus | "Operation Annihilus" | | -| OperationArchangel | "Operation Archangel" | | -| OperationAres | "Operation Ares" | | -| OperationCenturion | "Operation Centurion" | | -| OperationDaedalus | "Operation Daedalus" | | -| OperationDeckard | "Operation Deckard" | | -| OperationHyron | "Operation Hyron" | | -| OperationIonStorm | "Operation Ion Storm" | | -| OperationJuggernaut | "Operation Juggernaut" | | -| OperationK | "Operation K" | | -| OperationMorpheus | "Operation Morpheus" | | -| OperationRedDragon | "Operation Red Dragon" | | -| OperationShoulderOfOrion | "Operation Shoulder of Orion" | | -| OperationTitan | "Operation Titan" | | -| OperationTyphoon | "Operation Typhoon" | | -| OperationTyrell | "Operation Tyrell" | | -| OperationUltron | "Operation Ultron" | | -| OperationVindictus | "Operation Vindictus" | | -| OperationWallace | "Operation Wallace" | | -| OperationX | "Operation X" | | -| OperationZero | "Operation Zero" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [BladeburnerBlackOpNameEnumType](./bitburner.bladeburnerblackopnameenumtype.md) diff --git a/markdown/bitburner.bladeburnerblackopnameenumtype.md b/markdown/bitburner.bladeburnerblackopnameenumtype.md new file mode 100644 index 000000000..837690682 --- /dev/null +++ b/markdown/bitburner.bladeburnerblackopnameenumtype.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerBlackOpNameEnumType](./bitburner.bladeburnerblackopnameenumtype.md) + +## BladeburnerBlackOpNameEnumType type + +Black Operation names of Bladeburner + +**Signature:** + +```typescript +type BladeburnerBlackOpNameEnumType = { + OperationTyphoon: "Operation Typhoon"; + OperationZero: "Operation Zero"; + OperationX: "Operation X"; + OperationTitan: "Operation Titan"; + OperationAres: "Operation Ares"; + OperationArchangel: "Operation Archangel"; + OperationJuggernaut: "Operation Juggernaut"; + OperationRedDragon: "Operation Red Dragon"; + OperationK: "Operation K"; + OperationDeckard: "Operation Deckard"; + OperationTyrell: "Operation Tyrell"; + OperationWallace: "Operation Wallace"; + OperationShoulderOfOrion: "Operation Shoulder of Orion"; + OperationHyron: "Operation Hyron"; + OperationMorpheus: "Operation Morpheus"; + OperationIonStorm: "Operation Ion Storm"; + OperationAnnihilus: "Operation Annihilus"; + OperationUltron: "Operation Ultron"; + OperationCenturion: "Operation Centurion"; + OperationVindictus: "Operation Vindictus"; + OperationDaedalus: "Operation Daedalus"; +}; +``` diff --git a/markdown/bitburner.bladeburnercontractname.md b/markdown/bitburner.bladeburnercontractname.md index 804aa3c4b..cea77a028 100644 --- a/markdown/bitburner.bladeburnercontractname.md +++ b/markdown/bitburner.bladeburnercontractname.md @@ -2,21 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerContractName](./bitburner.bladeburnercontractname.md) -## BladeburnerContractName enum +## BladeburnerContractName type -Contract names of Bladeburner **Signature:** ```typescript -declare enum BladeburnerContractName +type BladeburnerContractName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| BountyHunter | "Bounty Hunter" | | -| Retirement | "Retirement" | | -| Tracking | "Tracking" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [BladeburnerContractNameEnumType](./bitburner.bladeburnercontractnameenumtype.md) diff --git a/markdown/bitburner.bladeburnercontractnameenumtype.md b/markdown/bitburner.bladeburnercontractnameenumtype.md new file mode 100644 index 000000000..645c3775d --- /dev/null +++ b/markdown/bitburner.bladeburnercontractnameenumtype.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerContractNameEnumType](./bitburner.bladeburnercontractnameenumtype.md) + +## BladeburnerContractNameEnumType type + +Contract names of Bladeburner + +**Signature:** + +```typescript +type BladeburnerContractNameEnumType = { + Tracking: "Tracking"; + BountyHunter: "Bounty Hunter"; + Retirement: "Retirement"; +}; +``` diff --git a/markdown/bitburner.bladeburnerformulas.skillmaxupgradecount.md b/markdown/bitburner.bladeburnerformulas.skillmaxupgradecount.md index 7ab4f10c5..dfaa32c82 100644 --- a/markdown/bitburner.bladeburnerformulas.skillmaxupgradecount.md +++ b/markdown/bitburner.bladeburnerformulas.skillmaxupgradecount.md @@ -9,18 +9,14 @@ Calculate the number of times that you can upgrade a skill. **Signature:** ```typescript -skillMaxUpgradeCount( - name: BladeburnerSkillName | `${BladeburnerSkillName}`, - level: number, - skillPoints: number, - ): number; +skillMaxUpgradeCount(name: BladeburnerSkillName, level: number, skillPoints: number): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)}\` | Skill name. It's case-sensitive and must be an exact match. | +| name | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Skill name. It's case-sensitive and must be an exact match. | | level | number | Skill level. It must be a non-negative number. | | skillPoints | number | Number of skill points to upgrade the skill. It must be a non-negative number. | diff --git a/markdown/bitburner.bladeburnergeneralactionname.md b/markdown/bitburner.bladeburnergeneralactionname.md index 5f82ec9af..8f62192aa 100644 --- a/markdown/bitburner.bladeburnergeneralactionname.md +++ b/markdown/bitburner.bladeburnergeneralactionname.md @@ -2,24 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md) -## BladeburnerGeneralActionName enum +## BladeburnerGeneralActionName type -General action names of Bladeburner **Signature:** ```typescript -declare enum BladeburnerGeneralActionName +type BladeburnerGeneralActionName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Diplomacy | "Diplomacy" | | -| FieldAnalysis | "Field Analysis" | | -| HyperbolicRegen | "Hyperbolic Regeneration Chamber" | | -| InciteViolence | "Incite Violence" | | -| Recruitment | "Recruitment" | | -| Training | "Training" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [BladeburnerGeneralActionNameEnumType](./bitburner.bladeburnergeneralactionnameenumtype.md) diff --git a/markdown/bitburner.bladeburnergeneralactionnameenumtype.md b/markdown/bitburner.bladeburnergeneralactionnameenumtype.md new file mode 100644 index 000000000..38a6a260b --- /dev/null +++ b/markdown/bitburner.bladeburnergeneralactionnameenumtype.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerGeneralActionNameEnumType](./bitburner.bladeburnergeneralactionnameenumtype.md) + +## BladeburnerGeneralActionNameEnumType type + +General action names of Bladeburner + +**Signature:** + +```typescript +type BladeburnerGeneralActionNameEnumType = { + Training: "Training"; + FieldAnalysis: "Field Analysis"; + Recruitment: "Recruitment"; + Diplomacy: "Diplomacy"; + HyperbolicRegen: "Hyperbolic Regeneration Chamber"; + InciteViolence: "Incite Violence"; +}; +``` diff --git a/markdown/bitburner.bladeburneroperationname.md b/markdown/bitburner.bladeburneroperationname.md index fd89e7277..a2fa1ac27 100644 --- a/markdown/bitburner.bladeburneroperationname.md +++ b/markdown/bitburner.bladeburneroperationname.md @@ -2,24 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerOperationName](./bitburner.bladeburneroperationname.md) -## BladeburnerOperationName enum +## BladeburnerOperationName type -Operation names of Bladeburner **Signature:** ```typescript -declare enum BladeburnerOperationName +type BladeburnerOperationName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Assassination | "Assassination" | | -| Investigation | "Investigation" | | -| Raid | "Raid" | | -| StealthRetirement | "Stealth Retirement Operation" | | -| Sting | "Sting Operation" | | -| Undercover | "Undercover Operation" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [BladeburnerOperationNameEnumType](./bitburner.bladeburneroperationnameenumtype.md) diff --git a/markdown/bitburner.bladeburneroperationnameenumtype.md b/markdown/bitburner.bladeburneroperationnameenumtype.md new file mode 100644 index 000000000..a68af0e17 --- /dev/null +++ b/markdown/bitburner.bladeburneroperationnameenumtype.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerOperationNameEnumType](./bitburner.bladeburneroperationnameenumtype.md) + +## BladeburnerOperationNameEnumType type + +Operation names of Bladeburner + +**Signature:** + +```typescript +type BladeburnerOperationNameEnumType = { + Investigation: "Investigation"; + Undercover: "Undercover Operation"; + Sting: "Sting Operation"; + Raid: "Raid"; + StealthRetirement: "Stealth Retirement Operation"; + Assassination: "Assassination"; +}; +``` diff --git a/markdown/bitburner.bladeburnerskillname.md b/markdown/bitburner.bladeburnerskillname.md index 5fdefb527..c561c5bbf 100644 --- a/markdown/bitburner.bladeburnerskillname.md +++ b/markdown/bitburner.bladeburnerskillname.md @@ -2,30 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) -## BladeburnerSkillName enum +## BladeburnerSkillName type -Skill names type of Bladeburner **Signature:** ```typescript -declare enum BladeburnerSkillName +type BladeburnerSkillName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| BladesIntuition | "Blade's Intuition" | | -| Cloak | "Cloak" | | -| CybersEdge | "Cyber's Edge" | | -| Datamancer | "Datamancer" | | -| DigitalObserver | "Digital Observer" | | -| EvasiveSystem | "Evasive System" | | -| HandsOfMidas | "Hands of Midas" | | -| Hyperdrive | "Hyperdrive" | | -| Overclock | "Overclock" | | -| Reaper | "Reaper" | | -| ShortCircuit | "Short-Circuit" | | -| Tracer | "Tracer" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [BladeburnerSkillNameEnumType](./bitburner.bladeburnerskillnameenumtype.md) diff --git a/markdown/bitburner.bladeburnerskillnameenumtype.md b/markdown/bitburner.bladeburnerskillnameenumtype.md new file mode 100644 index 000000000..eb27ce401 --- /dev/null +++ b/markdown/bitburner.bladeburnerskillnameenumtype.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerSkillNameEnumType](./bitburner.bladeburnerskillnameenumtype.md) + +## BladeburnerSkillNameEnumType type + +Skill names type of Bladeburner + +**Signature:** + +```typescript +type BladeburnerSkillNameEnumType = { + BladesIntuition: "Blade's Intuition"; + Cloak: "Cloak"; + ShortCircuit: "Short-Circuit"; + DigitalObserver: "Digital Observer"; + Tracer: "Tracer"; + Overclock: "Overclock"; + Reaper: "Reaper"; + EvasiveSystem: "Evasive System"; + Datamancer: "Datamancer"; + CybersEdge: "Cyber's Edge"; + HandsOfMidas: "Hands of Midas"; + Hyperdrive: "Hyperdrive"; +}; +``` diff --git a/markdown/bitburner.cityname.md b/markdown/bitburner.cityname.md index 5a3da78b3..cf853369d 100644 --- a/markdown/bitburner.cityname.md +++ b/markdown/bitburner.cityname.md @@ -2,24 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [CityName](./bitburner.cityname.md) -## CityName enum +## CityName type -Names of all cities **Signature:** ```typescript -declare enum CityName +type CityName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Aevum | "Aevum" | | -| Chongqing | "Chongqing" | | -| Ishima | "Ishima" | | -| NewTokyo | "New Tokyo" | | -| Sector12 | "Sector-12" | | -| Volhaven | "Volhaven" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [CityNameEnumType](./bitburner.citynameenumtype.md) diff --git a/markdown/bitburner.citynameenumtype.md b/markdown/bitburner.citynameenumtype.md new file mode 100644 index 000000000..8d853e0bb --- /dev/null +++ b/markdown/bitburner.citynameenumtype.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CityNameEnumType](./bitburner.citynameenumtype.md) + +## CityNameEnumType type + +Names of all cities + +**Signature:** + +```typescript +type CityNameEnumType = { + Aevum: "Aevum"; + Chongqing: "Chongqing"; + Sector12: "Sector-12"; + NewTokyo: "New Tokyo"; + Ishima: "Ishima"; + Volhaven: "Volhaven"; +}; +``` diff --git a/markdown/bitburner.codingcontract.getcontracttype.md b/markdown/bitburner.codingcontract.getcontracttype.md index 9c5e3815c..038e45d99 100644 --- a/markdown/bitburner.codingcontract.getcontracttype.md +++ b/markdown/bitburner.codingcontract.getcontracttype.md @@ -9,7 +9,7 @@ Get the type of a coding contract. **Signature:** ```typescript -getContractType(filename: string, host?: string): `${CodingContractName}`; +getContractType(filename: string, host?: string): CodingContractName; ``` ## Parameters @@ -21,7 +21,7 @@ getContractType(filename: string, host?: string): `${CodingContractName}`; **Returns:** -\`${[CodingContractName](./bitburner.codingcontractname.md)}\` +[CodingContractName](./bitburner.codingcontractname.md) Name describing the type of problem posed by the Coding Contract. diff --git a/markdown/bitburner.codingcontract.getcontracttypes.md b/markdown/bitburner.codingcontract.getcontracttypes.md index 33935ac5e..32e06d200 100644 --- a/markdown/bitburner.codingcontract.getcontracttypes.md +++ b/markdown/bitburner.codingcontract.getcontracttypes.md @@ -9,11 +9,11 @@ List all contract types. **Signature:** ```typescript -getContractTypes(): `${CodingContractName}`[]; +getContractTypes(): CodingContractName[]; ``` **Returns:** -\`${[CodingContractName](./bitburner.codingcontractname.md)}\`\[\] +[CodingContractName](./bitburner.codingcontractname.md)\[\] ## Remarks diff --git a/markdown/bitburner.codingcontractname.md b/markdown/bitburner.codingcontractname.md index 07871c196..c7e3051c2 100644 --- a/markdown/bitburner.codingcontractname.md +++ b/markdown/bitburner.codingcontractname.md @@ -2,44 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [CodingContractName](./bitburner.codingcontractname.md) -## CodingContractName enum +## CodingContractName type + **Signature:** ```typescript -declare enum CodingContractName +type CodingContractName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| AlgorithmicStockTraderI | "Algorithmic Stock Trader I" | | -| AlgorithmicStockTraderII | "Algorithmic Stock Trader II" | | -| AlgorithmicStockTraderIII | "Algorithmic Stock Trader III" | | -| AlgorithmicStockTraderIV | "Algorithmic Stock Trader IV" | | -| ArrayJumpingGame | "Array Jumping Game" | | -| ArrayJumpingGameII | "Array Jumping Game II" | | -| CompressionIIILZCompression | "Compression III: LZ Compression" | | -| CompressionIILZDecompression | "Compression II: LZ Decompression" | | -| CompressionIRLECompression | "Compression I: RLE Compression" | | -| EncryptionICaesarCipher | "Encryption I: Caesar Cipher" | | -| EncryptionIIVigenereCipher | "Encryption II: Vigenère Cipher" | | -| FindAllValidMathExpressions | "Find All Valid Math Expressions" | | -| FindLargestPrimeFactor | "Find Largest Prime Factor" | | -| GenerateIPAddresses | "Generate IP Addresses" | | -| HammingCodesEncodedBinaryToInteger | "HammingCodes: Encoded Binary to Integer" | | -| HammingCodesIntegerToEncodedBinary | "HammingCodes: Integer to Encoded Binary" | | -| MergeOverlappingIntervals | "Merge Overlapping Intervals" | | -| MinimumPathSumInATriangle | "Minimum Path Sum in a Triangle" | | -| Proper2ColoringOfAGraph | "Proper 2-Coloring of a Graph" | | -| SanitizeParenthesesInExpression | "Sanitize Parentheses in Expression" | | -| ShortestPathInAGrid | "Shortest Path in a Grid" | | -| SpiralizeMatrix | "Spiralize Matrix" | | -| SquareRoot | "Square Root" | | -| SubarrayWithMaximumSum | "Subarray with Maximum Sum" | | -| TotalWaysToSum | "Total Ways to Sum" | | -| TotalWaysToSumII | "Total Ways to Sum II" | | -| UniquePathsInAGridI | "Unique Paths in a Grid I" | | -| UniquePathsInAGridII | "Unique Paths in a Grid II" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [CodingContractNameEnumType](./bitburner.codingcontractnameenumtype.md) diff --git a/markdown/bitburner.codingcontractnameenumtype.md b/markdown/bitburner.codingcontractnameenumtype.md new file mode 100644 index 000000000..3e09bea13 --- /dev/null +++ b/markdown/bitburner.codingcontractnameenumtype.md @@ -0,0 +1,40 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContractNameEnumType](./bitburner.codingcontractnameenumtype.md) + +## CodingContractNameEnumType type + +**Signature:** + +```typescript +type CodingContractNameEnumType = { + FindLargestPrimeFactor: "Find Largest Prime Factor"; + SubarrayWithMaximumSum: "Subarray with Maximum Sum"; + TotalWaysToSum: "Total Ways to Sum"; + TotalWaysToSumII: "Total Ways to Sum II"; + SpiralizeMatrix: "Spiralize Matrix"; + ArrayJumpingGame: "Array Jumping Game"; + ArrayJumpingGameII: "Array Jumping Game II"; + MergeOverlappingIntervals: "Merge Overlapping Intervals"; + GenerateIPAddresses: "Generate IP Addresses"; + AlgorithmicStockTraderI: "Algorithmic Stock Trader I"; + AlgorithmicStockTraderII: "Algorithmic Stock Trader II"; + AlgorithmicStockTraderIII: "Algorithmic Stock Trader III"; + AlgorithmicStockTraderIV: "Algorithmic Stock Trader IV"; + MinimumPathSumInATriangle: "Minimum Path Sum in a Triangle"; + UniquePathsInAGridI: "Unique Paths in a Grid I"; + UniquePathsInAGridII: "Unique Paths in a Grid II"; + ShortestPathInAGrid: "Shortest Path in a Grid"; + SanitizeParenthesesInExpression: "Sanitize Parentheses in Expression"; + FindAllValidMathExpressions: "Find All Valid Math Expressions"; + HammingCodesIntegerToEncodedBinary: "HammingCodes: Integer to Encoded Binary"; + HammingCodesEncodedBinaryToInteger: "HammingCodes: Encoded Binary to Integer"; + Proper2ColoringOfAGraph: "Proper 2-Coloring of a Graph"; + CompressionIRLECompression: "Compression I: RLE Compression"; + CompressionIILZDecompression: "Compression II: LZ Decompression"; + CompressionIIILZCompression: "Compression III: LZ Compression"; + EncryptionICaesarCipher: "Encryption I: Caesar Cipher"; + EncryptionIIVigenereCipher: "Encryption II: Vigenère Cipher"; + SquareRoot: "Square Root"; +}; +``` diff --git a/markdown/bitburner.codingcontractsignatures.md b/markdown/bitburner.codingcontractsignatures.md index b2b3f1317..3b5e5a151 100644 --- a/markdown/bitburner.codingcontractsignatures.md +++ b/markdown/bitburner.codingcontractsignatures.md @@ -8,35 +8,33 @@ ```typescript export type CodingContractSignatures = { - [CodingContractName.FindLargestPrimeFactor]: [number, number]; - [CodingContractName.SubarrayWithMaximumSum]: [number[], number]; - [CodingContractName.TotalWaysToSum]: [number, number]; - [CodingContractName.TotalWaysToSumII]: [[number, number[]], number]; - [CodingContractName.SpiralizeMatrix]: [number[][], number[]]; - [CodingContractName.ArrayJumpingGame]: [number[], 1 | 0]; - [CodingContractName.ArrayJumpingGameII]: [number[], number]; - [CodingContractName.MergeOverlappingIntervals]: [[number, number][], [number, number][]]; - [CodingContractName.GenerateIPAddresses]: [string, string[]]; - [CodingContractName.AlgorithmicStockTraderI]: [number[], number]; - [CodingContractName.AlgorithmicStockTraderII]: [number[], number]; - [CodingContractName.AlgorithmicStockTraderIII]: [number[], number]; - [CodingContractName.AlgorithmicStockTraderIV]: [[number, number[]], number]; - [CodingContractName.MinimumPathSumInATriangle]: [number[][], number]; - [CodingContractName.UniquePathsInAGridI]: [[number, number], number]; - [CodingContractName.UniquePathsInAGridII]: [(1 | 0)[][], number]; - [CodingContractName.ShortestPathInAGrid]: [(1 | 0)[][], string]; - [CodingContractName.SanitizeParenthesesInExpression]: [string, string[]]; - [CodingContractName.FindAllValidMathExpressions]: [[string, number], string[]]; - [CodingContractName.HammingCodesIntegerToEncodedBinary]: [number, string]; - [CodingContractName.HammingCodesEncodedBinaryToInteger]: [string, number]; - [CodingContractName.Proper2ColoringOfAGraph]: [[number, [number, number][]], (1 | 0)[]]; - [CodingContractName.CompressionIRLECompression]: [string, string]; - [CodingContractName.CompressionIILZDecompression]: [string, string]; - [CodingContractName.CompressionIIILZCompression]: [string, string]; - [CodingContractName.EncryptionICaesarCipher]: [[string, number], string]; - [CodingContractName.EncryptionIIVigenereCipher]: [[string, string], string]; - [CodingContractName.SquareRoot]: [bigint, bigint, [string, string]]; + "Find Largest Prime Factor": [number, number]; + "Subarray with Maximum Sum": [number[], number]; + "Total Ways to Sum": [number, number]; + "Total Ways to Sum II": [[number, number[]], number]; + "Spiralize Matrix": [number[][], number[]]; + "Array Jumping Game": [number[], 1 | 0]; + "Array Jumping Game II": [number[], number]; + "Merge Overlapping Intervals": [[number, number][], [number, number][]]; + "Generate IP Addresses": [string, string[]]; + "Algorithmic Stock Trader I": [number[], number]; + "Algorithmic Stock Trader II": [number[], number]; + "Algorithmic Stock Trader III": [number[], number]; + "Algorithmic Stock Trader IV": [[number, number[]], number]; + "Minimum Path Sum in a Triangle": [number[][], number]; + "Unique Paths in a Grid I": [[number, number], number]; + "Unique Paths in a Grid II": [(1 | 0)[][], number]; + "Shortest Path in a Grid": [(1 | 0)[][], string]; + "Sanitize Parentheses in Expression": [string, string[]]; + "Find All Valid Math Expressions": [[string, number], string[]]; + "HammingCodes: Integer to Encoded Binary": [number, string]; + "HammingCodes: Encoded Binary to Integer": [string, number]; + "Proper 2-Coloring of a Graph": [[number, [number, number][]], (1 | 0)[]]; + "Compression I: RLE Compression": [string, string]; + "Compression II: LZ Decompression": [string, string]; + "Compression III: LZ Compression": [string, string]; + "Encryption I: Caesar Cipher": [[string, number], string]; + "Encryption II: Vigenère Cipher": [[string, string], string]; + "Square Root": [bigint, bigint, [string, string]]; }; ``` -**References:** [CodingContractName.FindLargestPrimeFactor](./bitburner.codingcontractname.md), [CodingContractName.SubarrayWithMaximumSum](./bitburner.codingcontractname.md), [CodingContractName.TotalWaysToSum](./bitburner.codingcontractname.md), [CodingContractName.TotalWaysToSumII](./bitburner.codingcontractname.md), [CodingContractName.SpiralizeMatrix](./bitburner.codingcontractname.md), [CodingContractName.ArrayJumpingGame](./bitburner.codingcontractname.md), [CodingContractName.ArrayJumpingGameII](./bitburner.codingcontractname.md), [CodingContractName.MergeOverlappingIntervals](./bitburner.codingcontractname.md), [CodingContractName.GenerateIPAddresses](./bitburner.codingcontractname.md), [CodingContractName.AlgorithmicStockTraderI](./bitburner.codingcontractname.md), [CodingContractName.AlgorithmicStockTraderII](./bitburner.codingcontractname.md), [CodingContractName.AlgorithmicStockTraderIII](./bitburner.codingcontractname.md), [CodingContractName.AlgorithmicStockTraderIV](./bitburner.codingcontractname.md), [CodingContractName.MinimumPathSumInATriangle](./bitburner.codingcontractname.md), [CodingContractName.UniquePathsInAGridI](./bitburner.codingcontractname.md), [CodingContractName.UniquePathsInAGridII](./bitburner.codingcontractname.md), [CodingContractName.ShortestPathInAGrid](./bitburner.codingcontractname.md), [CodingContractName.SanitizeParenthesesInExpression](./bitburner.codingcontractname.md), [CodingContractName.FindAllValidMathExpressions](./bitburner.codingcontractname.md), [CodingContractName.HammingCodesIntegerToEncodedBinary](./bitburner.codingcontractname.md), [CodingContractName.HammingCodesEncodedBinaryToInteger](./bitburner.codingcontractname.md), [CodingContractName.Proper2ColoringOfAGraph](./bitburner.codingcontractname.md), [CodingContractName.CompressionIRLECompression](./bitburner.codingcontractname.md), [CodingContractName.CompressionIILZDecompression](./bitburner.codingcontractname.md), [CodingContractName.CompressionIIILZCompression](./bitburner.codingcontractname.md), [CodingContractName.EncryptionICaesarCipher](./bitburner.codingcontractname.md), [CodingContractName.EncryptionIIVigenereCipher](./bitburner.codingcontractname.md), [CodingContractName.SquareRoot](./bitburner.codingcontractname.md) - diff --git a/markdown/bitburner.companyname.md b/markdown/bitburner.companyname.md index 52b4ca061..6b4e5c39d 100644 --- a/markdown/bitburner.companyname.md +++ b/markdown/bitburner.companyname.md @@ -2,56 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [CompanyName](./bitburner.companyname.md) -## CompanyName enum +## CompanyName type -Names of all companies **Signature:** ```typescript -declare enum CompanyName +type CompanyName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| AeroCorp | "AeroCorp" | | -| AlphaEnterprises | "Alpha Enterprises" | | -| BachmanAndAssociates | "Bachman & Associates" | | -| BladeIndustries | "Blade Industries" | | -| CarmichaelSecurity | "Carmichael Security" | | -| CIA | "Central Intelligence Agency" | | -| ClarkeIncorporated | "Clarke Incorporated" | | -| CompuTek | "CompuTek" | | -| DefComm | "DefComm" | | -| DeltaOne | "DeltaOne" | | -| ECorp | "ECorp" | | -| FoodNStuff | "FoodNStuff" | | -| FourSigma | "Four Sigma" | | -| FulcrumTechnologies | "Fulcrum Technologies" | | -| GalacticCybersystems | "Galactic Cybersystems" | | -| GlobalPharmaceuticals | "Global Pharmaceuticals" | | -| HeliosLabs | "Helios Labs" | | -| IcarusMicrosystems | "Icarus Microsystems" | | -| JoesGuns | "Joe's Guns" | | -| KuaiGongInternational | "KuaiGong International" | | -| LexoCorp | "LexoCorp" | | -| MegaCorp | "MegaCorp" | | -| NetLinkTechnologies | "NetLink Technologies" | | -| NoodleBar | "Noodle Bar" | | -| NovaMedical | "Nova Medical" | | -| NSA | "National Security Agency" | | -| NWO | "NWO" | | -| OmegaSoftware | "Omega Software" | | -| OmniaCybersystems | "Omnia Cybersystems" | | -| OmniTekIncorporated | "OmniTek Incorporated" | | -| Police | "Aevum Police Headquarters" | | -| RhoConstruction | "Rho Construction" | | -| SolarisSpaceSystems | "Solaris Space Systems" | | -| StormTechnologies | "Storm Technologies" | | -| SysCoreSecurities | "SysCore Securities" | | -| UniversalEnergy | "Universal Energy" | | -| VitaLife | "VitaLife" | | -| WatchdogSecurity | "Watchdog Security" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [CompanyNameEnumType](./bitburner.companynameenumtype.md) diff --git a/markdown/bitburner.companynameenumtype.md b/markdown/bitburner.companynameenumtype.md new file mode 100644 index 000000000..e4f206ef1 --- /dev/null +++ b/markdown/bitburner.companynameenumtype.md @@ -0,0 +1,52 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyNameEnumType](./bitburner.companynameenumtype.md) + +## CompanyNameEnumType type + +Names of all companies + +**Signature:** + +```typescript +type CompanyNameEnumType = { + ECorp: "ECorp"; + MegaCorp: "MegaCorp"; + BachmanAndAssociates: "Bachman & Associates"; + BladeIndustries: "Blade Industries"; + NWO: "NWO"; + ClarkeIncorporated: "Clarke Incorporated"; + OmniTekIncorporated: "OmniTek Incorporated"; + FourSigma: "Four Sigma"; + KuaiGongInternational: "KuaiGong International"; + FulcrumTechnologies: "Fulcrum Technologies"; + StormTechnologies: "Storm Technologies"; + DefComm: "DefComm"; + HeliosLabs: "Helios Labs"; + VitaLife: "VitaLife"; + IcarusMicrosystems: "Icarus Microsystems"; + UniversalEnergy: "Universal Energy"; + GalacticCybersystems: "Galactic Cybersystems"; + AeroCorp: "AeroCorp"; + OmniaCybersystems: "Omnia Cybersystems"; + SolarisSpaceSystems: "Solaris Space Systems"; + DeltaOne: "DeltaOne"; + GlobalPharmaceuticals: "Global Pharmaceuticals"; + NovaMedical: "Nova Medical"; + CIA: "Central Intelligence Agency"; + NSA: "National Security Agency"; + WatchdogSecurity: "Watchdog Security"; + LexoCorp: "LexoCorp"; + RhoConstruction: "Rho Construction"; + AlphaEnterprises: "Alpha Enterprises"; + Police: "Aevum Police Headquarters"; + SysCoreSecurities: "SysCore Securities"; + CompuTek: "CompuTek"; + NetLinkTechnologies: "NetLink Technologies"; + CarmichaelSecurity: "Carmichael Security"; + FoodNStuff: "FoodNStuff"; + JoesGuns: "Joe's Guns"; + OmegaSoftware: "Omega Software"; + NoodleBar: "Noodle Bar"; +}; +``` diff --git a/markdown/bitburner.corporation.expandcity.md b/markdown/bitburner.corporation.expandcity.md index 479a993fb..163177de0 100644 --- a/markdown/bitburner.corporation.expandcity.md +++ b/markdown/bitburner.corporation.expandcity.md @@ -9,7 +9,7 @@ Expand to a new city. **Signature:** ```typescript -expandCity(divisionName: string, city: CityName | `${CityName}`): void; +expandCity(divisionName: string, city: CityName): void; ``` ## Parameters @@ -17,7 +17,7 @@ expandCity(divisionName: string, city: CityName | `${CityName}`): void; | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | **Returns:** diff --git a/markdown/bitburner.creatingcorporationcheckresult.md b/markdown/bitburner.creatingcorporationcheckresult.md index 16bb82a31..67602f355 100644 --- a/markdown/bitburner.creatingcorporationcheckresult.md +++ b/markdown/bitburner.creatingcorporationcheckresult.md @@ -2,22 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [CreatingCorporationCheckResult](./bitburner.creatingcorporationcheckresult.md) -## CreatingCorporationCheckResult enum +## CreatingCorporationCheckResult type **Signature:** ```typescript -declare enum CreatingCorporationCheckResult +type CreatingCorporationCheckResult = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| CorporationExists | "CorporationExists" | | -| DisabledBySoftCap | "DisabledBySoftCap" | | -| NoSf3OrDisabled | "NoSf3OrDisabled" | | -| Success | "Success" | | -| UseSeedMoneyOutsideBN3 | "UseSeedMoneyOutsideBN3" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [CreatingCorporationCheckResultEnumType](./bitburner.creatingcorporationcheckresultenumtype.md) diff --git a/markdown/bitburner.creatingcorporationcheckresultenumtype.md b/markdown/bitburner.creatingcorporationcheckresultenumtype.md new file mode 100644 index 000000000..a3905a2cb --- /dev/null +++ b/markdown/bitburner.creatingcorporationcheckresultenumtype.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CreatingCorporationCheckResultEnumType](./bitburner.creatingcorporationcheckresultenumtype.md) + +## CreatingCorporationCheckResultEnumType type + + +**Signature:** + +```typescript +type CreatingCorporationCheckResultEnumType = { + Success: "Success"; + NoSf3OrDisabled: "NoSf3OrDisabled"; + CorporationExists: "CorporationExists"; + UseSeedMoneyOutsideBN3: "UseSeedMoneyOutsideBN3"; + DisabledBySoftCap: "DisabledBySoftCap"; +}; +``` diff --git a/markdown/bitburner.crimeenumtype.md b/markdown/bitburner.crimeenumtype.md new file mode 100644 index 000000000..c45f61ca0 --- /dev/null +++ b/markdown/bitburner.crimeenumtype.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeEnumType](./bitburner.crimeenumtype.md) + +## CrimeEnumType type + + +**Signature:** + +```typescript +type CrimeEnumType = { + shoplift: "Shoplift"; + robStore: "Rob Store"; + mug: "Mug"; + larceny: "Larceny"; + dealDrugs: "Deal Drugs"; + bondForgery: "Bond Forgery"; + traffickArms: "Traffick Arms"; + homicide: "Homicide"; + grandTheftAuto: "Grand Theft Auto"; + kidnap: "Kidnap"; + assassination: "Assassination"; + heist: "Heist"; +}; +``` diff --git a/markdown/bitburner.crimetype.md b/markdown/bitburner.crimetype.md index ce311fc62..3fd73e93f 100644 --- a/markdown/bitburner.crimetype.md +++ b/markdown/bitburner.crimetype.md @@ -2,29 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [CrimeType](./bitburner.crimetype.md) -## CrimeType enum +## CrimeType type **Signature:** ```typescript -declare enum CrimeType +type CrimeType = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| assassination | "Assassination" | | -| bondForgery | "Bond Forgery" | | -| dealDrugs | "Deal Drugs" | | -| grandTheftAuto | "Grand Theft Auto" | | -| heist | "Heist" | | -| homicide | "Homicide" | | -| kidnap | "Kidnap" | | -| larceny | "Larceny" | | -| mug | "Mug" | | -| robStore | "Rob Store" | | -| shoplift | "Shoplift" | | -| traffickArms | "Traffick Arms" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [CrimeEnumType](./bitburner.crimeenumtype.md) diff --git a/markdown/bitburner.factionname.md b/markdown/bitburner.factionname.md index ce9dd245f..cdb613169 100644 --- a/markdown/bitburner.factionname.md +++ b/markdown/bitburner.factionname.md @@ -2,54 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [FactionName](./bitburner.factionname.md) -## FactionName enum +## FactionName type -Names of all factions. - -Warning: Spoiler ahead. This enum contains names of \*\*all\*\* factions. If you do not want to know what all the factions are, you should not check this enum. Some factions are only accessible in the endgame. **Signature:** ```typescript -declare enum FactionName +type FactionName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Aevum | "Aevum" | | -| BachmanAssociates | "Bachman & Associates" | | -| BitRunners | "BitRunners" | | -| Bladeburners | "Bladeburners" | | -| BladeIndustries | "Blade Industries" | | -| Chongqing | "Chongqing" | | -| ChurchOfTheMachineGod | "Church of the Machine God" | | -| ClarkeIncorporated | "Clarke Incorporated" | | -| CyberSec | "CyberSec" | | -| Daedalus | "Daedalus" | | -| ECorp | "ECorp" | | -| FourSigma | "Four Sigma" | | -| FulcrumSecretTechnologies | "Fulcrum Secret Technologies" | | -| Illuminati | "Illuminati" | | -| Ishima | "Ishima" | | -| KuaiGongInternational | "KuaiGong International" | | -| MegaCorp | "MegaCorp" | | -| Netburners | "Netburners" | | -| NewTokyo | "New Tokyo" | | -| NiteSec | "NiteSec" | | -| NWO | "NWO" | | -| OmniTekIncorporated | "OmniTek Incorporated" | | -| Sector12 | "Sector-12" | | -| ShadowsOfAnarchy | "Shadows of Anarchy" | | -| Silhouette | "Silhouette" | | -| SlumSnakes | "Slum Snakes" | | -| SpeakersForTheDead | "Speakers for the Dead" | | -| Tetrads | "Tetrads" | | -| TheBlackHand | "The Black Hand" | | -| TheCovenant | "The Covenant" | | -| TheDarkArmy | "The Dark Army" | | -| TheSyndicate | "The Syndicate" | | -| TianDiHui | "Tian Di Hui" | | -| Volhaven | "Volhaven" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [FactionNameEnumType](./bitburner.factionnameenumtype.md) diff --git a/markdown/bitburner.factionnameenumtype.md b/markdown/bitburner.factionnameenumtype.md new file mode 100644 index 000000000..0ec192e4a --- /dev/null +++ b/markdown/bitburner.factionnameenumtype.md @@ -0,0 +1,50 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [FactionNameEnumType](./bitburner.factionnameenumtype.md) + +## FactionNameEnumType type + +Names of all factions. + +Warning: Spoiler ahead. This enum contains names of \*\*all\*\* factions. If you do not want to know what all the factions are, you should not check this enum. Some factions are only accessible in the endgame. + +**Signature:** + +```typescript +type FactionNameEnumType = { + Illuminati: "Illuminati"; + Daedalus: "Daedalus"; + TheCovenant: "The Covenant"; + ECorp: "ECorp"; + MegaCorp: "MegaCorp"; + BachmanAssociates: "Bachman & Associates"; + BladeIndustries: "Blade Industries"; + NWO: "NWO"; + ClarkeIncorporated: "Clarke Incorporated"; + OmniTekIncorporated: "OmniTek Incorporated"; + FourSigma: "Four Sigma"; + KuaiGongInternational: "KuaiGong International"; + FulcrumSecretTechnologies: "Fulcrum Secret Technologies"; + BitRunners: "BitRunners"; + TheBlackHand: "The Black Hand"; + NiteSec: "NiteSec"; + Aevum: "Aevum"; + Chongqing: "Chongqing"; + Ishima: "Ishima"; + NewTokyo: "New Tokyo"; + Sector12: "Sector-12"; + Volhaven: "Volhaven"; + SpeakersForTheDead: "Speakers for the Dead"; + TheDarkArmy: "The Dark Army"; + TheSyndicate: "The Syndicate"; + Silhouette: "Silhouette"; + Tetrads: "Tetrads"; + SlumSnakes: "Slum Snakes"; + Netburners: "Netburners"; + TianDiHui: "Tian Di Hui"; + CyberSec: "CyberSec"; + Bladeburners: "Bladeburners"; + ChurchOfTheMachineGod: "Church of the Machine God"; + ShadowsOfAnarchy: "Shadows of Anarchy"; +}; +``` diff --git a/markdown/bitburner.factionworkenumtype.md b/markdown/bitburner.factionworkenumtype.md new file mode 100644 index 000000000..490732253 --- /dev/null +++ b/markdown/bitburner.factionworkenumtype.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [FactionWorkEnumType](./bitburner.factionworkenumtype.md) + +## FactionWorkEnumType type + + +**Signature:** + +```typescript +type FactionWorkEnumType = { + hacking: "hacking"; + field: "field"; + security: "security"; +}; +``` diff --git a/markdown/bitburner.factionworktype.md b/markdown/bitburner.factionworktype.md index b9c2d253b..6eb084483 100644 --- a/markdown/bitburner.factionworktype.md +++ b/markdown/bitburner.factionworktype.md @@ -2,20 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [FactionWorkType](./bitburner.factionworktype.md) -## FactionWorkType enum +## FactionWorkType type **Signature:** ```typescript -declare enum FactionWorkType +type FactionWorkType = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| field | "field" | | -| hacking | "hacking" | | -| security | "security" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [FactionWorkEnumType](./bitburner.factionworkenumtype.md) diff --git a/markdown/bitburner.gymenumtype.md b/markdown/bitburner.gymenumtype.md new file mode 100644 index 000000000..48925436a --- /dev/null +++ b/markdown/bitburner.gymenumtype.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GymEnumType](./bitburner.gymenumtype.md) + +## GymEnumType type + + +**Signature:** + +```typescript +type GymEnumType = { + strength: "str"; + defense: "def"; + dexterity: "dex"; + agility: "agi"; +}; +``` diff --git a/markdown/bitburner.gymlocationname.md b/markdown/bitburner.gymlocationname.md index ab3bf1097..9353e28a2 100644 --- a/markdown/bitburner.gymlocationname.md +++ b/markdown/bitburner.gymlocationname.md @@ -2,23 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [GymLocationName](./bitburner.gymlocationname.md) -## GymLocationName enum +## GymLocationName type -Locations of gym **Signature:** ```typescript -declare enum GymLocationName +type GymLocationName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| AevumCrushFitnessGym | LocationName.AevumCrushFitnessGym | | -| AevumSnapFitnessGym | LocationName.AevumSnapFitnessGym | | -| Sector12IronGym | LocationName.Sector12IronGym | | -| Sector12PowerhouseGym | LocationName.Sector12PowerhouseGym | | -| VolhavenMilleniumFitnessGym | LocationName.VolhavenMilleniumFitnessGym | | +**References:** [\_ValueOf](./bitburner._valueof.md), [GymLocationNameEnumType](./bitburner.gymlocationnameenumtype.md) diff --git a/markdown/bitburner.gymlocationnameenumtype.md b/markdown/bitburner.gymlocationnameenumtype.md new file mode 100644 index 000000000..19d7d884e --- /dev/null +++ b/markdown/bitburner.gymlocationnameenumtype.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GymLocationNameEnumType](./bitburner.gymlocationnameenumtype.md) + +## GymLocationNameEnumType type + +Locations of gym + +**Signature:** + +```typescript +type GymLocationNameEnumType = { + AevumCrushFitnessGym: LocationNameEnumType["AevumCrushFitnessGym"]; + AevumSnapFitnessGym: LocationNameEnumType["AevumSnapFitnessGym"]; + Sector12IronGym: LocationNameEnumType["Sector12IronGym"]; + Sector12PowerhouseGym: LocationNameEnumType["Sector12PowerhouseGym"]; + VolhavenMilleniumFitnessGym: LocationNameEnumType["VolhavenMilleniumFitnessGym"]; +}; +``` +**References:** [LocationNameEnumType](./bitburner.locationnameenumtype.md) + diff --git a/markdown/bitburner.gymtype.md b/markdown/bitburner.gymtype.md index 9ae1e45bf..e87cd2218 100644 --- a/markdown/bitburner.gymtype.md +++ b/markdown/bitburner.gymtype.md @@ -2,21 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [GymType](./bitburner.gymtype.md) -## GymType enum +## GymType type **Signature:** ```typescript -declare enum GymType +type GymType = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| agility | "agi" | | -| defense | "def" | | -| dexterity | "dex" | | -| strength | "str" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [GymEnumType](./bitburner.gymenumtype.md) diff --git a/markdown/bitburner.infiltration.getinfiltration.md b/markdown/bitburner.infiltration.getinfiltration.md index cfb19b535..04b00b03e 100644 --- a/markdown/bitburner.infiltration.getinfiltration.md +++ b/markdown/bitburner.infiltration.getinfiltration.md @@ -9,14 +9,14 @@ Get all infiltrations with difficulty, location and rewards. **Signature:** ```typescript -getInfiltration(location: LocationName | `${LocationName}`): InfiltrationLocation; +getInfiltration(location: LocationName): InfiltrationLocation; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| location | [LocationName](./bitburner.locationname.md) \| \`${[LocationName](./bitburner.locationname.md)}\` | | +| location | [LocationName](./bitburner.locationname.md) | | **Returns:** diff --git a/markdown/bitburner.jobfield.md b/markdown/bitburner.jobfield.md index eed49afd3..893e523b6 100644 --- a/markdown/bitburner.jobfield.md +++ b/markdown/bitburner.jobfield.md @@ -2,30 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [JobField](./bitburner.jobfield.md) -## JobField enum +## JobField type **Signature:** ```typescript -declare enum JobField +type JobField = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| agent | "Agent" | | -| business | "Business" | | -| businessConsultant | "Business Consultant" | | -| employee | "Employee" | | -| it | "IT" | | -| networkEngineer | "Network Engineer" | | -| partTimeEmployee | "Part-time Employee" | | -| partTimeWaiter | "Part-time Waiter" | | -| security | "Security" | | -| securityEngineer | "Security Engineer" | | -| software | "Software" | | -| softwareConsultant | "Software Consultant" | | -| waiter | "Waiter" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [JobFieldEnumType](./bitburner.jobfieldenumtype.md) diff --git a/markdown/bitburner.jobfieldenumtype.md b/markdown/bitburner.jobfieldenumtype.md new file mode 100644 index 000000000..b0dde4e4d --- /dev/null +++ b/markdown/bitburner.jobfieldenumtype.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [JobFieldEnumType](./bitburner.jobfieldenumtype.md) + +## JobFieldEnumType type + + +**Signature:** + +```typescript +type JobFieldEnumType = { + software: "Software"; + softwareConsultant: "Software Consultant"; + it: "IT"; + securityEngineer: "Security Engineer"; + networkEngineer: "Network Engineer"; + business: "Business"; + businessConsultant: "Business Consultant"; + security: "Security"; + agent: "Agent"; + employee: "Employee"; + partTimeEmployee: "Part-time Employee"; + waiter: "Waiter"; + partTimeWaiter: "Part-time Waiter"; +}; +``` diff --git a/markdown/bitburner.jobname.md b/markdown/bitburner.jobname.md index 0bb063a89..d4efb140a 100644 --- a/markdown/bitburner.jobname.md +++ b/markdown/bitburner.jobname.md @@ -2,53 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [JobName](./bitburner.jobname.md) -## JobName enum +## JobName type **Signature:** ```typescript -declare enum JobName +type JobName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| agent0 | "Field Agent" | | -| agent1 | "Secret Agent" | | -| agent2 | "Special Operative" | | -| business0 | "Business Intern" | | -| business1 | "Business Analyst" | | -| business2 | "Business Manager" | | -| business3 | "Operations Manager" | | -| business4 | "Chief Financial Officer" | | -| business5 | "Chief Executive Officer" | | -| businessConsult0 | "Business Consultant" | | -| businessConsult1 | "Senior Business Consultant" | | -| employee | "Employee" | | -| employeePT | "Part-time Employee" | | -| IT0 | "IT Intern" | | -| IT1 | "IT Analyst" | | -| IT2 | "IT Manager" | | -| IT3 | "Systems Administrator" | | -| networkEng0 | "Network Engineer" | | -| networkEng1 | "Network Administrator" | | -| security0 | "Security Guard" | | -| security1 | "Security Officer" | | -| security2 | "Security Supervisor" | | -| security3 | "Head of Security" | | -| securityEng | "Security Engineer" | | -| software0 | "Software Engineering Intern" | | -| software1 | "Junior Software Engineer" | | -| software2 | "Senior Software Engineer" | | -| software3 | "Lead Software Developer" | | -| software4 | "Head of Software" | | -| software5 | "Head of Engineering" | | -| software6 | "Vice President of Technology" | | -| software7 | "Chief Technology Officer" | | -| softwareConsult0 | "Software Consultant" | | -| softwareConsult1 | "Senior Software Consultant" | | -| waiter | "Waiter" | | -| waiterPT | "Part-time Waiter" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [JobNameEnumType](./bitburner.jobnameenumtype.md) diff --git a/markdown/bitburner.jobnameenumtype.md b/markdown/bitburner.jobnameenumtype.md new file mode 100644 index 000000000..3bc477ae5 --- /dev/null +++ b/markdown/bitburner.jobnameenumtype.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [JobNameEnumType](./bitburner.jobnameenumtype.md) + +## JobNameEnumType type + + +**Signature:** + +```typescript +type JobNameEnumType = { + software0: "Software Engineering Intern"; + software1: "Junior Software Engineer"; + software2: "Senior Software Engineer"; + software3: "Lead Software Developer"; + software4: "Head of Software"; + software5: "Head of Engineering"; + software6: "Vice President of Technology"; + software7: "Chief Technology Officer"; + IT0: "IT Intern"; + IT1: "IT Analyst"; + IT2: "IT Manager"; + IT3: "Systems Administrator"; + securityEng: "Security Engineer"; + networkEng0: "Network Engineer"; + networkEng1: "Network Administrator"; + business0: "Business Intern"; + business1: "Business Analyst"; + business2: "Business Manager"; + business3: "Operations Manager"; + business4: "Chief Financial Officer"; + business5: "Chief Executive Officer"; + security0: "Security Guard"; + security1: "Security Officer"; + security2: "Security Supervisor"; + security3: "Head of Security"; + agent0: "Field Agent"; + agent1: "Secret Agent"; + agent2: "Special Operative"; + waiter: "Waiter"; + employee: "Employee"; + softwareConsult0: "Software Consultant"; + softwareConsult1: "Senior Software Consultant"; + businessConsult0: "Business Consultant"; + businessConsult1: "Senior Business Consultant"; + waiterPT: "Part-time Waiter"; + employeePT: "Part-time Employee"; +}; +``` diff --git a/markdown/bitburner.locationname.md b/markdown/bitburner.locationname.md index 62f68d32e..f63a48d5d 100644 --- a/markdown/bitburner.locationname.md +++ b/markdown/bitburner.locationname.md @@ -2,74 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [LocationName](./bitburner.locationname.md) -## LocationName enum +## LocationName type -Names of all locations **Signature:** ```typescript -declare enum LocationName +type LocationName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| AevumAeroCorp | "AeroCorp" | | -| AevumBachmanAndAssociates | "Bachman & Associates" | | -| AevumCasino | "Iker Molina Casino" | | -| AevumClarkeIncorporated | "Clarke Incorporated" | | -| AevumCrushFitnessGym | "Crush Fitness Gym" | | -| AevumECorp | "ECorp" | | -| AevumFulcrumTechnologies | "Fulcrum Technologies" | | -| AevumGalacticCybersystems | "Galactic Cybersystems" | | -| AevumNetLinkTechnologies | "NetLink Technologies" | | -| AevumPolice | "Aevum Police Headquarters" | | -| AevumRhoConstruction | "Rho Construction" | | -| AevumSnapFitnessGym | "Snap Fitness Gym" | | -| AevumSummitUniversity | "Summit University" | | -| AevumWatchdogSecurity | "Watchdog Security" | | -| ChongqingChurchOfTheMachineGod | "Church of the Machine God" | | -| ChongqingKuaiGongInternational | "KuaiGong International" | | -| ChongqingSolarisSpaceSystems | "Solaris Space Systems" | | -| Hospital | "Hospital" | | -| IshimaGlitch | "0x6C1" | | -| IshimaNovaMedical | "Nova Medical" | | -| IshimaOmegaSoftware | "Omega Software" | | -| IshimaStormTechnologies | "Storm Technologies" | | -| NewTokyoArcade | "Arcade" | | -| NewTokyoDefComm | "DefComm" | | -| NewTokyoGlobalPharmaceuticals | "Global Pharmaceuticals" | | -| NewTokyoNoodleBar | "Noodle Bar" | | -| NewTokyoVitaLife | "VitaLife" | | -| Sector12AlphaEnterprises | "Alpha Enterprises" | | -| Sector12BladeIndustries | "Blade Industries" | | -| Sector12CarmichaelSecurity | "Carmichael Security" | | -| Sector12CIA | "Central Intelligence Agency" | | -| Sector12CityHall | "Sector-12 City Hall" | | -| Sector12DeltaOne | "DeltaOne" | | -| Sector12FoodNStuff | "FoodNStuff" | | -| Sector12FourSigma | "Four Sigma" | | -| Sector12IcarusMicrosystems | "Icarus Microsystems" | | -| Sector12IronGym | "Iron Gym" | | -| Sector12JoesGuns | "Joe's Guns" | | -| Sector12MegaCorp | "MegaCorp" | | -| Sector12NSA | "National Security Agency" | | -| Sector12PowerhouseGym | "Powerhouse Gym" | | -| Sector12RothmanUniversity | "Rothman University" | | -| Sector12UniversalEnergy | "Universal Energy" | | -| Slums | "The Slums" | | -| TravelAgency | "Travel Agency" | | -| Void | "The Void" | | -| VolhavenCompuTek | "CompuTek" | | -| VolhavenHeliosLabs | "Helios Labs" | | -| VolhavenLexoCorp | "LexoCorp" | | -| VolhavenMilleniumFitnessGym | "Millenium Fitness Gym" | | -| VolhavenNWO | "NWO" | | -| VolhavenOmniaCybersystems | "Omnia Cybersystems" | | -| VolhavenOmniTekIncorporated | "OmniTek Incorporated" | | -| VolhavenSysCoreSecurities | "SysCore Securities" | | -| VolhavenZBInstituteOfTechnology | "ZB Institute of Technology" | | -| WorldStockExchange | "World Stock Exchange" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [LocationNameEnumType](./bitburner.locationnameenumtype.md) diff --git a/markdown/bitburner.locationnameenumtype.md b/markdown/bitburner.locationnameenumtype.md new file mode 100644 index 000000000..b87e6fe43 --- /dev/null +++ b/markdown/bitburner.locationnameenumtype.md @@ -0,0 +1,77 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [LocationNameEnumType](./bitburner.locationnameenumtype.md) + +## LocationNameEnumType type + +Names of all locations + +**Signature:** + +```typescript +type LocationNameEnumType = { + AevumAeroCorp: "AeroCorp"; + AevumBachmanAndAssociates: "Bachman & Associates"; + AevumClarkeIncorporated: "Clarke Incorporated"; + AevumCrushFitnessGym: "Crush Fitness Gym"; + AevumECorp: "ECorp"; + AevumFulcrumTechnologies: "Fulcrum Technologies"; + AevumGalacticCybersystems: "Galactic Cybersystems"; + AevumNetLinkTechnologies: "NetLink Technologies"; + AevumPolice: "Aevum Police Headquarters"; + AevumRhoConstruction: "Rho Construction"; + AevumSnapFitnessGym: "Snap Fitness Gym"; + AevumSummitUniversity: "Summit University"; + AevumWatchdogSecurity: "Watchdog Security"; + AevumCasino: "Iker Molina Casino"; + + ChongqingKuaiGongInternational: "KuaiGong International"; + ChongqingSolarisSpaceSystems: "Solaris Space Systems"; + ChongqingChurchOfTheMachineGod: "Church of the Machine God"; + + Sector12AlphaEnterprises: "Alpha Enterprises"; + Sector12BladeIndustries: "Blade Industries"; + Sector12CIA: "Central Intelligence Agency"; + Sector12CarmichaelSecurity: "Carmichael Security"; + Sector12CityHall: "Sector-12 City Hall"; + Sector12DeltaOne: "DeltaOne"; + Sector12FoodNStuff: "FoodNStuff"; + Sector12FourSigma: "Four Sigma"; + Sector12IcarusMicrosystems: "Icarus Microsystems"; + Sector12IronGym: "Iron Gym"; + Sector12JoesGuns: "Joe's Guns"; + Sector12MegaCorp: "MegaCorp"; + Sector12NSA: "National Security Agency"; + Sector12PowerhouseGym: "Powerhouse Gym"; + Sector12RothmanUniversity: "Rothman University"; + Sector12UniversalEnergy: "Universal Energy"; + + NewTokyoDefComm: "DefComm"; + NewTokyoGlobalPharmaceuticals: "Global Pharmaceuticals"; + NewTokyoNoodleBar: "Noodle Bar"; + NewTokyoVitaLife: "VitaLife"; + NewTokyoArcade: "Arcade"; + + IshimaNovaMedical: "Nova Medical"; + IshimaOmegaSoftware: "Omega Software"; + IshimaStormTechnologies: "Storm Technologies"; + IshimaGlitch: "0x6C1"; + + VolhavenCompuTek: "CompuTek"; + VolhavenHeliosLabs: "Helios Labs"; + VolhavenLexoCorp: "LexoCorp"; + VolhavenMilleniumFitnessGym: "Millenium Fitness Gym"; + VolhavenNWO: "NWO"; + VolhavenOmniTekIncorporated: "OmniTek Incorporated"; + VolhavenOmniaCybersystems: "Omnia Cybersystems"; + VolhavenSysCoreSecurities: "SysCore Securities"; + VolhavenZBInstituteOfTechnology: "ZB Institute of Technology"; + + Hospital: "Hospital"; + Slums: "The Slums"; + TravelAgency: "Travel Agency"; + WorldStockExchange: "World Stock Exchange"; + + Void: "The Void"; +}; +``` diff --git a/markdown/bitburner.md b/markdown/bitburner.md index 26e72ea12..a680279df 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -4,35 +4,6 @@ ## bitburner package -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Action types of Bladeburner | -| [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) | Black Operation names of Bladeburner | -| [BladeburnerContractName](./bitburner.bladeburnercontractname.md) | Contract names of Bladeburner | -| [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md) | General action names of Bladeburner | -| [BladeburnerOperationName](./bitburner.bladeburneroperationname.md) | Operation names of Bladeburner | -| [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Skill names type of Bladeburner | -| [CityName](./bitburner.cityname.md) | Names of all cities | -| [CodingContractName](./bitburner.codingcontractname.md) | | -| [CompanyName](./bitburner.companyname.md) | Names of all companies | -| [CreatingCorporationCheckResult](./bitburner.creatingcorporationcheckresult.md) | | -| [CrimeType](./bitburner.crimetype.md) | | -| [FactionName](./bitburner.factionname.md) |

Names of all factions.

Warning: Spoiler ahead. This enum contains names of \*\*all\*\* factions. If you do not want to know what all the factions are, you should not check this enum. Some factions are only accessible in the endgame.

| -| [FactionWorkType](./bitburner.factionworktype.md) | | -| [GymLocationName](./bitburner.gymlocationname.md) | Locations of gym | -| [GymType](./bitburner.gymtype.md) | | -| [JobField](./bitburner.jobfield.md) | | -| [JobName](./bitburner.jobname.md) | | -| [LocationName](./bitburner.locationname.md) | Names of all locations | -| [OrderType](./bitburner.ordertype.md) | | -| [PositionType](./bitburner.positiontype.md) | | -| [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md) | These special Bladeburner action types are only for Sleeve | -| [ToastVariant](./bitburner.toastvariant.md) | | -| [UniversityClassType](./bitburner.universityclasstype.md) | | -| [UniversityLocationName](./bitburner.universitylocationname.md) | Locations of university | - ## Interfaces | Interface | Description | @@ -166,10 +137,29 @@ | Type Alias | Description | | --- | --- | +| [\_ValueOf](./bitburner._valueof.md) | | +| [BladeburnerActionEnumType](./bitburner.bladeburneractionenumtype.md) | Action types of Bladeburner | | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | | +| [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | | | [BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) | | +| [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) | | +| [BladeburnerBlackOpNameEnumType](./bitburner.bladeburnerblackopnameenumtype.md) | Black Operation names of Bladeburner | +| [BladeburnerContractName](./bitburner.bladeburnercontractname.md) | | +| [BladeburnerContractNameEnumType](./bitburner.bladeburnercontractnameenumtype.md) | Contract names of Bladeburner | +| [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md) | | +| [BladeburnerGeneralActionNameEnumType](./bitburner.bladeburnergeneralactionnameenumtype.md) | General action names of Bladeburner | +| [BladeburnerOperationName](./bitburner.bladeburneroperationname.md) | | +| [BladeburnerOperationNameEnumType](./bitburner.bladeburneroperationnameenumtype.md) | Operation names of Bladeburner | +| [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | | +| [BladeburnerSkillNameEnumType](./bitburner.bladeburnerskillnameenumtype.md) | Skill names type of Bladeburner | +| [CityName](./bitburner.cityname.md) | | +| [CityNameEnumType](./bitburner.citynameenumtype.md) | Names of all cities | +| [CodingContractName](./bitburner.codingcontractname.md) | | +| [CodingContractNameEnumType](./bitburner.codingcontractnameenumtype.md) | | | [CodingContractObject](./bitburner.codingcontractobject.md) | | | [CodingContractSignatures](./bitburner.codingcontractsignatures.md) | | +| [CompanyName](./bitburner.companyname.md) | | +| [CompanyNameEnumType](./bitburner.companynameenumtype.md) | Names of all companies | | [CorpEmployeePosition](./bitburner.corpemployeeposition.md) | | | [CorpIndustryName](./bitburner.corpindustryname.md) | | | [CorpMaterialName](./bitburner.corpmaterialname.md) | | @@ -178,10 +168,32 @@ | [CorpStateName](./bitburner.corpstatename.md) | | | [CorpUnlockName](./bitburner.corpunlockname.md) | | | [CorpUpgradeName](./bitburner.corpupgradename.md) | | +| [CreatingCorporationCheckResult](./bitburner.creatingcorporationcheckresult.md) | | +| [CreatingCorporationCheckResultEnumType](./bitburner.creatingcorporationcheckresultenumtype.md) | | +| [CrimeEnumType](./bitburner.crimeenumtype.md) | | +| [CrimeType](./bitburner.crimetype.md) | | +| [FactionName](./bitburner.factionname.md) | | +| [FactionNameEnumType](./bitburner.factionnameenumtype.md) |

Names of all factions.

Warning: Spoiler ahead. This enum contains names of \*\*all\*\* factions. If you do not want to know what all the factions are, you should not check this enum. Some factions are only accessible in the endgame.

| +| [FactionWorkEnumType](./bitburner.factionworkenumtype.md) | | +| [FactionWorkType](./bitburner.factionworktype.md) | | | [FilenameOrPID](./bitburner.filenameorpid.md) | | | [GoOpponent](./bitburner.goopponent.md) | | +| [GymEnumType](./bitburner.gymenumtype.md) | | +| [GymLocationName](./bitburner.gymlocationname.md) | | +| [GymLocationNameEnumType](./bitburner.gymlocationnameenumtype.md) | Locations of gym | +| [GymType](./bitburner.gymtype.md) | | +| [JobField](./bitburner.jobfield.md) | | +| [JobFieldEnumType](./bitburner.jobfieldenumtype.md) | | +| [JobName](./bitburner.jobname.md) | | +| [JobNameEnumType](./bitburner.jobnameenumtype.md) | | +| [LocationName](./bitburner.locationname.md) | | +| [LocationNameEnumType](./bitburner.locationnameenumtype.md) | Names of all locations | | [NSEnums](./bitburner.nsenums.md) | | +| [OrderEnumType](./bitburner.orderenumtype.md) | | +| [OrderType](./bitburner.ordertype.md) | | | [PlayerRequirement](./bitburner.playerrequirement.md) | Structured interface to requirements for joining a faction or company. For fields with numerical value > 0, the player must have at least this value. For fields with numerical value <= 0, the player must have at most this value. For "not", the sub-condition must be failed instead of passed. For "someCondition", at least one sub-condition must be passed. | +| [PositionEnumType](./bitburner.positionenumtype.md) | | +| [PositionType](./bitburner.positiontype.md) | | | [ReactNode](./bitburner.reactnode.md) |

A stand-in for the real React.ReactNode. A [ReactElement](./bitburner.reactelement.md) is rendered dynamically with React. number and string are displayed directly. boolean, null, and undefined are ignored and not rendered. An array of ReactNodes will display all members of that array sequentially.

Use React.createElement to make the ReactElement type, see [creating an element without jsx](https://react.dev/reference/react/createElement#creating-an-element-without-jsx) from the official React documentation.

| | [ScriptArg](./bitburner.scriptarg.md) | | | [SimpleOpponentStats](./bitburner.simpleopponentstats.md) | | @@ -195,5 +207,13 @@ | [SleeveSupportTask](./bitburner.sleevesupporttask.md) | | | [SleeveSynchroTask](./bitburner.sleevesynchrotask.md) | | | [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. | +| [SpecialBladeburnerActionEnumTypeForSleeve](./bitburner.specialbladeburneractionenumtypeforsleeve.md) | These special Bladeburner action types are only for Sleeve | +| [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md) | | | [Task](./bitburner.task.md) | Task | +| [ToastVariant](./bitburner.toastvariant.md) | | +| [ToastVariantEnumType](./bitburner.toastvariantenumtype.md) | | +| [UniversityClassEnumType](./bitburner.universityclassenumtype.md) | | +| [UniversityClassType](./bitburner.universityclasstype.md) | | +| [UniversityLocationName](./bitburner.universitylocationname.md) | | +| [UniversityLocationNameEnumType](./bitburner.universitylocationnameenumtype.md) | Locations of university | diff --git a/markdown/bitburner.ns.toast.md b/markdown/bitburner.ns.toast.md index 00a46e530..8c71b74f1 100644 --- a/markdown/bitburner.ns.toast.md +++ b/markdown/bitburner.ns.toast.md @@ -9,7 +9,7 @@ Queue a toast (bottom-right notification). **Signature:** ```typescript -toast(msg: string, variant?: ToastVariant | `${ToastVariant}`, duration?: number | null): void; +toast(msg: string, variant?: ToastVariant, duration?: number | null): void; ``` ## Parameters @@ -17,7 +17,7 @@ toast(msg: string, variant?: ToastVariant | `${ToastVariant}`, duration?: number | Parameter | Type | Description | | --- | --- | --- | | msg | string | Message in the toast. | -| variant | [ToastVariant](./bitburner.toastvariant.md) \| \`${[ToastVariant](./bitburner.toastvariant.md)}\` | _(Optional)_ Type of toast. Must be one of success, info, warning, error. Defaults to success. | +| variant | [ToastVariant](./bitburner.toastvariant.md) | _(Optional)_ Type of toast. Must be one of success, info, warning, error. Defaults to success. | | duration | number \| null | _(Optional)_ Duration of toast in ms. Can also be null to create a persistent toast. Defaults to 2000. | **Returns:** diff --git a/markdown/bitburner.nsenums.md b/markdown/bitburner.nsenums.md index ac00c528a..f59f79075 100644 --- a/markdown/bitburner.nsenums.md +++ b/markdown/bitburner.nsenums.md @@ -8,20 +8,20 @@ **Signature:** ```typescript -export type NSEnums = { - CityName: typeof CityName; - CrimeType: typeof CrimeType; - FactionWorkType: typeof FactionWorkType; - GymType: typeof GymType; - JobName: typeof JobName; - JobField: typeof JobField; - LocationName: typeof LocationName; - ToastVariant: typeof ToastVariant; - UniversityClassType: typeof UniversityClassType; - CompanyName: typeof CompanyName; - FactionName: typeof FactionName; - CodingContractName: typeof CodingContractName; +type NSEnums = { + CityName: CityNameEnumType; + CrimeType: CrimeEnumType; + FactionWorkType: FactionWorkEnumType; + GymType: GymEnumType; + JobName: JobNameEnumType; + JobField: JobFieldEnumType; + LocationName: LocationNameEnumType; + ToastVariant: ToastVariantEnumType; + UniversityClassType: UniversityClassEnumType; + CompanyName: CompanyNameEnumType; + FactionName: FactionNameEnumType; + CodingContractName: CodingContractNameEnumType; }; ``` -**References:** [CityName](./bitburner.cityname.md), [CrimeType](./bitburner.crimetype.md), [FactionWorkType](./bitburner.factionworktype.md), [GymType](./bitburner.gymtype.md), [JobName](./bitburner.jobname.md), [JobField](./bitburner.jobfield.md), [LocationName](./bitburner.locationname.md), [ToastVariant](./bitburner.toastvariant.md), [UniversityClassType](./bitburner.universityclasstype.md), [CompanyName](./bitburner.companyname.md), [FactionName](./bitburner.factionname.md), [CodingContractName](./bitburner.codingcontractname.md) +**References:** [CityNameEnumType](./bitburner.citynameenumtype.md), [CrimeEnumType](./bitburner.crimeenumtype.md), [FactionWorkEnumType](./bitburner.factionworkenumtype.md), [GymEnumType](./bitburner.gymenumtype.md), [JobNameEnumType](./bitburner.jobnameenumtype.md), [JobFieldEnumType](./bitburner.jobfieldenumtype.md), [LocationNameEnumType](./bitburner.locationnameenumtype.md), [ToastVariantEnumType](./bitburner.toastvariantenumtype.md), [UniversityClassEnumType](./bitburner.universityclassenumtype.md), [CompanyNameEnumType](./bitburner.companynameenumtype.md), [FactionNameEnumType](./bitburner.factionnameenumtype.md), [CodingContractNameEnumType](./bitburner.codingcontractnameenumtype.md) diff --git a/markdown/bitburner.officeapi.buytea.md b/markdown/bitburner.officeapi.buytea.md index 9d7675e0f..5f6304c46 100644 --- a/markdown/bitburner.officeapi.buytea.md +++ b/markdown/bitburner.officeapi.buytea.md @@ -9,7 +9,7 @@ Buy tea for your employees. **Signature:** ```typescript -buyTea(divisionName: string, city: CityName | `${CityName}`): boolean; +buyTea(divisionName: string, city: CityName): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ buyTea(divisionName: string, city: CityName | `${CityName}`): boolean; | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | **Returns:** diff --git a/markdown/bitburner.officeapi.getoffice.md b/markdown/bitburner.officeapi.getoffice.md index c5de5aa84..fc56eeaaa 100644 --- a/markdown/bitburner.officeapi.getoffice.md +++ b/markdown/bitburner.officeapi.getoffice.md @@ -9,7 +9,7 @@ Get data about an office. **Signature:** ```typescript -getOffice(divisionName: string, city: CityName | `${CityName}`): Office; +getOffice(divisionName: string, city: CityName): Office; ``` ## Parameters @@ -17,7 +17,7 @@ getOffice(divisionName: string, city: CityName | `${CityName}`): Office; | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | **Returns:** diff --git a/markdown/bitburner.officeapi.getofficesizeupgradecost.md b/markdown/bitburner.officeapi.getofficesizeupgradecost.md index b4123804a..074deff0b 100644 --- a/markdown/bitburner.officeapi.getofficesizeupgradecost.md +++ b/markdown/bitburner.officeapi.getofficesizeupgradecost.md @@ -9,7 +9,7 @@ Get the cost to upgrade an office. **Signature:** ```typescript -getOfficeSizeUpgradeCost(divisionName: string, city: CityName | `${CityName}`, size: number): number; +getOfficeSizeUpgradeCost(divisionName: string, city: CityName, size: number): number; ``` ## Parameters @@ -17,7 +17,7 @@ getOfficeSizeUpgradeCost(divisionName: string, city: CityName | `${CityName}`, s | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | size | number | Amount of positions to open | **Returns:** diff --git a/markdown/bitburner.officeapi.hireemployee.md b/markdown/bitburner.officeapi.hireemployee.md index 888f4ed98..6d10b69c0 100644 --- a/markdown/bitburner.officeapi.hireemployee.md +++ b/markdown/bitburner.officeapi.hireemployee.md @@ -9,7 +9,7 @@ Hire an employee. **Signature:** ```typescript -hireEmployee(divisionName: string, city: CityName | `${CityName}`, employeePosition?: CorpEmployeePosition): boolean; +hireEmployee(divisionName: string, city: CityName, employeePosition?: CorpEmployeePosition): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ hireEmployee(divisionName: string, city: CityName | `${CityName}`, employeePosit | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | employeePosition | [CorpEmployeePosition](./bitburner.corpemployeeposition.md) | _(Optional)_ Position to place into. Defaults to "Unassigned". | **Returns:** diff --git a/markdown/bitburner.officeapi.setautojobassignment.md b/markdown/bitburner.officeapi.setautojobassignment.md index 17ad7fa35..966287260 100644 --- a/markdown/bitburner.officeapi.setautojobassignment.md +++ b/markdown/bitburner.officeapi.setautojobassignment.md @@ -9,7 +9,7 @@ Set the job assignment for a job. **Signature:** ```typescript -setAutoJobAssignment(divisionName: string, city: CityName | `${CityName}`, job: string, amount: number): boolean; +setAutoJobAssignment(divisionName: string, city: CityName, job: string, amount: number): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ setAutoJobAssignment(divisionName: string, city: CityName | `${CityName}`, job: | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | job | string | Name of the job | | amount | number | Number of employees to assign to that job | diff --git a/markdown/bitburner.officeapi.throwparty.md b/markdown/bitburner.officeapi.throwparty.md index 6351d5093..32d7478e5 100644 --- a/markdown/bitburner.officeapi.throwparty.md +++ b/markdown/bitburner.officeapi.throwparty.md @@ -9,7 +9,7 @@ Throw a party for your employees. **Signature:** ```typescript -throwParty(divisionName: string, city: CityName | `${CityName}`, costPerEmployee: number): number; +throwParty(divisionName: string, city: CityName, costPerEmployee: number): number; ``` ## Parameters @@ -17,7 +17,7 @@ throwParty(divisionName: string, city: CityName | `${CityName}`, costPerEmployee | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | costPerEmployee | number | Amount to spend per employee. | **Returns:** diff --git a/markdown/bitburner.officeapi.upgradeofficesize.md b/markdown/bitburner.officeapi.upgradeofficesize.md index f621c9261..8ec0dce5d 100644 --- a/markdown/bitburner.officeapi.upgradeofficesize.md +++ b/markdown/bitburner.officeapi.upgradeofficesize.md @@ -9,7 +9,7 @@ Upgrade office size. **Signature:** ```typescript -upgradeOfficeSize(divisionName: string, city: CityName | `${CityName}`, size: number): void; +upgradeOfficeSize(divisionName: string, city: CityName, size: number): void; ``` ## Parameters @@ -17,7 +17,7 @@ upgradeOfficeSize(divisionName: string, city: CityName | `${CityName}`, size: nu | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | size | number | Amount of positions to open | **Returns:** diff --git a/markdown/bitburner.orderenumtype.md b/markdown/bitburner.orderenumtype.md new file mode 100644 index 000000000..257159db7 --- /dev/null +++ b/markdown/bitburner.orderenumtype.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OrderEnumType](./bitburner.orderenumtype.md) + +## OrderEnumType type + + +**Signature:** + +```typescript +type OrderEnumType = { + LimitBuy: "Limit Buy Order"; + LimitSell: "Limit Sell Order"; + StopBuy: "Stop Buy Order"; + StopSell: "Stop Sell Order"; +}; +``` diff --git a/markdown/bitburner.ordertype.md b/markdown/bitburner.ordertype.md index d15c4bc41..9b42c6b39 100644 --- a/markdown/bitburner.ordertype.md +++ b/markdown/bitburner.ordertype.md @@ -2,21 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [OrderType](./bitburner.ordertype.md) -## OrderType enum +## OrderType type **Signature:** ```typescript -declare enum OrderType +type OrderType = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| LimitBuy | "Limit Buy Order" | | -| LimitSell | "Limit Sell Order" | | -| StopBuy | "Stop Buy Order" | | -| StopSell | "Stop Sell Order" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [OrderEnumType](./bitburner.orderenumtype.md) diff --git a/markdown/bitburner.positionenumtype.md b/markdown/bitburner.positionenumtype.md new file mode 100644 index 000000000..2a5a19d0b --- /dev/null +++ b/markdown/bitburner.positionenumtype.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PositionEnumType](./bitburner.positionenumtype.md) + +## PositionEnumType type + + +**Signature:** + +```typescript +type PositionEnumType = { + Long: "L"; + Short: "S"; +}; +``` diff --git a/markdown/bitburner.positiontype.md b/markdown/bitburner.positiontype.md index 33d7c6f5b..c55c33a3f 100644 --- a/markdown/bitburner.positiontype.md +++ b/markdown/bitburner.positiontype.md @@ -2,19 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [PositionType](./bitburner.positiontype.md) -## PositionType enum +## PositionType type **Signature:** ```typescript -declare enum PositionType +type PositionType = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Long | "L" | | -| Short | "S" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [PositionEnumType](./bitburner.positionenumtype.md) diff --git a/markdown/bitburner.singularity.applytocompany.md b/markdown/bitburner.singularity.applytocompany.md index 85aeff1a0..9c8579d86 100644 --- a/markdown/bitburner.singularity.applytocompany.md +++ b/markdown/bitburner.singularity.applytocompany.md @@ -9,15 +9,15 @@ Apply for a job at a company. **Signature:** ```typescript -applyToCompany(companyName: CompanyName | `${CompanyName}`, field: JobField | `${JobField}`): JobName | null; +applyToCompany(companyName: CompanyName, field: JobField): JobName | null; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)}\` | Name of company to apply to. | -| field | [JobField](./bitburner.jobfield.md) \| \`${[JobField](./bitburner.jobfield.md)}\` | Field to which you want to apply. | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to apply to. | +| field | [JobField](./bitburner.jobfield.md) | Field to which you want to apply. | **Returns:** diff --git a/markdown/bitburner.singularity.commitcrime.md b/markdown/bitburner.singularity.commitcrime.md index f819e8ac5..abd5229ca 100644 --- a/markdown/bitburner.singularity.commitcrime.md +++ b/markdown/bitburner.singularity.commitcrime.md @@ -9,14 +9,14 @@ Commit a crime. **Signature:** ```typescript -commitCrime(crime: CrimeType | `${CrimeType}`, focus?: boolean): number; +commitCrime(crime: CrimeType, focus?: boolean): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| crime | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | Name of crime to attempt. | +| crime | [CrimeType](./bitburner.crimetype.md) | Name of crime to attempt. | | focus | boolean | _(Optional)_ Acquire player focus on this crime. Optional. Defaults to true. | **Returns:** diff --git a/markdown/bitburner.singularity.getcompanyfavor.md b/markdown/bitburner.singularity.getcompanyfavor.md index 4400e9458..fb2bdc400 100644 --- a/markdown/bitburner.singularity.getcompanyfavor.md +++ b/markdown/bitburner.singularity.getcompanyfavor.md @@ -9,14 +9,14 @@ Get company favor. **Signature:** ```typescript -getCompanyFavor(companyName: CompanyName | `${CompanyName}`): number; +getCompanyFavor(companyName: CompanyName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)}\` | Name of the company. | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | **Returns:** diff --git a/markdown/bitburner.singularity.getcompanyfavorgain.md b/markdown/bitburner.singularity.getcompanyfavorgain.md index 4170b860e..7e68d0e2f 100644 --- a/markdown/bitburner.singularity.getcompanyfavorgain.md +++ b/markdown/bitburner.singularity.getcompanyfavorgain.md @@ -9,14 +9,14 @@ Get company favor gain. **Signature:** ```typescript -getCompanyFavorGain(companyName: CompanyName | `${CompanyName}`): number; +getCompanyFavorGain(companyName: CompanyName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)}\` | Name of the company. | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | **Returns:** diff --git a/markdown/bitburner.singularity.getcompanypositioninfo.md b/markdown/bitburner.singularity.getcompanypositioninfo.md index d8f97ba90..2f3b40969 100644 --- a/markdown/bitburner.singularity.getcompanypositioninfo.md +++ b/markdown/bitburner.singularity.getcompanypositioninfo.md @@ -9,18 +9,15 @@ Get Requirements for Company Position. **Signature:** ```typescript -getCompanyPositionInfo( - companyName: CompanyName | `${CompanyName}`, - positionName: JobName | `${JobName}`, - ): CompanyPositionInfo; +getCompanyPositionInfo(companyName: CompanyName, positionName: JobName): CompanyPositionInfo; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)}\` | Name of company to get the requirements for. Must be an exact match. | -| positionName | [JobName](./bitburner.jobname.md) \| \`${[JobName](./bitburner.jobname.md)}\` | Name of position to get the requirements for. Must be an exact match. | +| companyName | [CompanyName](./bitburner.companyname.md) | 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:** diff --git a/markdown/bitburner.singularity.getcompanypositions.md b/markdown/bitburner.singularity.getcompanypositions.md index c1eff7fa5..3e75b7a1c 100644 --- a/markdown/bitburner.singularity.getcompanypositions.md +++ b/markdown/bitburner.singularity.getcompanypositions.md @@ -9,14 +9,14 @@ Get List of Company Positions. **Signature:** ```typescript -getCompanyPositions(companyName: CompanyName | `${CompanyName}`): JobName[]; +getCompanyPositions(companyName: CompanyName): JobName[]; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)}\` | Name of company to get the position list for. Must be an exact match. | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to get the position list for. Must be an exact match. | **Returns:** diff --git a/markdown/bitburner.singularity.getcompanyrep.md b/markdown/bitburner.singularity.getcompanyrep.md index 258ca3476..3953d0367 100644 --- a/markdown/bitburner.singularity.getcompanyrep.md +++ b/markdown/bitburner.singularity.getcompanyrep.md @@ -9,14 +9,14 @@ Get company reputation. **Signature:** ```typescript -getCompanyRep(companyName: CompanyName | `${CompanyName}`): number; +getCompanyRep(companyName: CompanyName): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)}\` | Name of the company. | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | **Returns:** diff --git a/markdown/bitburner.singularity.getcrimechance.md b/markdown/bitburner.singularity.getcrimechance.md index 11a0ccaea..202ec0d8b 100644 --- a/markdown/bitburner.singularity.getcrimechance.md +++ b/markdown/bitburner.singularity.getcrimechance.md @@ -9,14 +9,14 @@ Get chance to successfully commit a crime. **Signature:** ```typescript -getCrimeChance(crime: CrimeType | `${CrimeType}`): number; +getCrimeChance(crime: CrimeType): number; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| crime | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | Name of crime. | +| crime | [CrimeType](./bitburner.crimetype.md) | Name of crime. | **Returns:** diff --git a/markdown/bitburner.singularity.getcrimestats.md b/markdown/bitburner.singularity.getcrimestats.md index f034d673b..3d411b4f7 100644 --- a/markdown/bitburner.singularity.getcrimestats.md +++ b/markdown/bitburner.singularity.getcrimestats.md @@ -9,14 +9,14 @@ Get stats related to a crime. **Signature:** ```typescript -getCrimeStats(crime: CrimeType | `${CrimeType}`): CrimeStats; +getCrimeStats(crime: CrimeType): CrimeStats; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| crime | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | Name of crime. | +| crime | [CrimeType](./bitburner.crimetype.md) | Name of crime. | **Returns:** diff --git a/markdown/bitburner.singularity.gotolocation.md b/markdown/bitburner.singularity.gotolocation.md index 63617ce6f..913f6100b 100644 --- a/markdown/bitburner.singularity.gotolocation.md +++ b/markdown/bitburner.singularity.gotolocation.md @@ -9,14 +9,14 @@ Go to a location. **Signature:** ```typescript -goToLocation(locationName: LocationName | `${LocationName}`): boolean; +goToLocation(locationName: LocationName): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| locationName | [LocationName](./bitburner.locationname.md) \| \`${[LocationName](./bitburner.locationname.md)}\` | Name of the location. | +| locationName | [LocationName](./bitburner.locationname.md) | Name of the location. | **Returns:** diff --git a/markdown/bitburner.singularity.gymworkout.md b/markdown/bitburner.singularity.gymworkout.md index e2999a3c3..427e3dfb5 100644 --- a/markdown/bitburner.singularity.gymworkout.md +++ b/markdown/bitburner.singularity.gymworkout.md @@ -9,15 +9,15 @@ Workout at the gym. **Signature:** ```typescript -gymWorkout(gymName: GymLocationName | `${GymLocationName}`, stat: GymType | `${GymType}`, focus?: boolean): boolean; +gymWorkout(gymName: GymLocationName, stat: GymType, focus?: boolean): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| gymName | [GymLocationName](./bitburner.gymlocationname.md) \| \`${[GymLocationName](./bitburner.gymlocationname.md)}\` | Name of gym. You must be in the correct city for whatever gym you specify. | -| stat | [GymType](./bitburner.gymtype.md) \| \`${[GymType](./bitburner.gymtype.md)}\` | The stat you want to train. | +| gymName | [GymLocationName](./bitburner.gymlocationname.md) | Name of gym. You must be in the correct city for whatever gym you specify. | +| stat | [GymType](./bitburner.gymtype.md) | The stat you want to train. | | focus | boolean | _(Optional)_ Acquire player focus on this gym workout. Optional. Defaults to true. | **Returns:** diff --git a/markdown/bitburner.singularity.quitjob.md b/markdown/bitburner.singularity.quitjob.md index 7bf38ec19..74467bf09 100644 --- a/markdown/bitburner.singularity.quitjob.md +++ b/markdown/bitburner.singularity.quitjob.md @@ -9,14 +9,14 @@ Quit jobs by company. **Signature:** ```typescript -quitJob(companyName: CompanyName | `${CompanyName}`): void; +quitJob(companyName: CompanyName): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)}\` | Name of the company. | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | **Returns:** diff --git a/markdown/bitburner.singularity.traveltocity.md b/markdown/bitburner.singularity.traveltocity.md index 426222dd9..cb3da9080 100644 --- a/markdown/bitburner.singularity.traveltocity.md +++ b/markdown/bitburner.singularity.traveltocity.md @@ -9,14 +9,14 @@ Travel to another city. **Signature:** ```typescript -travelToCity(city: CityName | `${CityName}`): boolean; +travelToCity(city: CityName): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | City to travel to. | +| city | [CityName](./bitburner.cityname.md) | City to travel to. | **Returns:** diff --git a/markdown/bitburner.singularity.universitycourse.md b/markdown/bitburner.singularity.universitycourse.md index 38b63fe9d..b9019aa5d 100644 --- a/markdown/bitburner.singularity.universitycourse.md +++ b/markdown/bitburner.singularity.universitycourse.md @@ -9,19 +9,15 @@ Take university class. **Signature:** ```typescript -universityCourse( - universityName: UniversityLocationName | `${UniversityLocationName}`, - courseName: UniversityClassType | `${UniversityClassType}`, - focus?: boolean, - ): boolean; +universityCourse(universityName: UniversityLocationName, courseName: UniversityClassType, focus?: boolean): boolean; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| universityName | [UniversityLocationName](./bitburner.universitylocationname.md) \| \`${[UniversityLocationName](./bitburner.universitylocationname.md)}\` | Name of university. You must be in the correct city for whatever university you specify. | -| courseName | [UniversityClassType](./bitburner.universityclasstype.md) \| \`${[UniversityClassType](./bitburner.universityclasstype.md)}\` | Name of course. | +| universityName | [UniversityLocationName](./bitburner.universitylocationname.md) | Name of university. You must be in the correct city for whatever university you specify. | +| courseName | [UniversityClassType](./bitburner.universityclasstype.md) | Name of course. | | focus | boolean | _(Optional)_ Acquire player focus on this class. Optional. Defaults to true. | **Returns:** diff --git a/markdown/bitburner.singularity.workforfaction.md b/markdown/bitburner.singularity.workforfaction.md index d31622238..d46ca5beb 100644 --- a/markdown/bitburner.singularity.workforfaction.md +++ b/markdown/bitburner.singularity.workforfaction.md @@ -9,7 +9,7 @@ Work for a faction. **Signature:** ```typescript -workForFaction(faction: string, workType: FactionWorkType | `${FactionWorkType}`, focus?: boolean): boolean; +workForFaction(faction: string, workType: FactionWorkType, focus?: boolean): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ workForFaction(faction: string, workType: FactionWorkType | `${FactionWorkType}` | Parameter | Type | Description | | --- | --- | --- | | faction | string | Name of faction to work for. | -| workType | [FactionWorkType](./bitburner.factionworktype.md) \| \`${[FactionWorkType](./bitburner.factionworktype.md)}\` | Type of work to perform for the faction. | +| workType | [FactionWorkType](./bitburner.factionworktype.md) | Type of work to perform for the faction. | | focus | boolean | _(Optional)_ Acquire player focus on this work operation. Optional. Defaults to true. | **Returns:** diff --git a/markdown/bitburner.sleeve.settobladeburneraction.md b/markdown/bitburner.sleeve.settobladeburneraction.md index 7e7d52410..0debb28a8 100644 --- a/markdown/bitburner.sleeve.settobladeburneraction.md +++ b/markdown/bitburner.sleeve.settobladeburneraction.md @@ -11,7 +11,7 @@ Set a sleeve to perform Bladeburner actions. ```typescript setToBladeburnerAction( sleeveNumber: number, - action: BladeburnerActionTypeForSleeve | `${BladeburnerActionTypeForSleeve}`, + action: BladeburnerActionTypeForSleeve, contract?: BladeburnerContractName, ): boolean; ``` @@ -21,7 +21,7 @@ setToBladeburnerAction( | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to perform a Bladeburner action. | -| action | [BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) \| \`${[BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md)}\` | Name of the action to be performed. | +| action | [BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) | Name of the action to be performed. | | contract | [BladeburnerContractName](./bitburner.bladeburnercontractname.md) | _(Optional)_ Name of the contract if applicable. | **Returns:** diff --git a/markdown/bitburner.sleeve.settocommitcrime.md b/markdown/bitburner.sleeve.settocommitcrime.md index 1bd09b37c..fa15f40b9 100644 --- a/markdown/bitburner.sleeve.settocommitcrime.md +++ b/markdown/bitburner.sleeve.settocommitcrime.md @@ -9,7 +9,7 @@ Set a sleeve to commit crime. **Signature:** ```typescript -setToCommitCrime(sleeveNumber: number, crimeType: CrimeType | `${CrimeType}`): boolean; +setToCommitCrime(sleeveNumber: number, crimeType: CrimeType): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ setToCommitCrime(sleeveNumber: number, crimeType: CrimeType | `${CrimeType}`): b | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to start committing crime. Sleeves are numbered starting from 0. | -| crimeType | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | Name of the crime. | +| crimeType | [CrimeType](./bitburner.crimetype.md) | Name of the crime. | **Returns:** diff --git a/markdown/bitburner.sleeve.settocompanywork.md b/markdown/bitburner.sleeve.settocompanywork.md index aecd38c31..7961196d9 100644 --- a/markdown/bitburner.sleeve.settocompanywork.md +++ b/markdown/bitburner.sleeve.settocompanywork.md @@ -9,7 +9,7 @@ Set a sleeve to work for a company. **Signature:** ```typescript -setToCompanyWork(sleeveNumber: number, companyName: CompanyName | `${CompanyName}`): boolean; +setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ setToCompanyWork(sleeveNumber: number, companyName: CompanyName | `${CompanyName | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to work for the company. | -| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)}\` | Name of the company to work for. | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company to work for. | **Returns:** diff --git a/markdown/bitburner.sleeve.settofactionwork.md b/markdown/bitburner.sleeve.settofactionwork.md index 897c4f538..47f3f1d84 100644 --- a/markdown/bitburner.sleeve.settofactionwork.md +++ b/markdown/bitburner.sleeve.settofactionwork.md @@ -9,11 +9,7 @@ Set a sleeve to work for a faction. **Signature:** ```typescript -setToFactionWork( - sleeveNumber: number, - factionName: string, - factionWorkType: FactionWorkType | `${FactionWorkType}`, - ): boolean | undefined; +setToFactionWork(sleeveNumber: number, factionName: string, factionWorkType: FactionWorkType): boolean | undefined; ``` ## Parameters @@ -22,7 +18,7 @@ setToFactionWork( | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to work for the faction. | | factionName | string | Name of the faction to work for. | -| factionWorkType | [FactionWorkType](./bitburner.factionworktype.md) \| \`${[FactionWorkType](./bitburner.factionworktype.md)}\` | Name of the action to perform for this faction. | +| factionWorkType | [FactionWorkType](./bitburner.factionworktype.md) | Name of the action to perform for this faction. | **Returns:** diff --git a/markdown/bitburner.sleeve.settogymworkout.md b/markdown/bitburner.sleeve.settogymworkout.md index cd9859153..6e32d6eaa 100644 --- a/markdown/bitburner.sleeve.settogymworkout.md +++ b/markdown/bitburner.sleeve.settogymworkout.md @@ -9,11 +9,7 @@ Set a sleeve to workout at the gym. **Signature:** ```typescript -setToGymWorkout( - sleeveNumber: number, - gymName: GymLocationName | `${GymLocationName}`, - stat: GymType | `${GymType}`, - ): boolean; +setToGymWorkout(sleeveNumber: number, gymName: GymLocationName, stat: GymType): boolean; ``` ## Parameters @@ -21,8 +17,8 @@ setToGymWorkout( | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to workout at the gym. | -| gymName | [GymLocationName](./bitburner.gymlocationname.md) \| \`${[GymLocationName](./bitburner.gymlocationname.md)}\` | Name of the gym. | -| stat | [GymType](./bitburner.gymtype.md) \| \`${[GymType](./bitburner.gymtype.md)}\` | Name of the stat to train. | +| gymName | [GymLocationName](./bitburner.gymlocationname.md) | Name of the gym. | +| stat | [GymType](./bitburner.gymtype.md) | Name of the stat to train. | **Returns:** diff --git a/markdown/bitburner.sleeve.settouniversitycourse.md b/markdown/bitburner.sleeve.settouniversitycourse.md index 4a7e9bd61..60c7a4c1a 100644 --- a/markdown/bitburner.sleeve.settouniversitycourse.md +++ b/markdown/bitburner.sleeve.settouniversitycourse.md @@ -11,8 +11,8 @@ Set a sleeve to take a class at a university. ```typescript setToUniversityCourse( sleeveNumber: number, - universityName: UniversityLocationName | `${UniversityLocationName}`, - courseName: UniversityClassType | `${UniversityClassType}`, + universityName: UniversityLocationName, + courseName: UniversityClassType, ): boolean; ``` @@ -21,8 +21,8 @@ setToUniversityCourse( | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to start taking class. | -| universityName | [UniversityLocationName](./bitburner.universitylocationname.md) \| \`${[UniversityLocationName](./bitburner.universitylocationname.md)}\` | Name of the university to attend. | -| courseName | [UniversityClassType](./bitburner.universityclasstype.md) \| \`${[UniversityClassType](./bitburner.universityclasstype.md)}\` | Name of the course to follow. | +| universityName | [UniversityLocationName](./bitburner.universitylocationname.md) | Name of the university to attend. | +| courseName | [UniversityClassType](./bitburner.universityclasstype.md) | Name of the course to follow. | **Returns:** diff --git a/markdown/bitburner.sleeve.travel.md b/markdown/bitburner.sleeve.travel.md index ba7908bdf..ffba43753 100644 --- a/markdown/bitburner.sleeve.travel.md +++ b/markdown/bitburner.sleeve.travel.md @@ -9,7 +9,7 @@ Make a sleeve travel to another city. The cost for using this function is the sa **Signature:** ```typescript -travel(sleeveNumber: number, city: CityName | `${CityName}`): boolean; +travel(sleeveNumber: number, city: CityName): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ travel(sleeveNumber: number, city: CityName | `${CityName}`): boolean; | Parameter | Type | Description | | --- | --- | --- | | sleeveNumber | number | Index of the sleeve to travel. | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the destination city. | +| city | [CityName](./bitburner.cityname.md) | Name of the destination city. | **Returns:** diff --git a/markdown/bitburner.sleeveclasstask.md b/markdown/bitburner.sleeveclasstask.md index b39475abc..d0d47f5ed 100644 --- a/markdown/bitburner.sleeveclasstask.md +++ b/markdown/bitburner.sleeveclasstask.md @@ -10,8 +10,8 @@ ```typescript type SleeveClassTask = { type: "CLASS"; - classType: UniversityClassType | GymType | `${UniversityClassType}` | `${GymType}`; - location: LocationName | `${LocationName}`; + classType: UniversityClassType | GymType; + location: LocationName; }; ``` **References:** [UniversityClassType](./bitburner.universityclasstype.md), [GymType](./bitburner.gymtype.md), [LocationName](./bitburner.locationname.md) diff --git a/markdown/bitburner.sleevecrimetask.md b/markdown/bitburner.sleevecrimetask.md index 35fd4a093..dc39b67ce 100644 --- a/markdown/bitburner.sleevecrimetask.md +++ b/markdown/bitburner.sleevecrimetask.md @@ -10,7 +10,7 @@ ```typescript type SleeveCrimeTask = { type: "CRIME"; - crimeType: CrimeType | `${CrimeType}`; + crimeType: CrimeType; cyclesWorked: number; cyclesNeeded: number; tasksCompleted: number; diff --git a/markdown/bitburner.sleevefactiontask.md b/markdown/bitburner.sleevefactiontask.md index e24a57b1e..51b7cd364 100644 --- a/markdown/bitburner.sleevefactiontask.md +++ b/markdown/bitburner.sleevefactiontask.md @@ -10,7 +10,7 @@ ```typescript type SleeveFactionTask = { type: "FACTION"; - factionWorkType: FactionWorkType | `${FactionWorkType}`; + factionWorkType: FactionWorkType; factionName: string; }; ``` diff --git a/markdown/bitburner.specialbladeburneractionenumtypeforsleeve.md b/markdown/bitburner.specialbladeburneractionenumtypeforsleeve.md new file mode 100644 index 000000000..19d2742a6 --- /dev/null +++ b/markdown/bitburner.specialbladeburneractionenumtypeforsleeve.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SpecialBladeburnerActionEnumTypeForSleeve](./bitburner.specialbladeburneractionenumtypeforsleeve.md) + +## SpecialBladeburnerActionEnumTypeForSleeve type + +These special Bladeburner action types are only for Sleeve + +**Signature:** + +```typescript +type SpecialBladeburnerActionEnumTypeForSleeve = { + InfiltrateSynthoids: "Infiltrate Synthoids"; + SupportMainSleeve: "Support main sleeve"; + TakeOnContracts: "Take on contracts"; +}; +``` diff --git a/markdown/bitburner.specialbladeburneractiontypeforsleeve.md b/markdown/bitburner.specialbladeburneractiontypeforsleeve.md index ab5cc205d..dca7be35a 100644 --- a/markdown/bitburner.specialbladeburneractiontypeforsleeve.md +++ b/markdown/bitburner.specialbladeburneractiontypeforsleeve.md @@ -2,21 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md) -## SpecialBladeburnerActionTypeForSleeve enum +## SpecialBladeburnerActionTypeForSleeve type -These special Bladeburner action types are only for Sleeve **Signature:** ```typescript -declare enum SpecialBladeburnerActionTypeForSleeve +type SpecialBladeburnerActionTypeForSleeve = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| InfiltrateSynthoids | "Infiltrate Synthoids" | | -| SupportMainSleeve | "Support main sleeve" | | -| TakeOnContracts | "Take on contracts" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [SpecialBladeburnerActionEnumTypeForSleeve](./bitburner.specialbladeburneractionenumtypeforsleeve.md) diff --git a/markdown/bitburner.studytask.location.md b/markdown/bitburner.studytask.location.md index 6f474005d..5be11de9a 100644 --- a/markdown/bitburner.studytask.location.md +++ b/markdown/bitburner.studytask.location.md @@ -7,5 +7,5 @@ **Signature:** ```typescript -location: LocationName | `${LocationName}`; +location: LocationName; ``` diff --git a/markdown/bitburner.studytask.md b/markdown/bitburner.studytask.md index 86e077528..65ff9d12a 100644 --- a/markdown/bitburner.studytask.md +++ b/markdown/bitburner.studytask.md @@ -22,6 +22,6 @@ An object representing the current study task | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [classType](./bitburner.studytask.classtype.md) | | string | | -| [location](./bitburner.studytask.location.md) | | [LocationName](./bitburner.locationname.md) \| \`${[LocationName](./bitburner.locationname.md)}\` | | +| [location](./bitburner.studytask.location.md) | | [LocationName](./bitburner.locationname.md) | | | [type](./bitburner.studytask.type.md) | | "CLASS" | | diff --git a/markdown/bitburner.toastvariant.md b/markdown/bitburner.toastvariant.md index 1bcd5aed3..88deb960b 100644 --- a/markdown/bitburner.toastvariant.md +++ b/markdown/bitburner.toastvariant.md @@ -2,21 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [ToastVariant](./bitburner.toastvariant.md) -## ToastVariant enum +## ToastVariant type **Signature:** ```typescript -declare enum ToastVariant +type ToastVariant = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| ERROR | "error" | | -| INFO | "info" | | -| SUCCESS | "success" | | -| WARNING | "warning" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [ToastVariantEnumType](./bitburner.toastvariantenumtype.md) diff --git a/markdown/bitburner.toastvariantenumtype.md b/markdown/bitburner.toastvariantenumtype.md new file mode 100644 index 000000000..0bc387920 --- /dev/null +++ b/markdown/bitburner.toastvariantenumtype.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ToastVariantEnumType](./bitburner.toastvariantenumtype.md) + +## ToastVariantEnumType type + + +**Signature:** + +```typescript +type ToastVariantEnumType = { + SUCCESS: "success"; + WARNING: "warning"; + ERROR: "error"; + INFO: "info"; +}; +``` diff --git a/markdown/bitburner.universityclassenumtype.md b/markdown/bitburner.universityclassenumtype.md new file mode 100644 index 000000000..217f12085 --- /dev/null +++ b/markdown/bitburner.universityclassenumtype.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UniversityClassEnumType](./bitburner.universityclassenumtype.md) + +## UniversityClassEnumType type + + +**Signature:** + +```typescript +type UniversityClassEnumType = { + computerScience: "Computer Science"; + dataStructures: "Data Structures"; + networks: "Networks"; + algorithms: "Algorithms"; + management: "Management"; + leadership: "Leadership"; +}; +``` diff --git a/markdown/bitburner.universityclasstype.md b/markdown/bitburner.universityclasstype.md index 61157181e..0c7ce3c60 100644 --- a/markdown/bitburner.universityclasstype.md +++ b/markdown/bitburner.universityclasstype.md @@ -2,23 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [UniversityClassType](./bitburner.universityclasstype.md) -## UniversityClassType enum +## UniversityClassType type **Signature:** ```typescript -declare enum UniversityClassType +type UniversityClassType = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| algorithms | "Algorithms" | | -| computerScience | "Computer Science" | | -| dataStructures | "Data Structures" | | -| leadership | "Leadership" | | -| management | "Management" | | -| networks | "Networks" | | +**References:** [\_ValueOf](./bitburner._valueof.md), [UniversityClassEnumType](./bitburner.universityclassenumtype.md) diff --git a/markdown/bitburner.universitylocationname.md b/markdown/bitburner.universitylocationname.md index 1d57cab3f..de36ba6e3 100644 --- a/markdown/bitburner.universitylocationname.md +++ b/markdown/bitburner.universitylocationname.md @@ -2,21 +2,13 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [UniversityLocationName](./bitburner.universitylocationname.md) -## UniversityLocationName enum +## UniversityLocationName type -Locations of university **Signature:** ```typescript -declare enum UniversityLocationName +type UniversityLocationName = _ValueOf; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| AevumSummitUniversity | LocationName.AevumSummitUniversity | | -| Sector12RothmanUniversity | LocationName.Sector12RothmanUniversity | | -| VolhavenZBInstituteOfTechnology | LocationName.VolhavenZBInstituteOfTechnology | | +**References:** [\_ValueOf](./bitburner._valueof.md), [UniversityLocationNameEnumType](./bitburner.universitylocationnameenumtype.md) diff --git a/markdown/bitburner.universitylocationnameenumtype.md b/markdown/bitburner.universitylocationnameenumtype.md new file mode 100644 index 000000000..9e85bfea5 --- /dev/null +++ b/markdown/bitburner.universitylocationnameenumtype.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UniversityLocationNameEnumType](./bitburner.universitylocationnameenumtype.md) + +## UniversityLocationNameEnumType type + +Locations of university + +**Signature:** + +```typescript +type UniversityLocationNameEnumType = { + AevumSummitUniversity: LocationNameEnumType["AevumSummitUniversity"]; + Sector12RothmanUniversity: LocationNameEnumType["Sector12RothmanUniversity"]; + VolhavenZBInstituteOfTechnology: LocationNameEnumType["VolhavenZBInstituteOfTechnology"]; +}; +``` +**References:** [LocationNameEnumType](./bitburner.locationnameenumtype.md) + diff --git a/markdown/bitburner.warehouseapi.bulkpurchase.md b/markdown/bitburner.warehouseapi.bulkpurchase.md index 51a00e20a..7bc84355b 100644 --- a/markdown/bitburner.warehouseapi.bulkpurchase.md +++ b/markdown/bitburner.warehouseapi.bulkpurchase.md @@ -9,7 +9,7 @@ Set material to bulk-buy. **Signature:** ```typescript -bulkPurchase(divisionName: string, city: CityName | `${CityName}`, materialName: string, amt: number): void; +bulkPurchase(divisionName: string, city: CityName, materialName: string, amt: number): void; ``` ## Parameters @@ -17,7 +17,7 @@ bulkPurchase(divisionName: string, city: CityName | `${CityName}`, materialName: | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | materialName | string | Name of the material | | amt | number | Amount of material to buy | diff --git a/markdown/bitburner.warehouseapi.buymaterial.md b/markdown/bitburner.warehouseapi.buymaterial.md index aee9d1b1c..df4b98df4 100644 --- a/markdown/bitburner.warehouseapi.buymaterial.md +++ b/markdown/bitburner.warehouseapi.buymaterial.md @@ -9,7 +9,7 @@ Set material buy data. **Signature:** ```typescript -buyMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: string, amt: number): void; +buyMaterial(divisionName: string, city: CityName, materialName: string, amt: number): void; ``` ## Parameters @@ -17,7 +17,7 @@ buyMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | materialName | string | Name of the material | | amt | number | Amount of material to buy | diff --git a/markdown/bitburner.warehouseapi.cancelexportmaterial.md b/markdown/bitburner.warehouseapi.cancelexportmaterial.md index a51ace696..ec85d419a 100644 --- a/markdown/bitburner.warehouseapi.cancelexportmaterial.md +++ b/markdown/bitburner.warehouseapi.cancelexportmaterial.md @@ -11,9 +11,9 @@ Cancel material export. ```typescript cancelExportMaterial( sourceDivision: string, - sourceCity: CityName | `${CityName}`, + sourceCity: CityName, targetDivision: string, - targetCity: CityName | `${CityName}`, + targetCity: CityName, materialName: string, ): void; ``` @@ -23,9 +23,9 @@ cancelExportMaterial( | Parameter | Type | Description | | --- | --- | --- | | sourceDivision | string | Source division | -| sourceCity | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Source city | +| sourceCity | [CityName](./bitburner.cityname.md) | Source city | | targetDivision | string | Target division | -| targetCity | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Target city | +| targetCity | [CityName](./bitburner.cityname.md) | Target city | | materialName | string | Name of the material | **Returns:** diff --git a/markdown/bitburner.warehouseapi.exportmaterial.md b/markdown/bitburner.warehouseapi.exportmaterial.md index 7be196587..c4f183af0 100644 --- a/markdown/bitburner.warehouseapi.exportmaterial.md +++ b/markdown/bitburner.warehouseapi.exportmaterial.md @@ -11,9 +11,9 @@ Set material export data. ```typescript exportMaterial( sourceDivision: string, - sourceCity: CityName | `${CityName}`, + sourceCity: CityName, targetDivision: string, - targetCity: CityName | `${CityName}`, + targetCity: CityName, materialName: string, amt: number | string, ): void; @@ -24,9 +24,9 @@ exportMaterial( | Parameter | Type | Description | | --- | --- | --- | | sourceDivision | string | Source division | -| sourceCity | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Source city | +| sourceCity | [CityName](./bitburner.cityname.md) | Source city | | targetDivision | string | Target division | -| targetCity | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Target city | +| targetCity | [CityName](./bitburner.cityname.md) | Target city | | materialName | string | Name of the material | | amt | number \| string | Amount of material to export. | diff --git a/markdown/bitburner.warehouseapi.getmaterial.md b/markdown/bitburner.warehouseapi.getmaterial.md index 628a3eb30..bcc685c8f 100644 --- a/markdown/bitburner.warehouseapi.getmaterial.md +++ b/markdown/bitburner.warehouseapi.getmaterial.md @@ -9,7 +9,7 @@ Get material data. **Signature:** ```typescript -getMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: string): Material; +getMaterial(divisionName: string, city: CityName, materialName: string): Material; ``` ## Parameters @@ -17,7 +17,7 @@ getMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | materialName | string | Name of the material | **Returns:** diff --git a/markdown/bitburner.warehouseapi.getproduct.md b/markdown/bitburner.warehouseapi.getproduct.md index b51e4ea3f..8d78a4bce 100644 --- a/markdown/bitburner.warehouseapi.getproduct.md +++ b/markdown/bitburner.warehouseapi.getproduct.md @@ -9,7 +9,7 @@ Get product data. **Signature:** ```typescript -getProduct(divisionName: string, cityName: CityName | `${CityName}`, productName: string): Product; +getProduct(divisionName: string, cityName: CityName, productName: string): Product; ``` ## Parameters @@ -17,7 +17,7 @@ getProduct(divisionName: string, cityName: CityName | `${CityName}`, productName | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| cityName | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| cityName | [CityName](./bitburner.cityname.md) | Name of the city | | productName | string | Name of the product | **Returns:** diff --git a/markdown/bitburner.warehouseapi.getupgradewarehousecost.md b/markdown/bitburner.warehouseapi.getupgradewarehousecost.md index b1629d989..9f95f025e 100644 --- a/markdown/bitburner.warehouseapi.getupgradewarehousecost.md +++ b/markdown/bitburner.warehouseapi.getupgradewarehousecost.md @@ -9,7 +9,7 @@ Get the cost to upgrade a warehouse to the next level. **Signature:** ```typescript -getUpgradeWarehouseCost(divisionName: string, city: CityName | `${CityName}`, amt?: number): number; +getUpgradeWarehouseCost(divisionName: string, city: CityName, amt?: number): number; ``` ## Parameters @@ -17,7 +17,7 @@ getUpgradeWarehouseCost(divisionName: string, city: CityName | `${CityName}`, am | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | amt | number | _(Optional)_ Amount of upgrades. Optional. Defaults to 1. | **Returns:** diff --git a/markdown/bitburner.warehouseapi.getwarehouse.md b/markdown/bitburner.warehouseapi.getwarehouse.md index 2845e8f46..a976361ab 100644 --- a/markdown/bitburner.warehouseapi.getwarehouse.md +++ b/markdown/bitburner.warehouseapi.getwarehouse.md @@ -9,7 +9,7 @@ Get warehouse data. **Signature:** ```typescript -getWarehouse(divisionName: string, city: CityName | `${CityName}`): Warehouse; +getWarehouse(divisionName: string, city: CityName): Warehouse; ``` ## Parameters @@ -17,7 +17,7 @@ getWarehouse(divisionName: string, city: CityName | `${CityName}`): Warehouse; | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | **Returns:** diff --git a/markdown/bitburner.warehouseapi.haswarehouse.md b/markdown/bitburner.warehouseapi.haswarehouse.md index 5cc6827b2..29f1b5db6 100644 --- a/markdown/bitburner.warehouseapi.haswarehouse.md +++ b/markdown/bitburner.warehouseapi.haswarehouse.md @@ -9,7 +9,7 @@ Check if you have a warehouse in city. **Signature:** ```typescript -hasWarehouse(divisionName: string, city: CityName | `${CityName}`): boolean; +hasWarehouse(divisionName: string, city: CityName): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ hasWarehouse(divisionName: string, city: CityName | `${CityName}`): boolean; | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | | +| city | [CityName](./bitburner.cityname.md) | | **Returns:** diff --git a/markdown/bitburner.warehouseapi.limitmaterialproduction.md b/markdown/bitburner.warehouseapi.limitmaterialproduction.md index bf8011508..ac0476b4c 100644 --- a/markdown/bitburner.warehouseapi.limitmaterialproduction.md +++ b/markdown/bitburner.warehouseapi.limitmaterialproduction.md @@ -9,12 +9,7 @@ Limit material production. **Signature:** ```typescript -limitMaterialProduction( - divisionName: string, - city: CityName | `${CityName}`, - materialName: string, - qty: number, - ): void; +limitMaterialProduction(divisionName: string, city: CityName, materialName: string, qty: number): void; ``` ## Parameters @@ -22,7 +17,7 @@ limitMaterialProduction( | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division. | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city. | +| city | [CityName](./bitburner.cityname.md) | Name of the city. | | materialName | string | Name of the material. | | qty | number | Amount to limit to. Pass a negative value to remove the limit instead. | diff --git a/markdown/bitburner.warehouseapi.limitproductproduction.md b/markdown/bitburner.warehouseapi.limitproductproduction.md index 371fdbca2..75d2d5fa7 100644 --- a/markdown/bitburner.warehouseapi.limitproductproduction.md +++ b/markdown/bitburner.warehouseapi.limitproductproduction.md @@ -9,7 +9,7 @@ Limit product production. **Signature:** ```typescript -limitProductProduction(divisionName: string, city: CityName | `${CityName}`, productName: string, qty: number): void; +limitProductProduction(divisionName: string, city: CityName, productName: string, qty: number): void; ``` ## Parameters @@ -17,7 +17,7 @@ limitProductProduction(divisionName: string, city: CityName | `${CityName}`, pro | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division. | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city. | +| city | [CityName](./bitburner.cityname.md) | Name of the city. | | productName | string | Name of the product. | | qty | number | Amount to limit to. Pass a negative value to remove the limit instead. | diff --git a/markdown/bitburner.warehouseapi.makeproduct.md b/markdown/bitburner.warehouseapi.makeproduct.md index ed2b64ce0..b8ed5c2c6 100644 --- a/markdown/bitburner.warehouseapi.makeproduct.md +++ b/markdown/bitburner.warehouseapi.makeproduct.md @@ -11,7 +11,7 @@ Create a new product. ```typescript makeProduct( divisionName: string, - city: CityName | `${CityName}`, + city: CityName, productName: string, designInvest: number, marketingInvest: number, @@ -23,7 +23,7 @@ makeProduct( | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | productName | string | Name of the product | | designInvest | number | Amount to invest for the design of the product. | | marketingInvest | number | Amount to invest for the marketing of the product. | diff --git a/markdown/bitburner.warehouseapi.purchasewarehouse.md b/markdown/bitburner.warehouseapi.purchasewarehouse.md index 06cf4bc69..57dbea450 100644 --- a/markdown/bitburner.warehouseapi.purchasewarehouse.md +++ b/markdown/bitburner.warehouseapi.purchasewarehouse.md @@ -9,7 +9,7 @@ Purchase warehouse for a new city. **Signature:** ```typescript -purchaseWarehouse(divisionName: string, city: CityName | `${CityName}`): void; +purchaseWarehouse(divisionName: string, city: CityName): void; ``` ## Parameters @@ -17,7 +17,7 @@ purchaseWarehouse(divisionName: string, city: CityName | `${CityName}`): void; | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | **Returns:** diff --git a/markdown/bitburner.warehouseapi.sellmaterial.md b/markdown/bitburner.warehouseapi.sellmaterial.md index 4cf2d3119..aa9440d63 100644 --- a/markdown/bitburner.warehouseapi.sellmaterial.md +++ b/markdown/bitburner.warehouseapi.sellmaterial.md @@ -9,13 +9,7 @@ Set material sell data. **Signature:** ```typescript -sellMaterial( - divisionName: string, - city: CityName | `${CityName}`, - materialName: string, - amt: string, - price: string, - ): void; +sellMaterial(divisionName: string, city: CityName, materialName: string, amt: string, price: string): void; ``` ## Parameters @@ -23,7 +17,7 @@ sellMaterial( | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | materialName | string | Name of the material | | amt | string | Amount to sell, can be "MAX" | | price | string | Price to sell, can be "MP" | diff --git a/markdown/bitburner.warehouseapi.sellproduct.md b/markdown/bitburner.warehouseapi.sellproduct.md index 48feb8389..7c5cbccdd 100644 --- a/markdown/bitburner.warehouseapi.sellproduct.md +++ b/markdown/bitburner.warehouseapi.sellproduct.md @@ -11,7 +11,7 @@ Set product sell data. ```typescript sellProduct( divisionName: string, - city: CityName | `${CityName}`, + city: CityName, productName: string, amt: string, price: string, @@ -24,7 +24,7 @@ sellProduct( | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | productName | string | Name of the product | | amt | string | Amount to sell, can be "MAX" | | price | string | Price to sell, can be "MP" | diff --git a/markdown/bitburner.warehouseapi.setmaterialmarketta1.md b/markdown/bitburner.warehouseapi.setmaterialmarketta1.md index dad1e3e18..e9ba44500 100644 --- a/markdown/bitburner.warehouseapi.setmaterialmarketta1.md +++ b/markdown/bitburner.warehouseapi.setmaterialmarketta1.md @@ -9,7 +9,7 @@ Set Market-TA1 for a material. **Signature:** ```typescript -setMaterialMarketTA1(divisionName: string, city: CityName | `${CityName}`, materialName: string, on: boolean): void; +setMaterialMarketTA1(divisionName: string, city: CityName, materialName: string, on: boolean): void; ``` ## Parameters @@ -17,7 +17,7 @@ setMaterialMarketTA1(divisionName: string, city: CityName | `${CityName}`, mater | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | materialName | string | Name of the material | | on | boolean | Use true to enable, false otherwise. | diff --git a/markdown/bitburner.warehouseapi.setmaterialmarketta2.md b/markdown/bitburner.warehouseapi.setmaterialmarketta2.md index 1ed12f380..b1cbaaf13 100644 --- a/markdown/bitburner.warehouseapi.setmaterialmarketta2.md +++ b/markdown/bitburner.warehouseapi.setmaterialmarketta2.md @@ -9,7 +9,7 @@ Set Market-TA2 for a material. **Signature:** ```typescript -setMaterialMarketTA2(divisionName: string, city: CityName | `${CityName}`, materialName: string, on: boolean): void; +setMaterialMarketTA2(divisionName: string, city: CityName, materialName: string, on: boolean): void; ``` ## Parameters @@ -17,7 +17,7 @@ setMaterialMarketTA2(divisionName: string, city: CityName | `${CityName}`, mater | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | materialName | string | Name of the material | | on | boolean | Use true to enable, false otherwise. | diff --git a/markdown/bitburner.warehouseapi.setsmartsupply.md b/markdown/bitburner.warehouseapi.setsmartsupply.md index 763e77b16..f6095221c 100644 --- a/markdown/bitburner.warehouseapi.setsmartsupply.md +++ b/markdown/bitburner.warehouseapi.setsmartsupply.md @@ -9,7 +9,7 @@ Set smart supply. **Signature:** ```typescript -setSmartSupply(divisionName: string, city: CityName | `${CityName}`, enabled: boolean): void; +setSmartSupply(divisionName: string, city: CityName, enabled: boolean): void; ``` ## Parameters @@ -17,7 +17,7 @@ setSmartSupply(divisionName: string, city: CityName | `${CityName}`, enabled: bo | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | enabled | boolean | Use true to enable, false otherwise. | **Returns:** diff --git a/markdown/bitburner.warehouseapi.setsmartsupplyoption.md b/markdown/bitburner.warehouseapi.setsmartsupplyoption.md index 5873e4ad1..3cd6e0e21 100644 --- a/markdown/bitburner.warehouseapi.setsmartsupplyoption.md +++ b/markdown/bitburner.warehouseapi.setsmartsupplyoption.md @@ -9,12 +9,7 @@ Set whether smart supply uses leftovers before buying. **Signature:** ```typescript -setSmartSupplyOption( - divisionName: string, - city: CityName | `${CityName}`, - materialName: string, - option: CorpSmartSupplyOption, - ): void; +setSmartSupplyOption(divisionName: string, city: CityName, materialName: string, option: CorpSmartSupplyOption): void; ``` ## Parameters @@ -22,7 +17,7 @@ setSmartSupplyOption( | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | materialName | string | Name of the material | | option | [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md) | Smart supply option. Set "leftovers" to use leftovers, "imports" to use only imported materials, and "none" to not use stored materials. | diff --git a/markdown/bitburner.warehouseapi.upgradewarehouse.md b/markdown/bitburner.warehouseapi.upgradewarehouse.md index 1a755b96e..0584dd22e 100644 --- a/markdown/bitburner.warehouseapi.upgradewarehouse.md +++ b/markdown/bitburner.warehouseapi.upgradewarehouse.md @@ -9,7 +9,7 @@ Upgrade warehouse. **Signature:** ```typescript -upgradeWarehouse(divisionName: string, city: CityName | `${CityName}`, amt?: number): void; +upgradeWarehouse(divisionName: string, city: CityName, amt?: number): void; ``` ## Parameters @@ -17,7 +17,7 @@ upgradeWarehouse(divisionName: string, city: CityName | `${CityName}`, amt?: num | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | +| city | [CityName](./bitburner.cityname.md) | Name of the city | | amt | number | _(Optional)_ Amount of upgrades. Defaults to 1. | **Returns:** diff --git a/markdown/bitburner.workformulas.companygains.md b/markdown/bitburner.workformulas.companygains.md index bea25095a..3dca1bd06 100644 --- a/markdown/bitburner.workformulas.companygains.md +++ b/markdown/bitburner.workformulas.companygains.md @@ -7,12 +7,7 @@ **Signature:** ```typescript -companyGains( - person: Person, - companyName: CompanyName | `${CompanyName}`, - workType: JobName | `${JobName}`, - favor: number, - ): WorkStats; +companyGains(person: Person, companyName: CompanyName, workType: JobName, favor: number): WorkStats; ``` ## Parameters @@ -20,8 +15,8 @@ companyGains( | Parameter | Type | Description | | --- | --- | --- | | person | [Person](./bitburner.person.md) | | -| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)}\` | | -| workType | [JobName](./bitburner.jobname.md) \| \`${[JobName](./bitburner.jobname.md)}\` | | +| companyName | [CompanyName](./bitburner.companyname.md) | | +| workType | [JobName](./bitburner.jobname.md) | | | favor | number | | **Returns:** diff --git a/markdown/bitburner.workformulas.crimegains.md b/markdown/bitburner.workformulas.crimegains.md index a4e04273f..2d0e4ad62 100644 --- a/markdown/bitburner.workformulas.crimegains.md +++ b/markdown/bitburner.workformulas.crimegains.md @@ -7,7 +7,7 @@ **Signature:** ```typescript -crimeGains(person: Person, crimeType: CrimeType | `${CrimeType}`): WorkStats; +crimeGains(person: Person, crimeType: CrimeType): WorkStats; ``` ## Parameters @@ -15,7 +15,7 @@ crimeGains(person: Person, crimeType: CrimeType | `${CrimeType}`): WorkStats; | Parameter | Type | Description | | --- | --- | --- | | person | [Person](./bitburner.person.md) | | -| crimeType | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | | +| crimeType | [CrimeType](./bitburner.crimetype.md) | | **Returns:** diff --git a/markdown/bitburner.workformulas.crimesuccesschance.md b/markdown/bitburner.workformulas.crimesuccesschance.md index 26fb441ed..f77f5d254 100644 --- a/markdown/bitburner.workformulas.crimesuccesschance.md +++ b/markdown/bitburner.workformulas.crimesuccesschance.md @@ -7,7 +7,7 @@ **Signature:** ```typescript -crimeSuccessChance(person: Person, crimeType: CrimeType | `${CrimeType}`): number; +crimeSuccessChance(person: Person, crimeType: CrimeType): number; ``` ## Parameters @@ -15,7 +15,7 @@ crimeSuccessChance(person: Person, crimeType: CrimeType | `${CrimeType}`): numbe | Parameter | Type | Description | | --- | --- | --- | | person | [Person](./bitburner.person.md) | | -| crimeType | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)}\` | | +| crimeType | [CrimeType](./bitburner.crimetype.md) | | **Returns:** diff --git a/markdown/bitburner.workformulas.factiongains.md b/markdown/bitburner.workformulas.factiongains.md index 100b15084..58d4eba11 100644 --- a/markdown/bitburner.workformulas.factiongains.md +++ b/markdown/bitburner.workformulas.factiongains.md @@ -7,7 +7,7 @@ **Signature:** ```typescript -factionGains(person: Person, workType: FactionWorkType | `${FactionWorkType}`, favor: number): WorkStats; +factionGains(person: Person, workType: FactionWorkType, favor: number): WorkStats; ``` ## Parameters @@ -15,7 +15,7 @@ factionGains(person: Person, workType: FactionWorkType | `${FactionWorkType}`, f | Parameter | Type | Description | | --- | --- | --- | | person | [Person](./bitburner.person.md) | | -| workType | [FactionWorkType](./bitburner.factionworktype.md) \| \`${[FactionWorkType](./bitburner.factionworktype.md)}\` | | +| workType | [FactionWorkType](./bitburner.factionworktype.md) | | | favor | number | | **Returns:** diff --git a/markdown/bitburner.workformulas.gymgains.md b/markdown/bitburner.workformulas.gymgains.md index 78097aa16..2b12dc033 100644 --- a/markdown/bitburner.workformulas.gymgains.md +++ b/markdown/bitburner.workformulas.gymgains.md @@ -7,7 +7,7 @@ **Signature:** ```typescript -gymGains(person: Person, gymType: GymType | `${GymType}`, locationName: LocationName | `${LocationName}`): WorkStats; +gymGains(person: Person, gymType: GymType, locationName: LocationName): WorkStats; ``` ## Parameters @@ -15,8 +15,8 @@ gymGains(person: Person, gymType: GymType | `${GymType}`, locationName: Location | Parameter | Type | Description | | --- | --- | --- | | person | [Person](./bitburner.person.md) | | -| gymType | [GymType](./bitburner.gymtype.md) \| \`${[GymType](./bitburner.gymtype.md)}\` | | -| locationName | [LocationName](./bitburner.locationname.md) \| \`${[LocationName](./bitburner.locationname.md)}\` | | +| gymType | [GymType](./bitburner.gymtype.md) | | +| locationName | [LocationName](./bitburner.locationname.md) | | **Returns:** diff --git a/markdown/bitburner.workformulas.universitygains.md b/markdown/bitburner.workformulas.universitygains.md index dfd82ede0..650e9519a 100644 --- a/markdown/bitburner.workformulas.universitygains.md +++ b/markdown/bitburner.workformulas.universitygains.md @@ -7,11 +7,7 @@ **Signature:** ```typescript -universityGains( - person: Person, - classType: UniversityClassType | `${UniversityClassType}`, - locationName: LocationName | `${LocationName}`, - ): WorkStats; +universityGains(person: Person, classType: UniversityClassType, locationName: LocationName): WorkStats; ``` ## Parameters @@ -19,8 +15,8 @@ universityGains( | Parameter | Type | Description | | --- | --- | --- | | person | [Person](./bitburner.person.md) | | -| classType | [UniversityClassType](./bitburner.universityclasstype.md) \| \`${[UniversityClassType](./bitburner.universityclasstype.md)}\` | | -| locationName | [LocationName](./bitburner.locationname.md) \| \`${[LocationName](./bitburner.locationname.md)}\` | | +| classType | [UniversityClassType](./bitburner.universityclasstype.md) | | +| locationName | [LocationName](./bitburner.locationname.md) | | **Returns:** diff --git a/src/Corporation/Actions.ts b/src/Corporation/Actions.ts index 831ded7dc..d8a597c78 100644 --- a/src/Corporation/Actions.ts +++ b/src/Corporation/Actions.ts @@ -10,7 +10,7 @@ import { OfficeSpace } from "./OfficeSpace"; import { Material } from "./Material"; import { Product } from "./Product"; import { Warehouse } from "./Warehouse"; -import { CreatingCorporationCheckResult, FactionName, IndustryType } from "@enums"; +import { CreatingCorporationCheckResultEnum, FactionName, IndustryType } from "@enums"; import { ResearchMap } from "./ResearchMap"; import { isRelevantMaterial } from "./ui/Helpers"; import { CityName } from "@enums"; @@ -33,13 +33,13 @@ import { formatMoney, formatNumber } from "../ui/formatNumber"; export function createCorporation(corporationName: string, selfFund: boolean, restart: boolean): Result { const checkResult = canCreateCorporation(selfFund, restart); switch (checkResult) { - case CreatingCorporationCheckResult.Success: + case CreatingCorporationCheckResultEnum.Success: break; - case CreatingCorporationCheckResult.NoSf3OrDisabled: - case CreatingCorporationCheckResult.CorporationExists: + case CreatingCorporationCheckResultEnum.NoSf3OrDisabled: + case CreatingCorporationCheckResultEnum.CorporationExists: return { success: false, message: convertCreatingCorporationCheckResultToMessage(checkResult) }; - case CreatingCorporationCheckResult.UseSeedMoneyOutsideBN3: - case CreatingCorporationCheckResult.DisabledBySoftCap: + case CreatingCorporationCheckResultEnum.UseSeedMoneyOutsideBN3: + case CreatingCorporationCheckResultEnum.DisabledBySoftCap: // In order to maintain backward compatibility, we have to throw an error in these cases. throw new Error(convertCreatingCorporationCheckResultToMessage(checkResult)); default: diff --git a/src/Corporation/Enums.ts b/src/Corporation/Enums.ts index 7aaa576c3..e3467f4bc 100644 --- a/src/Corporation/Enums.ts +++ b/src/Corporation/Enums.ts @@ -110,10 +110,10 @@ export type CorpProductResearchName = Member; export const CorpResearchName = { ...CorpProductResearchName, ...CorpBaseResearchName }; export type CorpResearchName = Member; -export enum CreatingCorporationCheckResult { - Success = "Success", - NoSf3OrDisabled = "NoSf3OrDisabled", - CorporationExists = "CorporationExists", - UseSeedMoneyOutsideBN3 = "UseSeedMoneyOutsideBN3", - DisabledBySoftCap = "DisabledBySoftCap", -} +export const CreatingCorporationCheckResultEnum = { + Success: "Success", + NoSf3OrDisabled: "NoSf3OrDisabled", + CorporationExists: "CorporationExists", + UseSeedMoneyOutsideBN3: "UseSeedMoneyOutsideBN3", + DisabledBySoftCap: "DisabledBySoftCap", +} as const; diff --git a/src/Corporation/helpers.ts b/src/Corporation/helpers.ts index 371f6595e..43e893aa0 100644 --- a/src/Corporation/helpers.ts +++ b/src/Corporation/helpers.ts @@ -1,24 +1,25 @@ import { Player } from "@player"; +import { CreatingCorporationCheckResult } from "@nsdefs"; import { PositiveInteger, isPositiveInteger } from "../types"; import { formatShares } from "../ui/formatNumber"; import { Corporation } from "./Corporation"; import { CorpUpgrade } from "./data/CorporationUpgrades"; import * as corpConstants from "./data/Constants"; import { currentNodeMults } from "../BitNode/BitNodeMultipliers"; -import { CreatingCorporationCheckResult } from "@enums"; +import { CreatingCorporationCheckResultEnum } from "@enums"; import { throwIfReachable } from "../utils/helpers/throwIfReachable"; export function convertCreatingCorporationCheckResultToMessage(checkResult: CreatingCorporationCheckResult): string { switch (checkResult) { - case CreatingCorporationCheckResult.Success: + case CreatingCorporationCheckResultEnum.Success: return "Success"; - case CreatingCorporationCheckResult.NoSf3OrDisabled: + case CreatingCorporationCheckResultEnum.NoSf3OrDisabled: return "You don't have SF3 or Corporation is disabled by an advanced option"; - case CreatingCorporationCheckResult.CorporationExists: + case CreatingCorporationCheckResultEnum.CorporationExists: return "Corporation exists"; - case CreatingCorporationCheckResult.UseSeedMoneyOutsideBN3: + case CreatingCorporationCheckResultEnum.UseSeedMoneyOutsideBN3: return "You cannot use seed money outside BitNode 3"; - case CreatingCorporationCheckResult.DisabledBySoftCap: + case CreatingCorporationCheckResultEnum.DisabledBySoftCap: return "You cannot create a corporation in this BitNode"; default: throwIfReachable(checkResult); @@ -28,18 +29,18 @@ export function convertCreatingCorporationCheckResultToMessage(checkResult: Crea export function canCreateCorporation(selfFund: boolean, restart: boolean): CreatingCorporationCheckResult { if (!Player.canAccessCorporation()) { - return CreatingCorporationCheckResult.NoSf3OrDisabled; + return CreatingCorporationCheckResultEnum.NoSf3OrDisabled; } if (Player.corporation && !restart) { - return CreatingCorporationCheckResult.CorporationExists; + return CreatingCorporationCheckResultEnum.CorporationExists; } if (Player.bitNodeN !== 3 && !selfFund) { - return CreatingCorporationCheckResult.UseSeedMoneyOutsideBN3; + return CreatingCorporationCheckResultEnum.UseSeedMoneyOutsideBN3; } if (currentNodeMults.CorporationSoftcap < 0.15) { - return CreatingCorporationCheckResult.DisabledBySoftCap; + return CreatingCorporationCheckResultEnum.DisabledBySoftCap; } - return CreatingCorporationCheckResult.Success; + return CreatingCorporationCheckResultEnum.Success; } export function costOfCreatingCorporation(restart: boolean): number { diff --git a/src/NetscriptFunctions/Corporation.ts b/src/NetscriptFunctions/Corporation.ts index 9760a965e..e3fd3ba41 100644 --- a/src/NetscriptFunctions/Corporation.ts +++ b/src/NetscriptFunctions/Corporation.ts @@ -56,7 +56,7 @@ import { } from "../Corporation/Actions"; import { CorpUnlocks } from "../Corporation/data/CorporationUnlocks"; import { CorpUpgrades } from "../Corporation/data/CorporationUpgrades"; -import { CorpUnlockName, CorpUpgradeName, CorpEmployeeJob, CityName, CreatingCorporationCheckResult } from "@enums"; +import { CorpUnlockName, CorpUpgradeName, CorpEmployeeJob, CityName, CreatingCorporationCheckResultEnum } from "@enums"; import { IndustriesData, IndustryResearchTrees } from "../Corporation/data/IndustryData"; import * as corpConstants from "../Corporation/data/Constants"; import { ResearchMap } from "../Corporation/ResearchMap"; @@ -596,7 +596,7 @@ export function NetscriptCorporation(): InternalAPI { canCreateCorporation: (ctx) => (_selfFund) => { const selfFund = !!_selfFund; const checkResult = canCreateCorporation(selfFund, false); - if (checkResult !== CreatingCorporationCheckResult.Success) { + if (checkResult !== CreatingCorporationCheckResultEnum.Success) { helpers.log(ctx, () => convertCreatingCorporationCheckResultToMessage(checkResult)); } return checkResult; diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 2a0c59475..fbc6a5eae 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -1,3 +1,8 @@ +/** + * @public + */ +type _ValueOf = T[keyof T]; + /** All netscript definitions */ /** @public */ interface HP { @@ -405,18 +410,24 @@ interface AugmentPair { } /** @public */ -declare enum PositionType { - Long = "L", - Short = "S", -} +type PositionEnumType = { + Long: "L"; + Short: "S"; +}; /** @public */ -declare enum OrderType { - LimitBuy = "Limit Buy Order", - LimitSell = "Limit Sell Order", - StopBuy = "Stop Buy Order", - StopSell = "Stop Sell Order", -} +type PositionType = _ValueOf; + +/** @public */ +type OrderEnumType = { + LimitBuy: "Limit Buy Order"; + LimitSell: "Limit Sell Order"; + StopBuy: "Stop Buy Order"; + StopSell: "Stop Sell Order"; +}; + +/** @public */ +type OrderType = _ValueOf; /** * Value in map of {@link StockOrder} @@ -1083,8 +1094,8 @@ type SleeveBladeburnerTask = { /** @public */ type SleeveClassTask = { type: "CLASS"; - classType: UniversityClassType | GymType | `${UniversityClassType}` | `${GymType}`; - location: LocationName | `${LocationName}`; + classType: UniversityClassType | GymType; + location: LocationName; }; /** @public */ @@ -1093,7 +1104,7 @@ type SleeveCompanyTask = { type: "COMPANY"; companyName: CompanyName }; /** @public */ type SleeveCrimeTask = { type: "CRIME"; - crimeType: CrimeType | `${CrimeType}`; + crimeType: CrimeType; cyclesWorked: number; cyclesNeeded: number; tasksCompleted: number; @@ -1102,7 +1113,7 @@ type SleeveCrimeTask = { /** @public */ type SleeveFactionTask = { type: "FACTION"; - factionWorkType: FactionWorkType | `${FactionWorkType}`; + factionWorkType: FactionWorkType; factionName: string; }; @@ -1697,7 +1708,7 @@ export interface BaseTask { export interface StudyTask extends BaseTask { type: "CLASS"; classType: string; - location: LocationName | `${LocationName}`; + location: LocationName; } /** @@ -1872,11 +1883,7 @@ export interface Singularity { * @param focus - Acquire player focus on this class. Optional. Defaults to true. * @returns True if action is successfully started, false otherwise. */ - universityCourse( - universityName: UniversityLocationName | `${UniversityLocationName}`, - courseName: UniversityClassType | `${UniversityClassType}`, - focus?: boolean, - ): boolean; + universityCourse(universityName: UniversityLocationName, courseName: UniversityClassType, focus?: boolean): boolean; /** * Workout at the gym. @@ -1898,7 +1905,7 @@ export interface Singularity { * @param focus - Acquire player focus on this gym workout. Optional. Defaults to true. * @returns True if action is successfully started, false otherwise. */ - gymWorkout(gymName: GymLocationName | `${GymLocationName}`, stat: GymType | `${GymType}`, focus?: boolean): boolean; + gymWorkout(gymName: GymLocationName, stat: GymType, focus?: boolean): boolean; /** * Travel to another city. @@ -1912,7 +1919,7 @@ export interface Singularity { * @param city - City to travel to. * @returns True if action is successful, false otherwise. */ - travelToCity(city: CityName | `${CityName}`): boolean; + travelToCity(city: CityName): boolean; /** * Purchase the TOR router. @@ -2085,10 +2092,7 @@ export interface Singularity { * @param positionName - Name of position to get the requirements for. Must be an exact match. * @returns CompanyPositionInfo object. */ - getCompanyPositionInfo( - companyName: CompanyName | `${CompanyName}`, - positionName: JobName | `${JobName}`, - ): CompanyPositionInfo; + getCompanyPositionInfo(companyName: CompanyName, positionName: JobName): CompanyPositionInfo; /** * Get List of Company Positions. @@ -2108,7 +2112,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: CompanyName | `${CompanyName}`): JobName[]; + getCompanyPositions(companyName: CompanyName): JobName[]; /** * Work for a company. @@ -2147,7 +2151,7 @@ export interface Singularity { * * @param companyName - Name of the company. */ - quitJob(companyName: CompanyName | `${CompanyName}`): void; + quitJob(companyName: CompanyName): void; /** * Apply for a job at a company. @@ -2168,7 +2172,7 @@ export interface Singularity { * @param field - Field to which you want to apply. * @returns Job name if the player successfully get a job/promotion, and null otherwise. */ - applyToCompany(companyName: CompanyName | `${CompanyName}`, field: JobField | `${JobField}`): JobName | null; + applyToCompany(companyName: CompanyName, field: JobField): JobName | null; /** * Get company reputation. @@ -2182,7 +2186,7 @@ export interface Singularity { * @param companyName - Name of the company. * @returns Amount of reputation you have at the specified company. */ - getCompanyRep(companyName: CompanyName | `${CompanyName}`): number; + getCompanyRep(companyName: CompanyName): number; /** * Get company favor. @@ -2196,7 +2200,7 @@ export interface Singularity { * @param companyName - Name of the company. * @returns Amount of favor you have at the specified company. */ - getCompanyFavor(companyName: CompanyName | `${CompanyName}`): number; + getCompanyFavor(companyName: CompanyName): number; /** * Get company favor gain. @@ -2210,7 +2214,7 @@ export interface Singularity { * @param companyName - Name of the company. * @returns Amount of favor you gain at the specified company when you reset by installing Augmentations. */ - getCompanyFavorGain(companyName: CompanyName | `${CompanyName}`): number; + getCompanyFavorGain(companyName: CompanyName): number; /** * List conditions for being invited to a faction. @@ -2316,7 +2320,7 @@ export interface Singularity { * @param focus - Acquire player focus on this work operation. Optional. Defaults to true. * @returns True if the player starts working, and false otherwise. */ - workForFaction(faction: string, workType: FactionWorkType | `${FactionWorkType}`, focus?: boolean): boolean; + workForFaction(faction: string, workType: FactionWorkType, focus?: boolean): boolean; /** * Get the work types of a faction. @@ -2447,7 +2451,7 @@ export interface Singularity { * @param focus - Acquire player focus on this crime. Optional. Defaults to true. * @returns The number of milliseconds it takes to attempt the specified crime. */ - commitCrime(crime: CrimeType | `${CrimeType}`, focus?: boolean): number; + commitCrime(crime: CrimeType, focus?: boolean): number; /** * Get chance to successfully commit a crime. @@ -2460,7 +2464,7 @@ export interface Singularity { * @param crime - Name of crime. * @returns Chance of success at committing the specified crime. */ - getCrimeChance(crime: CrimeType | `${CrimeType}`): number; + getCrimeChance(crime: CrimeType): number; /** * Get stats related to a crime. @@ -2473,7 +2477,7 @@ export interface Singularity { * @param crime - Name of crime. * @returns The stats of the crime. */ - getCrimeStats(crime: CrimeType | `${CrimeType}`): CrimeStats; + getCrimeStats(crime: CrimeType): CrimeStats; /** * Get a list of owned augmentation. @@ -2654,7 +2658,7 @@ export interface Singularity { * @param locationName - Name of the location. * @returns True if the player was moved there, false otherwise. */ - goToLocation(locationName: LocationName | `${LocationName}`): boolean; + goToLocation(locationName: LocationName): boolean; /** * Get the current server. @@ -3171,100 +3175,118 @@ export interface Hacknet { * * @public */ -declare enum BladeburnerActionType { - General = "General", - Contract = "Contracts", - Operation = "Operations", - BlackOp = "Black Operations", -} +type BladeburnerActionEnumType = { + General: "General"; + Contract: "Contracts"; + Operation: "Operations"; + BlackOp: "Black Operations"; +}; + +/** @public */ +type BladeburnerActionType = _ValueOf; /** * General action names of Bladeburner * * @public */ -declare enum BladeburnerGeneralActionName { - Training = "Training", - FieldAnalysis = "Field Analysis", - Recruitment = "Recruitment", - Diplomacy = "Diplomacy", - HyperbolicRegen = "Hyperbolic Regeneration Chamber", - InciteViolence = "Incite Violence", -} +type BladeburnerGeneralActionNameEnumType = { + Training: "Training"; + FieldAnalysis: "Field Analysis"; + Recruitment: "Recruitment"; + Diplomacy: "Diplomacy"; + HyperbolicRegen: "Hyperbolic Regeneration Chamber"; + InciteViolence: "Incite Violence"; +}; + +/** @public */ +type BladeburnerGeneralActionName = _ValueOf; /** * Contract names of Bladeburner * * @public */ -declare enum BladeburnerContractName { - Tracking = "Tracking", - BountyHunter = "Bounty Hunter", - Retirement = "Retirement", -} +type BladeburnerContractNameEnumType = { + Tracking: "Tracking"; + BountyHunter: "Bounty Hunter"; + Retirement: "Retirement"; +}; + +/** @public */ +type BladeburnerContractName = _ValueOf; /** * Operation names of Bladeburner * * @public */ -declare enum BladeburnerOperationName { - Investigation = "Investigation", - Undercover = "Undercover Operation", - Sting = "Sting Operation", - Raid = "Raid", - StealthRetirement = "Stealth Retirement Operation", - Assassination = "Assassination", -} +type BladeburnerOperationNameEnumType = { + Investigation: "Investigation"; + Undercover: "Undercover Operation"; + Sting: "Sting Operation"; + Raid: "Raid"; + StealthRetirement: "Stealth Retirement Operation"; + Assassination: "Assassination"; +}; + +/** @public */ +type BladeburnerOperationName = _ValueOf; /** * Black Operation names of Bladeburner * * @public */ -declare enum BladeburnerBlackOpName { - OperationTyphoon = "Operation Typhoon", - OperationZero = "Operation Zero", - OperationX = "Operation X", - OperationTitan = "Operation Titan", - OperationAres = "Operation Ares", - OperationArchangel = "Operation Archangel", - OperationJuggernaut = "Operation Juggernaut", - OperationRedDragon = "Operation Red Dragon", - OperationK = "Operation K", - OperationDeckard = "Operation Deckard", - OperationTyrell = "Operation Tyrell", - OperationWallace = "Operation Wallace", - OperationShoulderOfOrion = "Operation Shoulder of Orion", - OperationHyron = "Operation Hyron", - OperationMorpheus = "Operation Morpheus", - OperationIonStorm = "Operation Ion Storm", - OperationAnnihilus = "Operation Annihilus", - OperationUltron = "Operation Ultron", - OperationCenturion = "Operation Centurion", - OperationVindictus = "Operation Vindictus", - OperationDaedalus = "Operation Daedalus", -} +type BladeburnerBlackOpNameEnumType = { + OperationTyphoon: "Operation Typhoon"; + OperationZero: "Operation Zero"; + OperationX: "Operation X"; + OperationTitan: "Operation Titan"; + OperationAres: "Operation Ares"; + OperationArchangel: "Operation Archangel"; + OperationJuggernaut: "Operation Juggernaut"; + OperationRedDragon: "Operation Red Dragon"; + OperationK: "Operation K"; + OperationDeckard: "Operation Deckard"; + OperationTyrell: "Operation Tyrell"; + OperationWallace: "Operation Wallace"; + OperationShoulderOfOrion: "Operation Shoulder of Orion"; + OperationHyron: "Operation Hyron"; + OperationMorpheus: "Operation Morpheus"; + OperationIonStorm: "Operation Ion Storm"; + OperationAnnihilus: "Operation Annihilus"; + OperationUltron: "Operation Ultron"; + OperationCenturion: "Operation Centurion"; + OperationVindictus: "Operation Vindictus"; + OperationDaedalus: "Operation Daedalus"; +}; + +/** @public */ +type BladeburnerBlackOpName = _ValueOf; /** * Skill names type of Bladeburner * * @public */ -declare enum BladeburnerSkillName { - BladesIntuition = "Blade's Intuition", - Cloak = "Cloak", - ShortCircuit = "Short-Circuit", - DigitalObserver = "Digital Observer", - Tracer = "Tracer", - Overclock = "Overclock", - Reaper = "Reaper", - EvasiveSystem = "Evasive System", - Datamancer = "Datamancer", - CybersEdge = "Cyber's Edge", - HandsOfMidas = "Hands of Midas", - Hyperdrive = "Hyperdrive", -} +type BladeburnerSkillNameEnumType = { + BladesIntuition: "Blade's Intuition"; + Cloak: "Cloak"; + ShortCircuit: "Short-Circuit"; + DigitalObserver: "Digital Observer"; + Tracer: "Tracer"; + Overclock: "Overclock"; + Reaper: "Reaper"; + EvasiveSystem: "Evasive System"; + Datamancer: "Datamancer"; + CybersEdge: "Cyber's Edge"; + HandsOfMidas: "Hands of Midas"; + Hyperdrive: "Hyperdrive"; +}; + +/** @public */ +type BladeburnerSkillName = _ValueOf; /** * @public @@ -3280,17 +3302,20 @@ export type BladeburnerActionName = * * @public */ -declare enum SpecialBladeburnerActionTypeForSleeve { - InfiltrateSynthoids = "Infiltrate Synthoids", - SupportMainSleeve = "Support main sleeve", - TakeOnContracts = "Take on contracts", -} +type SpecialBladeburnerActionEnumTypeForSleeve = { + InfiltrateSynthoids: "Infiltrate Synthoids"; + SupportMainSleeve: "Support main sleeve"; + TakeOnContracts: "Take on contracts"; +}; + +/** @public */ +type SpecialBladeburnerActionTypeForSleeve = _ValueOf; /** * @public */ export type BladeburnerActionTypeForSleeve = - | Exclude + | Exclude | SpecialBladeburnerActionTypeForSleeve; /** @@ -3386,10 +3411,7 @@ export interface Bladeburner { * @param name - Name of action. Must be an exact match * @returns True if the action was started successfully, and false otherwise. */ - startAction( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): boolean; + startAction(type: BladeburnerActionType, name: BladeburnerActionName): boolean; /** * Stop current action. @@ -3421,10 +3443,7 @@ export interface Bladeburner { * @param name - Name of action. Must be an exact match. * @returns Number of milliseconds it takes to complete the specified action. */ - getActionTime( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; + getActionTime(type: BladeburnerActionType, name: BladeburnerActionName): number; /** * Get the time elapsed on current action. @@ -3453,8 +3472,8 @@ export interface Bladeburner { * @returns Estimated success chance for the specified action. */ getActionEstimatedSuccessChance( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, + type: BladeburnerActionType, + name: BladeburnerActionName, sleeveNumber?: number, ): [number, number]; @@ -3472,11 +3491,7 @@ export interface Bladeburner { * @param level - Optional number. Action level at which to calculate the gain. Will be the action's current level if not given. * @returns Average Bladeburner reputation gain for successfully completing the specified action. */ - getActionRepGain( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - level?: number, - ): number; + getActionRepGain(type: BladeburnerActionType, name: BladeburnerActionName, level?: number): number; /** * Get action count remaining. @@ -3498,10 +3513,7 @@ export interface Bladeburner { * @param name - Name of action. Must be an exact match. * @returns Remaining count of the specified action. */ - getActionCountRemaining( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; + getActionCountRemaining(type: BladeburnerActionType, name: BladeburnerActionName): number; /** * Get the maximum level of an action. @@ -3516,10 +3528,7 @@ export interface Bladeburner { * @param name - Name of action. Must be an exact match. * @returns Maximum level of the specified action. */ - getActionMaxLevel( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; + getActionMaxLevel(type: BladeburnerActionType, name: BladeburnerActionName): number; /** * Get the current level of an action. @@ -3534,10 +3543,7 @@ export interface Bladeburner { * @param name - Name of action. Must be an exact match. * @returns Current level of the specified action. */ - getActionCurrentLevel( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; + getActionCurrentLevel(type: BladeburnerActionType, name: BladeburnerActionName): number; /** * Get whether an action is set to autolevel. @@ -3552,10 +3558,7 @@ export interface Bladeburner { * @param name - Name of action. Must be an exact match. * @returns True if the action is set to autolevel, and false otherwise. */ - getActionAutolevel( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): boolean; + getActionAutolevel(type: BladeburnerActionType, name: BladeburnerActionName): boolean; /** * Get action successes. @@ -3568,10 +3571,7 @@ export interface Bladeburner { * @param name - Name of action. Must be an exact match. * @returns a number with how many successes you have with action. */ - getActionSuccesses( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; + getActionSuccesses(type: BladeburnerActionType, name: BladeburnerActionName): number; /** * Set an action autolevel. @@ -3584,11 +3584,7 @@ export interface Bladeburner { * @param name - Name of action. Must be an exact match. * @param autoLevel - Whether or not to autolevel this action */ - setActionAutolevel( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - autoLevel: boolean, - ): void; + setActionAutolevel(type: BladeburnerActionType, name: BladeburnerActionName, autoLevel: boolean): void; /** * Set the level of an action. @@ -3601,11 +3597,7 @@ export interface Bladeburner { * @param name - Name of action. Must be an exact match. * @param level - Level to set this action to. */ - setActionLevel( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - level: number, - ): void; + setActionLevel(type: BladeburnerActionType, name: BladeburnerActionName, level: number): void; /** * Get player bladeburner rank. @@ -3655,7 +3647,7 @@ export interface Bladeburner { * @param skillName - Name of skill. Case-sensitive and must be an exact match. * @returns Level in the specified skill. */ - getSkillLevel(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`): number; + getSkillLevel(skillName: BladeburnerSkillName): number; /** * Get cost to upgrade skill. @@ -3678,7 +3670,7 @@ export interface Bladeburner { * @param count - Number of times to upgrade the skill. Defaults to 1 if not specified. * @returns Number of skill points needed to upgrade the specified skill. */ - getSkillUpgradeCost(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`, count?: number): number; + getSkillUpgradeCost(skillName: BladeburnerSkillName, count?: number): number; /** * Upgrade skill. @@ -3693,7 +3685,7 @@ export interface Bladeburner { * @param count - Number of times to upgrade the skill. Defaults to 1 if not specified. * @returns true if the skill is successfully upgraded, and false otherwise. */ - upgradeSkill(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`, count?: number): boolean; + upgradeSkill(skillName: BladeburnerSkillName, count?: number): boolean; /** * Get team size. @@ -3710,10 +3702,7 @@ export interface Bladeburner { * @param name - Name of action. Must be an exact match. * @returns Number of Bladeburner team members that were assigned to the specified action. */ - getTeamSize( - type?: BladeburnerActionType | `${BladeburnerActionType}`, - name?: BladeburnerActionName | `${BladeburnerActionName}`, - ): number; + getTeamSize(type?: BladeburnerActionType, name?: BladeburnerActionName): number; /** * Set team size. @@ -3729,11 +3718,7 @@ export interface Bladeburner { * @param size - Number of team members to set. Must be a non-negative integer. * @returns Number of Bladeburner team members you assigned to the specified action. */ - setTeamSize( - type: BladeburnerActionType | `${BladeburnerActionType}`, - name: BladeburnerActionName | `${BladeburnerActionName}`, - size: number, - ): number; + setTeamSize(type: BladeburnerActionType, name: BladeburnerActionName, size: number): number; /** * Get estimated population in city. @@ -3746,7 +3731,7 @@ export interface Bladeburner { * @param city - Name of city. Case-sensitive * @returns Estimated number of Synthoids in the specified city. */ - getCityEstimatedPopulation(city: CityName | `${CityName}`): number; + getCityEstimatedPopulation(city: CityName): number; /** * Get number of communities in a city. @@ -3759,7 +3744,7 @@ export interface Bladeburner { * @param city - Name of city. Case-sensitive * @returns Number of Synthoids communities in the specified city. */ - getCityCommunities(city: CityName | `${CityName}`): number; + getCityCommunities(city: CityName): number; /** * Get chaos of a city. @@ -3772,7 +3757,7 @@ export interface Bladeburner { * @param city - Name of city. Case-sensitive * @returns Chaos in the specified city. */ - getCityChaos(city: CityName | `${CityName}`): number; + getCityChaos(city: CityName): number; /** * Get current city. @@ -3796,7 +3781,7 @@ export interface Bladeburner { * @param city - Name of city. Case-sensitive * @returns true if successful, and false otherwise */ - switchCity(city: CityName | `${CityName}`): boolean; + switchCity(city: CityName): boolean; /** * Get Bladeburner stamina. @@ -3941,7 +3926,7 @@ export interface CodingContract { * @param host - Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided. * @returns Name describing the type of problem posed by the Coding Contract. */ - getContractType(filename: string, host?: string): `${CodingContractName}`; + getContractType(filename: string, host?: string): CodingContractName; /** * Get the description. @@ -4025,7 +4010,7 @@ export interface CodingContract { * @remarks * RAM cost: 0 GB */ - getContractTypes(): `${CodingContractName}`[]; + getContractTypes(): CodingContractName[]; } /** @@ -4978,7 +4963,7 @@ export interface Sleeve { * @param crimeType - Name of the crime. * @returns True if this action was set successfully, false otherwise. */ - setToCommitCrime(sleeveNumber: number, crimeType: CrimeType | `${CrimeType}`): boolean; + setToCommitCrime(sleeveNumber: number, crimeType: CrimeType): boolean; /** * Set a sleeve to work for a faction. @@ -4992,11 +4977,7 @@ export interface Sleeve { * @param factionWorkType - Name of the action to perform for this faction. * @returns True if the sleeve started working for this faction, false otherwise. Can also throw on errors. */ - setToFactionWork( - sleeveNumber: number, - factionName: string, - factionWorkType: FactionWorkType | `${FactionWorkType}`, - ): boolean | undefined; + setToFactionWork(sleeveNumber: number, factionName: string, factionWorkType: FactionWorkType): boolean | undefined; /** * Set a sleeve to work for a company. @@ -5009,7 +4990,7 @@ export interface Sleeve { * @param companyName - Name of the company to work for. * @returns True if the sleeve started working for this company, false otherwise. */ - setToCompanyWork(sleeveNumber: number, companyName: CompanyName | `${CompanyName}`): boolean; + setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean; /** * Set a sleeve to take a class at a university. @@ -5025,8 +5006,8 @@ export interface Sleeve { */ setToUniversityCourse( sleeveNumber: number, - universityName: UniversityLocationName | `${UniversityLocationName}`, - courseName: UniversityClassType | `${UniversityClassType}`, + universityName: UniversityLocationName, + courseName: UniversityClassType, ): boolean; /** @@ -5041,11 +5022,7 @@ export interface Sleeve { * @param stat - Name of the stat to train. * @returns True if the sleeve started working out, false otherwise. */ - setToGymWorkout( - sleeveNumber: number, - gymName: GymLocationName | `${GymLocationName}`, - stat: GymType | `${GymType}`, - ): boolean; + setToGymWorkout(sleeveNumber: number, gymName: GymLocationName, stat: GymType): boolean; /** * Make a sleeve travel to another city. The cost for using this function is the same as for a player. @@ -5058,7 +5035,7 @@ export interface Sleeve { * @param city - Name of the destination city. * @returns True if the sleeve reached destination, false otherwise. */ - travel(sleeveNumber: number, city: CityName | `${CityName}`): boolean; + travel(sleeveNumber: number, city: CityName): boolean; /** * Get augmentations installed on a sleeve. @@ -5133,7 +5110,7 @@ export interface Sleeve { */ setToBladeburnerAction( sleeveNumber: number, - action: BladeburnerActionTypeForSleeve | `${BladeburnerActionTypeForSleeve}`, + action: BladeburnerActionTypeForSleeve, contract?: BladeburnerContractName, ): boolean; } @@ -5255,26 +5232,17 @@ interface WorkStats { * @public */ interface WorkFormulas { - crimeSuccessChance(person: Person, crimeType: CrimeType | `${CrimeType}`): number; + crimeSuccessChance(person: Person, crimeType: CrimeType): number; /** @returns The WorkStats gained when completing one instance of the specified crime. */ - crimeGains(person: Person, crimeType: CrimeType | `${CrimeType}`): WorkStats; + crimeGains(person: Person, crimeType: CrimeType): WorkStats; /** @returns The WorkStats applied every game cycle (200ms) by taking the specified gym class. */ - gymGains(person: Person, gymType: GymType | `${GymType}`, locationName: LocationName | `${LocationName}`): WorkStats; + gymGains(person: Person, gymType: GymType, locationName: LocationName): WorkStats; /** @returns The WorkStats applied every game cycle (200ms) by taking the specified university class. */ - universityGains( - person: Person, - classType: UniversityClassType | `${UniversityClassType}`, - locationName: LocationName | `${LocationName}`, - ): WorkStats; + universityGains(person: Person, classType: UniversityClassType, locationName: LocationName): WorkStats; /** @returns The WorkStats applied every game cycle (200ms) by performing the specified faction work. */ - factionGains(person: Person, workType: FactionWorkType | `${FactionWorkType}`, favor: number): WorkStats; + factionGains(person: Person, workType: FactionWorkType, favor: number): WorkStats; /** @returns The WorkStats applied every game cycle (200ms) by performing the specified company work. */ - companyGains( - person: Person, - companyName: CompanyName | `${CompanyName}`, - workType: JobName | `${JobName}`, - favor: number, - ): WorkStats; + companyGains(person: Person, companyName: CompanyName, workType: JobName, favor: number): WorkStats; } /** @@ -5601,11 +5569,7 @@ interface BladeburnerFormulas { * @param skillPoints - Number of skill points to upgrade the skill. It must be a non-negative number. * @returns Number of times that you can upgrade the skill. */ - skillMaxUpgradeCount( - name: BladeburnerSkillName | `${BladeburnerSkillName}`, - level: number, - skillPoints: number, - ): number; + skillMaxUpgradeCount(name: BladeburnerSkillName, level: number, skillPoints: number): number; } /** @@ -5813,7 +5777,7 @@ interface Infiltration { * * @returns Infiltration data for given location. */ - getInfiltration(location: LocationName | `${LocationName}`): InfiltrationLocation; + getInfiltration(location: LocationName): InfiltrationLocation; } /** @@ -8198,7 +8162,7 @@ export interface NS { * @param variant - Type of toast. Must be one of success, info, warning, error. Defaults to success. * @param duration - Duration of toast in ms. Can also be `null` to create a persistent toast. Defaults to 2000. */ - toast(msg: string, variant?: ToastVariant | `${ToastVariant}`, duration?: number | null): void; + toast(msg: string, variant?: ToastVariant, duration?: number | null): void; /** * Download a file from the internet. @@ -8441,110 +8405,131 @@ export interface NS { // BASE ENUMS /** @public */ -declare enum ToastVariant { - SUCCESS = "success", - WARNING = "warning", - ERROR = "error", - INFO = "info", -} +type ToastVariantEnumType = { + SUCCESS: "success"; + WARNING: "warning"; + ERROR: "error"; + INFO: "info"; +}; /** @public */ -declare enum CrimeType { - shoplift = "Shoplift", - robStore = "Rob Store", - mug = "Mug", - larceny = "Larceny", - dealDrugs = "Deal Drugs", - bondForgery = "Bond Forgery", - traffickArms = "Traffick Arms", - homicide = "Homicide", - grandTheftAuto = "Grand Theft Auto", - kidnap = "Kidnap", - assassination = "Assassination", - heist = "Heist", -} +type ToastVariant = _ValueOf; /** @public */ -declare enum FactionWorkType { - hacking = "hacking", - field = "field", - security = "security", -} +type CrimeEnumType = { + shoplift: "Shoplift"; + robStore: "Rob Store"; + mug: "Mug"; + larceny: "Larceny"; + dealDrugs: "Deal Drugs"; + bondForgery: "Bond Forgery"; + traffickArms: "Traffick Arms"; + homicide: "Homicide"; + grandTheftAuto: "Grand Theft Auto"; + kidnap: "Kidnap"; + assassination: "Assassination"; + heist: "Heist"; +}; /** @public */ -declare enum UniversityClassType { - computerScience = "Computer Science", - dataStructures = "Data Structures", - networks = "Networks", - algorithms = "Algorithms", - management = "Management", - leadership = "Leadership", -} +type CrimeType = _ValueOf; /** @public */ -declare enum GymType { - strength = "str", - defense = "def", - dexterity = "dex", - agility = "agi", -} +type FactionWorkEnumType = { + hacking: "hacking"; + field: "field"; + security: "security"; +}; /** @public */ -declare enum JobName { - software0 = "Software Engineering Intern", - software1 = "Junior Software Engineer", - software2 = "Senior Software Engineer", - software3 = "Lead Software Developer", - software4 = "Head of Software", - software5 = "Head of Engineering", - software6 = "Vice President of Technology", - software7 = "Chief Technology Officer", - IT0 = "IT Intern", - IT1 = "IT Analyst", - IT2 = "IT Manager", - IT3 = "Systems Administrator", - securityEng = "Security Engineer", - networkEng0 = "Network Engineer", - networkEng1 = "Network Administrator", - business0 = "Business Intern", - business1 = "Business Analyst", - business2 = "Business Manager", - business3 = "Operations Manager", - business4 = "Chief Financial Officer", - business5 = "Chief Executive Officer", - security0 = "Security Guard", - security1 = "Security Officer", - security2 = "Security Supervisor", - security3 = "Head of Security", - agent0 = "Field Agent", - agent1 = "Secret Agent", - agent2 = "Special Operative", - waiter = "Waiter", - employee = "Employee", - softwareConsult0 = "Software Consultant", - softwareConsult1 = "Senior Software Consultant", - businessConsult0 = "Business Consultant", - businessConsult1 = "Senior Business Consultant", - waiterPT = "Part-time Waiter", - employeePT = "Part-time Employee", -} +type FactionWorkType = _ValueOf; /** @public */ -declare enum JobField { - software = "Software", - softwareConsultant = "Software Consultant", - it = "IT", - securityEngineer = "Security Engineer", - networkEngineer = "Network Engineer", - business = "Business", - businessConsultant = "Business Consultant", - security = "Security", - agent = "Agent", - employee = "Employee", - partTimeEmployee = "Part-time Employee", - waiter = "Waiter", - partTimeWaiter = "Part-time Waiter", -} +type UniversityClassEnumType = { + computerScience: "Computer Science"; + dataStructures: "Data Structures"; + networks: "Networks"; + algorithms: "Algorithms"; + management: "Management"; + leadership: "Leadership"; +}; + +/** @public */ +type UniversityClassType = _ValueOf; + +/** @public */ +type GymEnumType = { + strength: "str"; + defense: "def"; + dexterity: "dex"; + agility: "agi"; +}; + +/** @public */ +type GymType = _ValueOf; + +/** @public */ +type JobNameEnumType = { + software0: "Software Engineering Intern"; + software1: "Junior Software Engineer"; + software2: "Senior Software Engineer"; + software3: "Lead Software Developer"; + software4: "Head of Software"; + software5: "Head of Engineering"; + software6: "Vice President of Technology"; + software7: "Chief Technology Officer"; + IT0: "IT Intern"; + IT1: "IT Analyst"; + IT2: "IT Manager"; + IT3: "Systems Administrator"; + securityEng: "Security Engineer"; + networkEng0: "Network Engineer"; + networkEng1: "Network Administrator"; + business0: "Business Intern"; + business1: "Business Analyst"; + business2: "Business Manager"; + business3: "Operations Manager"; + business4: "Chief Financial Officer"; + business5: "Chief Executive Officer"; + security0: "Security Guard"; + security1: "Security Officer"; + security2: "Security Supervisor"; + security3: "Head of Security"; + agent0: "Field Agent"; + agent1: "Secret Agent"; + agent2: "Special Operative"; + waiter: "Waiter"; + employee: "Employee"; + softwareConsult0: "Software Consultant"; + softwareConsult1: "Senior Software Consultant"; + businessConsult0: "Business Consultant"; + businessConsult1: "Senior Business Consultant"; + waiterPT: "Part-time Waiter"; + employeePT: "Part-time Employee"; +}; + +/** @public */ +type JobName = _ValueOf; + +/** @public */ +type JobFieldEnumType = { + software: "Software"; + softwareConsultant: "Software Consultant"; + it: "IT"; + securityEngineer: "Security Engineer"; + networkEngineer: "Network Engineer"; + business: "Business"; + businessConsultant: "Business Consultant"; + security: "Security"; + agent: "Agent"; + employee: "Employee"; + partTimeEmployee: "Part-time Employee"; + waiter: "Waiter"; + partTimeWaiter: "Part-time Waiter"; +}; + +/** @public */ +type JobField = _ValueOf; // CORP ENUMS - Changed to types /** @public */ @@ -8578,151 +8563,169 @@ type CorpIndustryName = /** @public */ type CorpSmartSupplyOption = "leftovers" | "imports" | "none"; -/** Names of all cities - * @public */ -declare enum CityName { - Aevum = "Aevum", - Chongqing = "Chongqing", - Sector12 = "Sector-12", - NewTokyo = "New Tokyo", - Ishima = "Ishima", - Volhaven = "Volhaven", -} +/** + * Names of all cities + * + * @public + */ +type CityNameEnumType = { + Aevum: "Aevum"; + Chongqing: "Chongqing"; + Sector12: "Sector-12"; + NewTokyo: "New Tokyo"; + Ishima: "Ishima"; + Volhaven: "Volhaven"; +}; + +/** @public */ +type CityName = _ValueOf; /** Names of all locations * @public */ -declare enum LocationName { - AevumAeroCorp = "AeroCorp", - AevumBachmanAndAssociates = "Bachman & Associates", - AevumClarkeIncorporated = "Clarke Incorporated", - AevumCrushFitnessGym = "Crush Fitness Gym", - AevumECorp = "ECorp", - AevumFulcrumTechnologies = "Fulcrum Technologies", - AevumGalacticCybersystems = "Galactic Cybersystems", - AevumNetLinkTechnologies = "NetLink Technologies", - AevumPolice = "Aevum Police Headquarters", - AevumRhoConstruction = "Rho Construction", - AevumSnapFitnessGym = "Snap Fitness Gym", - AevumSummitUniversity = "Summit University", - AevumWatchdogSecurity = "Watchdog Security", - AevumCasino = "Iker Molina Casino", +type LocationNameEnumType = { + AevumAeroCorp: "AeroCorp"; + AevumBachmanAndAssociates: "Bachman & Associates"; + AevumClarkeIncorporated: "Clarke Incorporated"; + AevumCrushFitnessGym: "Crush Fitness Gym"; + AevumECorp: "ECorp"; + AevumFulcrumTechnologies: "Fulcrum Technologies"; + AevumGalacticCybersystems: "Galactic Cybersystems"; + AevumNetLinkTechnologies: "NetLink Technologies"; + AevumPolice: "Aevum Police Headquarters"; + AevumRhoConstruction: "Rho Construction"; + AevumSnapFitnessGym: "Snap Fitness Gym"; + AevumSummitUniversity: "Summit University"; + AevumWatchdogSecurity: "Watchdog Security"; + AevumCasino: "Iker Molina Casino"; - ChongqingKuaiGongInternational = "KuaiGong International", - ChongqingSolarisSpaceSystems = "Solaris Space Systems", - ChongqingChurchOfTheMachineGod = "Church of the Machine God", + ChongqingKuaiGongInternational: "KuaiGong International"; + ChongqingSolarisSpaceSystems: "Solaris Space Systems"; + ChongqingChurchOfTheMachineGod: "Church of the Machine God"; - Sector12AlphaEnterprises = "Alpha Enterprises", - Sector12BladeIndustries = "Blade Industries", - Sector12CIA = "Central Intelligence Agency", - Sector12CarmichaelSecurity = "Carmichael Security", - Sector12CityHall = "Sector-12 City Hall", - Sector12DeltaOne = "DeltaOne", - Sector12FoodNStuff = "FoodNStuff", - Sector12FourSigma = "Four Sigma", - Sector12IcarusMicrosystems = "Icarus Microsystems", - Sector12IronGym = "Iron Gym", - Sector12JoesGuns = "Joe's Guns", - Sector12MegaCorp = "MegaCorp", - Sector12NSA = "National Security Agency", - Sector12PowerhouseGym = "Powerhouse Gym", - Sector12RothmanUniversity = "Rothman University", - Sector12UniversalEnergy = "Universal Energy", + Sector12AlphaEnterprises: "Alpha Enterprises"; + Sector12BladeIndustries: "Blade Industries"; + Sector12CIA: "Central Intelligence Agency"; + Sector12CarmichaelSecurity: "Carmichael Security"; + Sector12CityHall: "Sector-12 City Hall"; + Sector12DeltaOne: "DeltaOne"; + Sector12FoodNStuff: "FoodNStuff"; + Sector12FourSigma: "Four Sigma"; + Sector12IcarusMicrosystems: "Icarus Microsystems"; + Sector12IronGym: "Iron Gym"; + Sector12JoesGuns: "Joe's Guns"; + Sector12MegaCorp: "MegaCorp"; + Sector12NSA: "National Security Agency"; + Sector12PowerhouseGym: "Powerhouse Gym"; + Sector12RothmanUniversity: "Rothman University"; + Sector12UniversalEnergy: "Universal Energy"; - NewTokyoDefComm = "DefComm", - NewTokyoGlobalPharmaceuticals = "Global Pharmaceuticals", - NewTokyoNoodleBar = "Noodle Bar", - NewTokyoVitaLife = "VitaLife", - NewTokyoArcade = "Arcade", + NewTokyoDefComm: "DefComm"; + NewTokyoGlobalPharmaceuticals: "Global Pharmaceuticals"; + NewTokyoNoodleBar: "Noodle Bar"; + NewTokyoVitaLife: "VitaLife"; + NewTokyoArcade: "Arcade"; - IshimaNovaMedical = "Nova Medical", - IshimaOmegaSoftware = "Omega Software", - IshimaStormTechnologies = "Storm Technologies", - IshimaGlitch = "0x6C1", + IshimaNovaMedical: "Nova Medical"; + IshimaOmegaSoftware: "Omega Software"; + IshimaStormTechnologies: "Storm Technologies"; + IshimaGlitch: "0x6C1"; - VolhavenCompuTek = "CompuTek", - VolhavenHeliosLabs = "Helios Labs", - VolhavenLexoCorp = "LexoCorp", - VolhavenMilleniumFitnessGym = "Millenium Fitness Gym", - VolhavenNWO = "NWO", - VolhavenOmniTekIncorporated = "OmniTek Incorporated", - VolhavenOmniaCybersystems = "Omnia Cybersystems", - VolhavenSysCoreSecurities = "SysCore Securities", - VolhavenZBInstituteOfTechnology = "ZB Institute of Technology", + VolhavenCompuTek: "CompuTek"; + VolhavenHeliosLabs: "Helios Labs"; + VolhavenLexoCorp: "LexoCorp"; + VolhavenMilleniumFitnessGym: "Millenium Fitness Gym"; + VolhavenNWO: "NWO"; + VolhavenOmniTekIncorporated: "OmniTek Incorporated"; + VolhavenOmniaCybersystems: "Omnia Cybersystems"; + VolhavenSysCoreSecurities: "SysCore Securities"; + VolhavenZBInstituteOfTechnology: "ZB Institute of Technology"; - Hospital = "Hospital", - Slums = "The Slums", - TravelAgency = "Travel Agency", - WorldStockExchange = "World Stock Exchange", + Hospital: "Hospital"; + Slums: "The Slums"; + TravelAgency: "Travel Agency"; + WorldStockExchange: "World Stock Exchange"; - Void = "The Void", -} + Void: "The Void"; +}; + +/** @public */ +type LocationName = _ValueOf; /** * Locations of university * * @public */ -declare enum UniversityLocationName { - AevumSummitUniversity = LocationName.AevumSummitUniversity, - Sector12RothmanUniversity = LocationName.Sector12RothmanUniversity, - VolhavenZBInstituteOfTechnology = LocationName.VolhavenZBInstituteOfTechnology, -} +type UniversityLocationNameEnumType = { + AevumSummitUniversity: LocationNameEnumType["AevumSummitUniversity"]; + Sector12RothmanUniversity: LocationNameEnumType["Sector12RothmanUniversity"]; + VolhavenZBInstituteOfTechnology: LocationNameEnumType["VolhavenZBInstituteOfTechnology"]; +}; + +/** @public */ +type UniversityLocationName = _ValueOf; /** * Locations of gym * * @public */ -declare enum GymLocationName { - AevumCrushFitnessGym = LocationName.AevumCrushFitnessGym, - AevumSnapFitnessGym = LocationName.AevumSnapFitnessGym, - Sector12IronGym = LocationName.Sector12IronGym, - Sector12PowerhouseGym = LocationName.Sector12PowerhouseGym, - VolhavenMilleniumFitnessGym = LocationName.VolhavenMilleniumFitnessGym, -} +type GymLocationNameEnumType = { + AevumCrushFitnessGym: LocationNameEnumType["AevumCrushFitnessGym"]; + AevumSnapFitnessGym: LocationNameEnumType["AevumSnapFitnessGym"]; + Sector12IronGym: LocationNameEnumType["Sector12IronGym"]; + Sector12PowerhouseGym: LocationNameEnumType["Sector12PowerhouseGym"]; + VolhavenMilleniumFitnessGym: LocationNameEnumType["VolhavenMilleniumFitnessGym"]; +}; + +/** @public */ +type GymLocationName = _ValueOf; /** Names of all companies * @public */ -declare enum CompanyName { - ECorp = "ECorp", - MegaCorp = "MegaCorp", - BachmanAndAssociates = "Bachman & Associates", - BladeIndustries = "Blade Industries", - NWO = "NWO", - ClarkeIncorporated = "Clarke Incorporated", - OmniTekIncorporated = "OmniTek Incorporated", - FourSigma = "Four Sigma", - KuaiGongInternational = "KuaiGong International", - FulcrumTechnologies = "Fulcrum Technologies", - StormTechnologies = "Storm Technologies", - DefComm = "DefComm", - HeliosLabs = "Helios Labs", - VitaLife = "VitaLife", - IcarusMicrosystems = "Icarus Microsystems", - UniversalEnergy = "Universal Energy", - GalacticCybersystems = "Galactic Cybersystems", - AeroCorp = "AeroCorp", - OmniaCybersystems = "Omnia Cybersystems", - SolarisSpaceSystems = "Solaris Space Systems", - DeltaOne = "DeltaOne", - GlobalPharmaceuticals = "Global Pharmaceuticals", - NovaMedical = "Nova Medical", - CIA = "Central Intelligence Agency", - NSA = "National Security Agency", - WatchdogSecurity = "Watchdog Security", - LexoCorp = "LexoCorp", - RhoConstruction = "Rho Construction", - AlphaEnterprises = "Alpha Enterprises", - Police = "Aevum Police Headquarters", - SysCoreSecurities = "SysCore Securities", - CompuTek = "CompuTek", - NetLinkTechnologies = "NetLink Technologies", - CarmichaelSecurity = "Carmichael Security", - FoodNStuff = "FoodNStuff", - JoesGuns = "Joe's Guns", - OmegaSoftware = "Omega Software", - NoodleBar = "Noodle Bar", -} +type CompanyNameEnumType = { + ECorp: "ECorp"; + MegaCorp: "MegaCorp"; + BachmanAndAssociates: "Bachman & Associates"; + BladeIndustries: "Blade Industries"; + NWO: "NWO"; + ClarkeIncorporated: "Clarke Incorporated"; + OmniTekIncorporated: "OmniTek Incorporated"; + FourSigma: "Four Sigma"; + KuaiGongInternational: "KuaiGong International"; + FulcrumTechnologies: "Fulcrum Technologies"; + StormTechnologies: "Storm Technologies"; + DefComm: "DefComm"; + HeliosLabs: "Helios Labs"; + VitaLife: "VitaLife"; + IcarusMicrosystems: "Icarus Microsystems"; + UniversalEnergy: "Universal Energy"; + GalacticCybersystems: "Galactic Cybersystems"; + AeroCorp: "AeroCorp"; + OmniaCybersystems: "Omnia Cybersystems"; + SolarisSpaceSystems: "Solaris Space Systems"; + DeltaOne: "DeltaOne"; + GlobalPharmaceuticals: "Global Pharmaceuticals"; + NovaMedical: "Nova Medical"; + CIA: "Central Intelligence Agency"; + NSA: "National Security Agency"; + WatchdogSecurity: "Watchdog Security"; + LexoCorp: "LexoCorp"; + RhoConstruction: "Rho Construction"; + AlphaEnterprises: "Alpha Enterprises"; + Police: "Aevum Police Headquarters"; + SysCoreSecurities: "SysCore Securities"; + CompuTek: "CompuTek"; + NetLinkTechnologies: "NetLink Technologies"; + CarmichaelSecurity: "Carmichael Security"; + FoodNStuff: "FoodNStuff"; + JoesGuns: "Joe's Guns"; + OmegaSoftware: "Omega Software"; + NoodleBar: "Noodle Bar"; +}; + +/** @public */ +type CompanyName = _ValueOf; /** * Names of all factions. @@ -8731,103 +8734,109 @@ declare enum CompanyName { * factions are, you should not check this enum. Some factions are only accessible in the endgame. * * @public */ -declare enum FactionName { - Illuminati = "Illuminati", - Daedalus = "Daedalus", - TheCovenant = "The Covenant", - ECorp = "ECorp", - MegaCorp = "MegaCorp", - BachmanAssociates = "Bachman & Associates", - BladeIndustries = "Blade Industries", - NWO = "NWO", - ClarkeIncorporated = "Clarke Incorporated", - OmniTekIncorporated = "OmniTek Incorporated", - FourSigma = "Four Sigma", - KuaiGongInternational = "KuaiGong International", - FulcrumSecretTechnologies = "Fulcrum Secret Technologies", - BitRunners = "BitRunners", - TheBlackHand = "The Black Hand", - NiteSec = "NiteSec", - Aevum = "Aevum", - Chongqing = "Chongqing", - Ishima = "Ishima", - NewTokyo = "New Tokyo", - Sector12 = "Sector-12", - Volhaven = "Volhaven", - SpeakersForTheDead = "Speakers for the Dead", - TheDarkArmy = "The Dark Army", - TheSyndicate = "The Syndicate", - Silhouette = "Silhouette", - Tetrads = "Tetrads", - SlumSnakes = "Slum Snakes", - Netburners = "Netburners", - TianDiHui = "Tian Di Hui", - CyberSec = "CyberSec", - Bladeburners = "Bladeburners", - ChurchOfTheMachineGod = "Church of the Machine God", - ShadowsOfAnarchy = "Shadows of Anarchy", -} +type FactionNameEnumType = { + Illuminati: "Illuminati"; + Daedalus: "Daedalus"; + TheCovenant: "The Covenant"; + ECorp: "ECorp"; + MegaCorp: "MegaCorp"; + BachmanAssociates: "Bachman & Associates"; + BladeIndustries: "Blade Industries"; + NWO: "NWO"; + ClarkeIncorporated: "Clarke Incorporated"; + OmniTekIncorporated: "OmniTek Incorporated"; + FourSigma: "Four Sigma"; + KuaiGongInternational: "KuaiGong International"; + FulcrumSecretTechnologies: "Fulcrum Secret Technologies"; + BitRunners: "BitRunners"; + TheBlackHand: "The Black Hand"; + NiteSec: "NiteSec"; + Aevum: "Aevum"; + Chongqing: "Chongqing"; + Ishima: "Ishima"; + NewTokyo: "New Tokyo"; + Sector12: "Sector-12"; + Volhaven: "Volhaven"; + SpeakersForTheDead: "Speakers for the Dead"; + TheDarkArmy: "The Dark Army"; + TheSyndicate: "The Syndicate"; + Silhouette: "Silhouette"; + Tetrads: "Tetrads"; + SlumSnakes: "Slum Snakes"; + Netburners: "Netburners"; + TianDiHui: "Tian Di Hui"; + CyberSec: "CyberSec"; + Bladeburners: "Bladeburners"; + ChurchOfTheMachineGod: "Church of the Machine God"; + ShadowsOfAnarchy: "Shadows of Anarchy"; +}; -declare enum CodingContractName { - FindLargestPrimeFactor = "Find Largest Prime Factor", - SubarrayWithMaximumSum = "Subarray with Maximum Sum", - TotalWaysToSum = "Total Ways to Sum", - TotalWaysToSumII = "Total Ways to Sum II", - SpiralizeMatrix = "Spiralize Matrix", - ArrayJumpingGame = "Array Jumping Game", - ArrayJumpingGameII = "Array Jumping Game II", - MergeOverlappingIntervals = "Merge Overlapping Intervals", - GenerateIPAddresses = "Generate IP Addresses", - AlgorithmicStockTraderI = "Algorithmic Stock Trader I", - AlgorithmicStockTraderII = "Algorithmic Stock Trader II", - AlgorithmicStockTraderIII = "Algorithmic Stock Trader III", - AlgorithmicStockTraderIV = "Algorithmic Stock Trader IV", - MinimumPathSumInATriangle = "Minimum Path Sum in a Triangle", - UniquePathsInAGridI = "Unique Paths in a Grid I", - UniquePathsInAGridII = "Unique Paths in a Grid II", - ShortestPathInAGrid = "Shortest Path in a Grid", - SanitizeParenthesesInExpression = "Sanitize Parentheses in Expression", - FindAllValidMathExpressions = "Find All Valid Math Expressions", - HammingCodesIntegerToEncodedBinary = "HammingCodes: Integer to Encoded Binary", - HammingCodesEncodedBinaryToInteger = "HammingCodes: Encoded Binary to Integer", - Proper2ColoringOfAGraph = "Proper 2-Coloring of a Graph", - CompressionIRLECompression = "Compression I: RLE Compression", - CompressionIILZDecompression = "Compression II: LZ Decompression", - CompressionIIILZCompression = "Compression III: LZ Compression", - EncryptionICaesarCipher = "Encryption I: Caesar Cipher", - EncryptionIIVigenereCipher = "Encryption II: Vigenère Cipher", - SquareRoot = "Square Root", -} +/** @public */ +type FactionName = _ValueOf; + +type CodingContractNameEnumType = { + FindLargestPrimeFactor: "Find Largest Prime Factor"; + SubarrayWithMaximumSum: "Subarray with Maximum Sum"; + TotalWaysToSum: "Total Ways to Sum"; + TotalWaysToSumII: "Total Ways to Sum II"; + SpiralizeMatrix: "Spiralize Matrix"; + ArrayJumpingGame: "Array Jumping Game"; + ArrayJumpingGameII: "Array Jumping Game II"; + MergeOverlappingIntervals: "Merge Overlapping Intervals"; + GenerateIPAddresses: "Generate IP Addresses"; + AlgorithmicStockTraderI: "Algorithmic Stock Trader I"; + AlgorithmicStockTraderII: "Algorithmic Stock Trader II"; + AlgorithmicStockTraderIII: "Algorithmic Stock Trader III"; + AlgorithmicStockTraderIV: "Algorithmic Stock Trader IV"; + MinimumPathSumInATriangle: "Minimum Path Sum in a Triangle"; + UniquePathsInAGridI: "Unique Paths in a Grid I"; + UniquePathsInAGridII: "Unique Paths in a Grid II"; + ShortestPathInAGrid: "Shortest Path in a Grid"; + SanitizeParenthesesInExpression: "Sanitize Parentheses in Expression"; + FindAllValidMathExpressions: "Find All Valid Math Expressions"; + HammingCodesIntegerToEncodedBinary: "HammingCodes: Integer to Encoded Binary"; + HammingCodesEncodedBinaryToInteger: "HammingCodes: Encoded Binary to Integer"; + Proper2ColoringOfAGraph: "Proper 2-Coloring of a Graph"; + CompressionIRLECompression: "Compression I: RLE Compression"; + CompressionIILZDecompression: "Compression II: LZ Decompression"; + CompressionIIILZCompression: "Compression III: LZ Compression"; + EncryptionICaesarCipher: "Encryption I: Caesar Cipher"; + EncryptionIIVigenereCipher: "Encryption II: Vigenère Cipher"; + SquareRoot: "Square Root"; +}; + +/** @public */ +type CodingContractName = _ValueOf; export type CodingContractSignatures = { - [CodingContractName.FindLargestPrimeFactor]: [number, number]; - [CodingContractName.SubarrayWithMaximumSum]: [number[], number]; - [CodingContractName.TotalWaysToSum]: [number, number]; - [CodingContractName.TotalWaysToSumII]: [[number, number[]], number]; - [CodingContractName.SpiralizeMatrix]: [number[][], number[]]; - [CodingContractName.ArrayJumpingGame]: [number[], 1 | 0]; - [CodingContractName.ArrayJumpingGameII]: [number[], number]; - [CodingContractName.MergeOverlappingIntervals]: [[number, number][], [number, number][]]; - [CodingContractName.GenerateIPAddresses]: [string, string[]]; - [CodingContractName.AlgorithmicStockTraderI]: [number[], number]; - [CodingContractName.AlgorithmicStockTraderII]: [number[], number]; - [CodingContractName.AlgorithmicStockTraderIII]: [number[], number]; - [CodingContractName.AlgorithmicStockTraderIV]: [[number, number[]], number]; - [CodingContractName.MinimumPathSumInATriangle]: [number[][], number]; - [CodingContractName.UniquePathsInAGridI]: [[number, number], number]; - [CodingContractName.UniquePathsInAGridII]: [(1 | 0)[][], number]; - [CodingContractName.ShortestPathInAGrid]: [(1 | 0)[][], string]; - [CodingContractName.SanitizeParenthesesInExpression]: [string, string[]]; - [CodingContractName.FindAllValidMathExpressions]: [[string, number], string[]]; - [CodingContractName.HammingCodesIntegerToEncodedBinary]: [number, string]; - [CodingContractName.HammingCodesEncodedBinaryToInteger]: [string, number]; - [CodingContractName.Proper2ColoringOfAGraph]: [[number, [number, number][]], (1 | 0)[]]; - [CodingContractName.CompressionIRLECompression]: [string, string]; - [CodingContractName.CompressionIILZDecompression]: [string, string]; - [CodingContractName.CompressionIIILZCompression]: [string, string]; - [CodingContractName.EncryptionICaesarCipher]: [[string, number], string]; - [CodingContractName.EncryptionIIVigenereCipher]: [[string, string], string]; - [CodingContractName.SquareRoot]: [bigint, bigint, [string, string]]; + "Find Largest Prime Factor": [number, number]; + "Subarray with Maximum Sum": [number[], number]; + "Total Ways to Sum": [number, number]; + "Total Ways to Sum II": [[number, number[]], number]; + "Spiralize Matrix": [number[][], number[]]; + "Array Jumping Game": [number[], 1 | 0]; + "Array Jumping Game II": [number[], number]; + "Merge Overlapping Intervals": [[number, number][], [number, number][]]; + "Generate IP Addresses": [string, string[]]; + "Algorithmic Stock Trader I": [number[], number]; + "Algorithmic Stock Trader II": [number[], number]; + "Algorithmic Stock Trader III": [number[], number]; + "Algorithmic Stock Trader IV": [[number, number[]], number]; + "Minimum Path Sum in a Triangle": [number[][], number]; + "Unique Paths in a Grid I": [[number, number], number]; + "Unique Paths in a Grid II": [(1 | 0)[][], number]; + "Shortest Path in a Grid": [(1 | 0)[][], string]; + "Sanitize Parentheses in Expression": [string, string[]]; + "Find All Valid Math Expressions": [[string, number], string[]]; + "HammingCodes: Integer to Encoded Binary": [number, string]; + "HammingCodes: Encoded Binary to Integer": [string, number]; + "Proper 2-Coloring of a Graph": [[number, [number, number][]], (1 | 0)[]]; + "Compression I: RLE Compression": [string, string]; + "Compression II: LZ Decompression": [string, string]; + "Compression III: LZ Compression": [string, string]; + "Encryption I: Caesar Cipher": [[string, number], string]; + "Encryption II: Vigenère Cipher": [[string, string], string]; + "Square Root": [bigint, bigint, [string, string]]; }; export type CodingContractObject = { @@ -8841,19 +8850,19 @@ export type CodingContractObject = { }[keyof CodingContractSignatures]; /** @public */ -export type NSEnums = { - CityName: typeof CityName; - CrimeType: typeof CrimeType; - FactionWorkType: typeof FactionWorkType; - GymType: typeof GymType; - JobName: typeof JobName; - JobField: typeof JobField; - LocationName: typeof LocationName; - ToastVariant: typeof ToastVariant; - UniversityClassType: typeof UniversityClassType; - CompanyName: typeof CompanyName; - FactionName: typeof FactionName; - CodingContractName: typeof CodingContractName; +type NSEnums = { + CityName: CityNameEnumType; + CrimeType: CrimeEnumType; + FactionWorkType: FactionWorkEnumType; + GymType: GymEnumType; + JobName: JobNameEnumType; + JobField: JobFieldEnumType; + LocationName: LocationNameEnumType; + ToastVariant: ToastVariantEnumType; + UniversityClassType: UniversityClassEnumType; + CompanyName: CompanyNameEnumType; + FactionName: FactionNameEnumType; + CodingContractName: CodingContractNameEnumType; }; /** @@ -8876,7 +8885,7 @@ export interface OfficeAPI { * @param employeePosition - Position to place into. Defaults to "Unassigned". * @returns True if an employee was hired, false otherwise */ - hireEmployee(divisionName: string, city: CityName | `${CityName}`, employeePosition?: CorpEmployeePosition): boolean; + hireEmployee(divisionName: string, city: CityName, employeePosition?: CorpEmployeePosition): boolean; /** * Upgrade office size. @@ -8888,7 +8897,7 @@ export interface OfficeAPI { * @param city - Name of the city * @param size - Amount of positions to open */ - upgradeOfficeSize(divisionName: string, city: CityName | `${CityName}`, size: number): void; + upgradeOfficeSize(divisionName: string, city: CityName, size: number): void; /** * Throw a party for your employees. @@ -8901,7 +8910,7 @@ export interface OfficeAPI { * @param costPerEmployee - Amount to spend per employee. * @returns Multiplier for morale, or zero on failure */ - throwParty(divisionName: string, city: CityName | `${CityName}`, costPerEmployee: number): number; + throwParty(divisionName: string, city: CityName, costPerEmployee: number): number; /** * Buy tea for your employees. @@ -8913,7 +8922,7 @@ export interface OfficeAPI { * @param city - Name of the city * @returns true if buying tea was successful, false otherwise */ - buyTea(divisionName: string, city: CityName | `${CityName}`): boolean; + buyTea(divisionName: string, city: CityName): boolean; /** * Hire AdVert. @@ -8946,7 +8955,7 @@ export interface OfficeAPI { * @param city - Name of the city * @returns Office data */ - getOffice(divisionName: string, city: CityName | `${CityName}`): Office; + getOffice(divisionName: string, city: CityName): Office; /** * Get the cost to hire AdVert. @@ -9006,7 +9015,7 @@ export interface OfficeAPI { * @param amount - Number of employees to assign to that job * @returns true if the employee count reached the target amount, false if not */ - setAutoJobAssignment(divisionName: string, city: CityName | `${CityName}`, job: string, amount: number): boolean; + setAutoJobAssignment(divisionName: string, city: CityName, job: string, amount: number): boolean; /** * Get the cost to upgrade an office. @@ -9019,7 +9028,7 @@ export interface OfficeAPI { * @param size - Amount of positions to open * @returns Cost of upgrading the office */ - getOfficeSizeUpgradeCost(divisionName: string, city: CityName | `${CityName}`, size: number): number; + getOfficeSizeUpgradeCost(divisionName: string, city: CityName, size: number): number; } /** @@ -9043,13 +9052,7 @@ export interface WarehouseAPI { * @param amt - Amount to sell, can be "MAX" * @param price - Price to sell, can be "MP" */ - sellMaterial( - divisionName: string, - city: CityName | `${CityName}`, - materialName: string, - amt: string, - price: string, - ): void; + sellMaterial(divisionName: string, city: CityName, materialName: string, amt: string, price: string): void; /** * Set product sell data. @@ -9066,7 +9069,7 @@ export interface WarehouseAPI { */ sellProduct( divisionName: string, - city: CityName | `${CityName}`, + city: CityName, productName: string, amt: string, price: string, @@ -9094,7 +9097,7 @@ export interface WarehouseAPI { * @param city - Name of the city * @param enabled - Use true to enable, false otherwise. */ - setSmartSupply(divisionName: string, city: CityName | `${CityName}`, enabled: boolean): void; + setSmartSupply(divisionName: string, city: CityName, enabled: boolean): void; /** * Set whether smart supply uses leftovers before buying. @@ -9107,12 +9110,7 @@ export interface WarehouseAPI { * @param materialName - Name of the material * @param option - Smart supply option. Set "leftovers" to use leftovers, "imports" to use only imported materials, and "none" to not use stored materials. */ - setSmartSupplyOption( - divisionName: string, - city: CityName | `${CityName}`, - materialName: string, - option: CorpSmartSupplyOption, - ): void; + setSmartSupplyOption(divisionName: string, city: CityName, materialName: string, option: CorpSmartSupplyOption): void; /** * Set material buy data. @@ -9125,7 +9123,7 @@ export interface WarehouseAPI { * @param materialName - Name of the material * @param amt - Amount of material to buy */ - buyMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: string, amt: number): void; + buyMaterial(divisionName: string, city: CityName, materialName: string, amt: number): void; /** * Set material to bulk-buy. @@ -9138,7 +9136,7 @@ export interface WarehouseAPI { * @param materialName - Name of the material * @param amt - Amount of material to buy */ - bulkPurchase(divisionName: string, city: CityName | `${CityName}`, materialName: string, amt: number): void; + bulkPurchase(divisionName: string, city: CityName, materialName: string, amt: number): void; /** * Get warehouse data. @@ -9150,7 +9148,7 @@ export interface WarehouseAPI { * @param city - Name of the city * @returns Warehouse data */ - getWarehouse(divisionName: string, city: CityName | `${CityName}`): Warehouse; + getWarehouse(divisionName: string, city: CityName): Warehouse; /** * Get product data. @@ -9163,7 +9161,7 @@ export interface WarehouseAPI { * @param productName - Name of the product * @returns Product data */ - getProduct(divisionName: string, cityName: CityName | `${CityName}`, productName: string): Product; + getProduct(divisionName: string, cityName: CityName, productName: string): Product; /** * Get material data. @@ -9176,7 +9174,7 @@ export interface WarehouseAPI { * @param materialName - Name of the material * @returns Material data */ - getMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: string): Material; + getMaterial(divisionName: string, city: CityName, materialName: string): Material; /** * Set Market-TA1 for a material. @@ -9189,7 +9187,7 @@ export interface WarehouseAPI { * @param materialName - Name of the material * @param on - Use true to enable, false otherwise. */ - setMaterialMarketTA1(divisionName: string, city: CityName | `${CityName}`, materialName: string, on: boolean): void; + setMaterialMarketTA1(divisionName: string, city: CityName, materialName: string, on: boolean): void; /** * Set Market-TA2 for a material. @@ -9202,7 +9200,7 @@ export interface WarehouseAPI { * @param materialName - Name of the material * @param on - Use true to enable, false otherwise. */ - setMaterialMarketTA2(divisionName: string, city: CityName | `${CityName}`, materialName: string, on: boolean): void; + setMaterialMarketTA2(divisionName: string, city: CityName, materialName: string, on: boolean): void; /** * Set Market-TA1 for a product. @@ -9243,9 +9241,9 @@ export interface WarehouseAPI { */ exportMaterial( sourceDivision: string, - sourceCity: CityName | `${CityName}`, + sourceCity: CityName, targetDivision: string, - targetCity: CityName | `${CityName}`, + targetCity: CityName, materialName: string, amt: number | string, ): void; @@ -9264,9 +9262,9 @@ export interface WarehouseAPI { */ cancelExportMaterial( sourceDivision: string, - sourceCity: CityName | `${CityName}`, + sourceCity: CityName, targetDivision: string, - targetCity: CityName | `${CityName}`, + targetCity: CityName, materialName: string, ): void; @@ -9279,7 +9277,7 @@ export interface WarehouseAPI { * @param divisionName - Name of the division * @param city - Name of the city */ - purchaseWarehouse(divisionName: string, city: CityName | `${CityName}`): void; + purchaseWarehouse(divisionName: string, city: CityName): void; /** * Upgrade warehouse. @@ -9291,7 +9289,7 @@ export interface WarehouseAPI { * @param city - Name of the city * @param amt - Amount of upgrades. Defaults to 1. */ - upgradeWarehouse(divisionName: string, city: CityName | `${CityName}`, amt?: number): void; + upgradeWarehouse(divisionName: string, city: CityName, amt?: number): void; /** * Create a new product. @@ -9307,7 +9305,7 @@ export interface WarehouseAPI { */ makeProduct( divisionName: string, - city: CityName | `${CityName}`, + city: CityName, productName: string, designInvest: number, marketingInvest: number, @@ -9324,12 +9322,7 @@ export interface WarehouseAPI { * @param materialName - Name of the material. * @param qty - Amount to limit to. Pass a negative value to remove the limit instead. */ - limitMaterialProduction( - divisionName: string, - city: CityName | `${CityName}`, - materialName: string, - qty: number, - ): void; + limitMaterialProduction(divisionName: string, city: CityName, materialName: string, qty: number): void; /** * Limit product production. @@ -9342,7 +9335,7 @@ export interface WarehouseAPI { * @param productName - Name of the product. * @param qty - Amount to limit to. Pass a negative value to remove the limit instead. */ - limitProductProduction(divisionName: string, city: CityName | `${CityName}`, productName: string, qty: number): void; + limitProductProduction(divisionName: string, city: CityName, productName: string, qty: number): void; /** * Get the cost to upgrade a warehouse to the next level. @@ -9355,7 +9348,7 @@ export interface WarehouseAPI { * @param amt - Amount of upgrades. Optional. Defaults to 1. * @returns Cost to upgrade */ - getUpgradeWarehouseCost(divisionName: string, city: CityName | `${CityName}`, amt?: number): number; + getUpgradeWarehouseCost(divisionName: string, city: CityName, amt?: number): number; /** * Check if you have a warehouse in city. @@ -9365,19 +9358,22 @@ export interface WarehouseAPI { * * @returns true if warehouse is present, false if not. */ - hasWarehouse(divisionName: string, city: CityName | `${CityName}`): boolean; + hasWarehouse(divisionName: string, city: CityName): boolean; } /** * @public */ -declare enum CreatingCorporationCheckResult { - Success = "Success", - NoSf3OrDisabled = "NoSf3OrDisabled", - CorporationExists = "CorporationExists", - UseSeedMoneyOutsideBN3 = "UseSeedMoneyOutsideBN3", - DisabledBySoftCap = "DisabledBySoftCap", -} +type CreatingCorporationCheckResultEnumType = { + Success: "Success"; + NoSf3OrDisabled: "NoSf3OrDisabled"; + CorporationExists: "CorporationExists"; + UseSeedMoneyOutsideBN3: "UseSeedMoneyOutsideBN3"; + DisabledBySoftCap: "DisabledBySoftCap"; +}; + +/** @public */ +type CreatingCorporationCheckResult = _ValueOf; /** * Corporation API @@ -9591,7 +9587,7 @@ export interface Corporation extends WarehouseAPI, OfficeAPI { * @param divisionName - Name of the division * @param city - Name of the city */ - expandCity(divisionName: string, city: CityName | `${CityName}`): void; + expandCity(divisionName: string, city: CityName): void; /** * Unlock an upgrade.