bitburner-src/bitburner.codingcontract.attempt.md at f266906f6ff93c2c6984dcff9b23cbcddb0a6c9f

mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-22 15:43:49 +01:00

CONTRACT: codingcontract.attempt always returns a string (#231 )

* 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

2022-11-28 09:15:09 -05:00

1.4 KiB

Raw Blame History

Home > bitburner > CodingContract > attempt

CodingContract.attempt() method

Attempts a coding contract, returning a reward string on success or empty string on failure.

Signature:

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.

Returns:

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

// NS1
var reward = codingcontract.attempt(yourSolution, filename, hostname);
if (reward) {
  tprint("Contract solved successfully! Reward: " + reward)
} else tprint("Failed to solve contract.")

Example 2

// NS2
const reward = codingcontract.attempt(yourSolution, filename, hostname);
if (reward) {
  ns.tprint(`Contract solved successfully! Reward: ${reward}`)
} else ns.tprint("Failed to solve contract.")

1.4 KiB Raw Blame History