Merge pull request #1289 from Tryneus/patch-1

Clarify that `commitCrime` returns milliseconds, not seconds
This commit is contained in:
hydroflame 2021-09-17 12:12:27 -04:00 committed by GitHub
commit fd55155fea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -26,8 +26,8 @@ commitCrime() Netscript Function
This function is used to automatically attempt to commit crimes. If you are already in the middle of some 'working' action This function is used to automatically attempt to commit crimes. If you are already in the middle of some 'working' action
(such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings. (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.
This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the 'Rob Store' crime, This function returns the number of milliseconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the 'Rob Store' crime,
so running ``commitCrime('rob store')`` will return 60). so running ``commitCrime('rob store')`` will return 60000).
Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts.
Instead, I would use the :doc:`isBusy<isBusy>` Singularity function to check whether you have finished attempting a crime. Instead, I would use the :doc:`isBusy<isBusy>` Singularity function to check whether you have finished attempting a crime.