Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-09 17:23:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

DOCUMENTATION: Fix wrong description of ns.singularity.applyToCompany (#1561)

Browse Source
This commit is contained in:
catloversg 2024-08-14 05:28:02 +07:00 committed by GitHub
parent 23f98c1ff6
commit 5427ae71ca
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
markdown/bitburner.singularity.applytocompany.md
View File

@ -23,7 +23,7 @@ applyToCompany(companyName: CompanyName | `${CompanyName}`, field: JobField | `$
[JobName](./bitburner.jobname.md) \| null [JobName](./bitburner.jobname.md) \| null
True if the player successfully get a job/promotion, and false otherwise. Job name if the player successfully get a job/promotion, and null otherwise.
## Remarks ## Remarks
@ -31,5 +31,5 @@ RAM cost: 3 GB \* 16/4/1
This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at. This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at.
This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and don’t get one, the function will return false. This function will return the job name if you successfully get a job/promotion, and null otherwise. Note that if you are trying to use this function to apply for a promotion and don’t get one, the function will return null.

8
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -2046,13 +2046,13 @@ export interface Singularity {
* apply for promotions by specifying the company and field you are already * apply for promotions by specifying the company and field you are already
* employed at. * employed at.
* *
* This function will return true if you successfully get a job/promotion, * This function will return the job name if you successfully get a job/promotion,
* and false otherwise. Note that if you are trying to use this function to * and null otherwise. Note that if you are trying to use this function to
* apply for a promotion and don’t get one, the function will return false. * apply for a promotion and don’t get one, the function will return null.
* *
* @param companyName - Name of company to apply to. * @param companyName - Name of company to apply to.
* @param field - Field to which you want to apply. * @param field - Field to which you want to apply.
* @returns True if the player successfully get a job/promotion, and false otherwise. * @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 | `${CompanyName}`, field: JobField | `${JobField}`): JobName | null;