mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-13 11:13:50 +01:00
837c6bd1c2
* ns.codingcontract always returns a string (reward on success, empty on fail), simplifying usage and documentation of function. * Because of the above, return value still works when used as a boolean, as long as no direct equality comparison to true/false. * Documentation expanded and examples added. Co-authored by @quacksouls
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [attempt](./bitburner.codingcontract.attempt.md)
|
|
|
|
## CodingContract.attempt() method
|
|
|
|
Attempts a coding contract, returning a reward string on success or empty string on failure.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
attempt(answer: string | number | any[], filename: string, host?: string): string;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| answer | string \| number \| any\[\] | Attempted solution for the contract. |
|
|
| filename | string | Filename of the contract. |
|
|
| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. |
|
|
|
|
<b>Returns:</b>
|
|
|
|
string
|
|
|
|
A reward description string on success, or an empty string on failure.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 10 GB
|
|
|
|
Attempts to solve the Coding Contract with the provided solution.
|
|
|
|
## Example 1
|
|
|
|
|
|
```js
|
|
// NS1
|
|
var reward = codingcontract.attempt(yourSolution, filename, hostname);
|
|
if (reward) {
|
|
tprint("Contract solved successfully! Reward: " + reward)
|
|
} else tprint("Failed to solve contract.")
|
|
```
|
|
|
|
## Example 2
|
|
|
|
|
|
```js
|
|
// NS2
|
|
const reward = codingcontract.attempt(yourSolution, filename, hostname);
|
|
if (reward) {
|
|
ns.tprint(`Contract solved successfully! Reward: ${reward}`)
|
|
} else ns.tprint("Failed to solve contract.")
|
|
```
|
|
|