felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-16 22:38:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

work to make documentation unified.

Browse Source
This commit is contained in:
Olivier Gagnon
2021-03-12 02:51:56 -05:00
parent a00c253dcb
commit 2ce6ff2041
176 changed files with 1325 additions and 916 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/netscript/codingcontractapi/attempt.rst
View File

@@ -1,22 +1,27 @@
attempt() Netscript Function
============================
.. js:function:: attempt(answer, fn[, hostname/ip=current ip, opts={}])
.. js:function:: attempt(answer, filename[, hostname=current hostname[, opts={}]])
:RAM cost: 10 GB
:param answer: Solution for the contract
:param string fn: Filename of the contract
:param string hostname/ip: Hostname or IP of the server containing the contract.
:param string filename: Filename of the contract
:param string hostname: Hostname of the server containing the contract.
Optional. Defaults to current server if not provided
:param object opts: Optional parameters for configuring function behavior. Properties:
* returnReward (*boolean*) If truthy, then the function will return a string
that states the contract's reward when it is successfully solved.
:returns: ``true`` if the solution was correct. If the :code:`returnReward`
option is configured, then the function will instead return a
string. If the contract is successfully solved, the string will
contain a description of the contract's reward. Otherwise, it will
be an empty string.
Attempts to solve the Coding Contract with the provided solution.
:returns: Boolean indicating whether the solution was correct. If the :code:`returnReward`
option is configured, then the function will instead return a string. If the
contract is successfully solved, the string will contain a description of the
contract's reward. Otherwise, it will be an empty string.
Example:
:RAM cost: 10 GB
.. code-block:: javascript
codingcontract.attempt("myanswer!", "contract-123.cct", "home");