PortTask

A value shape that methods take or return.

Group
player
Methods
None
Fields
17

Fields

FieldTypeDescription
slotnumberThe task slot, 0 to 4.
idnumberThe task's id.
namestringIts name.
kindPortTaskKindA courier or a bounty task.
levelnumberThe Sailing level it needs.
startingDock?The dock it starts at; nil when the game's table leaves it out.
cargoPortDock?The dock the cargo is collected at; nil when the table leaves it out.
endingDock?The dock it ends at; nil when the table leaves it out.
cancellablebooleanWhether it can be cancelled: the task's own setting, else the game's default (it can).
facilitiesRequired{ PortTaskFacility }The facilities the boat must have; empty when the game's table names none (the client's copy of the table holds none today).
facilitiesRecommended{ PortTaskFacility }The facilities the task recommends; empty as facilitiesRequired is.
deliveryObjectnumber?The item delivered; nil when the game's table names none (the client's copy holds none today).
cargoPortTaskItem?The cargo to deliver; nil when there is none.
bountyTargetnumber?The NPC to defeat in a bounty task.
bountyObjectPortTaskItem?The item a bounty task collects, and how many.
takennumberHow much cargo has been taken.
deliverednumberHow much cargo has been delivered.

Returned by

MethodReturnsDescription
Sailing.portTasks{ PortTask }The port tasks the player holds, by slot.