API Reference¶
This page is a high-level reference for the main public components.
CargoType¶
ScriptableObject that represents one cargo resource.
Common fields:
- display name
- icon
- stack or storage settings
CargoInventory¶
Serializable inventory used by nodes and vehicles.
Used for:
- capacity
- stored cargo items
- adding cargo
- removing cargo
- checking available amounts
CargoNode¶
Main location component.
Responsibilities:
- cargo storage
- initial requests
- stage progression
- production rules
- storage-only behavior
- events
Important events:
On Initial Request CompletedOn Stage CompletedOn Inventory Changed
CargoRoute¶
Route definition and route visual builder.
Responsibilities:
- route stop list
- loop setting
- transport mode
- smart rail visual generation
- simple sea and air route visuals
- movement waypoint generation
Useful context menu actions:
Build Smart Rail VisualsBuild Simple Route VisualsClear Rail Visuals
CargoRouteStop¶
Per-stop route configuration.
Important fields:
- node
- load mode
- loaded cargo visual prefab
- cargo to load
- unload cargo wanted by node
- cargo to unload
CargoRouteLoadRule¶
Defines a cargo type to load at a stop.
Fields:
- cargo
- max load amount
- loaded cargo visual prefab
CargoRouteUnloadRule¶
Defines a cargo type to unload at a stop.
Fields:
- cargo
- unload percent
CargoTransportAgent¶
Vehicle controller for route following and cargo transfer.
Responsibilities:
- move between route stops
- load cargo
- unload cargo
- update cargo visuals
- ping-pong on non-loop routes
CargoRailConnectionPoint¶
Defines route entry and exit positions for a node.
Fields:
- connection name
- transport mode
- role: Auto, Start, End
CargoNodeWorldUI¶
Optional world-space UI for node status.
Shows:
- requests
- storage
- production
CargoTransportWorldUI¶
Optional world-space UI for vehicle cargo.
Shows:
- carried cargo
- carried amounts
CargoNodeGrowthScatter¶
Optional visual growth helper.
Use it to spawn houses, props, or visual details when stages are completed.