bitburner-src/markdown/bitburner.sleeve.travel.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

753 B

Home > bitburner > sleeve > travel

sleeve.travel() method

Make a sleeve travel to another city.

Signature:

travel(sleeveNumber: number, cityName: string): boolean;

Parameters

Parameter Type Description
sleeveNumber number Index of the sleeve to travel.
cityName string Name of the destination city.

Returns:

boolean

True if the sleeve reached destination, false otherwise.

Remarks

RAM cost: 4 GB

Return a boolean indicating whether or not the sleeve reached destination.