mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-17 06:48:42 +02:00
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
92 lines
1.8 KiB
Markdown
92 lines
1.8 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [createProgram](./bitburner.singularity.createprogram.md)
|
|
|
|
## Singularity.createProgram() method
|
|
|
|
Create a program.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
createProgram(program: string, focus?: boolean): boolean;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
program
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Name of program to create.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
focus
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Acquire player focus on this program creation. Optional. Defaults to true.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
boolean
|
|
|
|
True if you successfully start working on the specified program, and false otherwise.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 5 GB \* 16/4/1
|
|
|
|
This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings.
|
|
|
|
This function returns true if you successfully start working on the specified program, and false otherwise.
|
|
|
|
Note that creating a program using this function has the same hacking level requirements as it normally would. You can call [getHackingLevelRequirementOfProgram](./bitburner.singularity.gethackinglevelrequirementofprogram.md) to get that value.
|
|
|
|
## Example
|
|
|
|
|
|
```js
|
|
const programName = "BruteSSH.exe";
|
|
const success = ns.singularity.createProgram(programName);
|
|
if (!success) ns.tprint(`ERROR: Failed to start working on ${programName}`);
|
|
```
|
|
|