Module protocol
Scripting interface protocol objects.
Tables
Date | Date. |
CargoType | Cargo type. |
Zone | Zone. |
Circle2 | 2D circle. |
Path | Path. |
GameTime | Game time and date. |
Journal | Journal. |
Marker | Marker. |
GetEntitiesFilter | Filter object for game.interface.getEntities. |
GetStationsFilter | Filter object for game.interface.getStations. |
GetLinesFilter | Filter object for game.interface.getLines. |
GetVehiclesFilter | Filter object for game.interface.getVehicles. |
Tables
- Date
-
Date.
Fields:
- year int year
- month int month
- day int day
- CargoType
-
Cargo type.
Fields:
- Zone
-
Zone.
Fields:
- polygon {vec2,...} list of vertices
- draw bool whether to draw zone or not
- drawColor vec4 color
- buildToolMode string effect on build/construction tools
- Circle2
-
2D circle.
Fields:
- pos vec2 position
- radius number radius
- Path
-
Path.
Fields:
- length number path length
- GameTime
-
Game time and date.
Fields:
- time number time [s]
- date protocol.Date date
- Journal
-
Journal.
Fields:
- Marker
-
Marker.
Fields:
- type string marker type
- entity int ID of entity where marker is attached (optional)
- pos vec3 marker position (optional)
- GetEntitiesFilter
-
Filter object for game.interface.getEntities.
Fields:
- includeData bool whether to include entity data or not
- type string entity type (optional)
- GetStationsFilter
-
Filter object for game.interface.getStations.
Fields:
- town int town entity ID
- townRadius number town radius (optional)
- carrier string carrier (optional)
- GetLinesFilter
-
Filter object for game.interface.getLines.
Fields:
- stationGroup int station group entity ID (optional)
- GetVehiclesFilter
-
Filter object for game.interface.getVehicles.
Fields:
- line int line entity ID (optional)
- depot int depot entity ID (optional)
- carrier string carrier (optional)