CargoHandle

A kind of good as defineCargo returns it: its name, which a record and the wire hold, and its settings. A value that touches no world: a world installs it from carrying({ kinds }).

Properties

Property	Modifier	Type	Description
[cargoHandleBrand]	readonly	true	A brand no other value carries, so a write and a filter take only what defineCargo made. A type alone.
name	readonly	string	-
settings	readonly	object	-
settings.container?	readonly	object	The container its goods ride in on a carrier’s stack, from defineCargoContainer. Left out, its goods stack loose.
settings.container.[cargoContainerHandleBrand]	readonly	true	A brand no other value carries, so a kind takes only what defineCargoContainer made. A type alone.
settings.container.name	readonly	string	-
settings.container.settings	readonly	object	-
settings.container.settings.capacity?	readonly	number	How many goods one container draws; the next good opens another container above it. It refuses nothing, which a carrier’s capacity does.
settings.container.settings.floor?	readonly	number	Metres up the container’s model, from its lowest point and before scale, that its goods stand on: its inner floor.
settings.container.settings.interior?	readonly	object	Where its goods sit inside it, in its model’s metres before scale, for a crate with handles, thick walls or an opening off its centre. A good wider or deeper than it throws in development.
settings.container.settings.interior.center?	readonly	readonly [number, number]	Its centre’s x and z in its model’s file, from the centre of the model’s bounds.
settings.container.settings.interior.depth	readonly	number	Metres along its model’s z.
settings.container.settings.interior.width	readonly	number	Metres across its model’s x.
settings.container.settings.model	readonly	string	The registered model the goods ride in, drawn once per container, such as an open crate or a basket.
settings.container.settings.scale?	readonly	number	The container’s size as a multiple of its model’s, its goods’ with it.
settings.displayName?	readonly	string	What a player reads for one good, such as “Lime juice”, on a HUD’s counter and in place of its picture until it comes.
settings.height?	readonly	number	Metres one good adds to a drawn stack.
settings.image?	readonly	string	A picture of one good for a HUD, by URL, such as “/assets/ui/lime.webp”.
settings.look?	readonly	(item) => string	The registered model one good draws as, from its data, such as a golden lime’s gold. Left out, every good draws model.
settings.model	readonly	string	The registered model a good of this kind draws as.
settings.tags?	readonly	readonly string[]	Words a station accepts it by: ["fruit"].