BoatFacility

A value shape that methods take or return.

Group
player
Methods
None
Fields
6

Fields

FieldTypeDescription
hotspotnumberThe hotspot, 0 to 12.
kindBoatFacilityKindWhat the facility is.
occupiedbooleanWhether a player (any, not only you) is at it.
crewmateCrewmate?The crewmate stationed at it, nil for none.
stateBoatFacilityStateIts state.
objectTileObject?Its object on the deck, in the boat's world view, to interact with (facility.object:interact("Harvest")); nil when the deck shows none.…

Returned by

MethodReturnsDescription
BoardedBoat.facilities{ BoatFacility }The facilities in the boat's hotspots, each with its object on the deck.

Field details

object

object: TileObject?

Its object on the deck, in the boat's world view, to interact with (facility.object:interact("Harvest")); nil when the deck shows none. Objects pair with hotspots in the deck's order, so two hotspots holding the same facility may take each other's object, and with it each other's state.