Data structures returned by game.interface

A comprehensive overview over the data structures returned by game.interface.getEntity for different entity types

[h1]Entities[/h1]

Everything in the game of Transport Fever is an entity. This includes assets, industries, stations, vehicles, and even lines. To fetch information about them from the game interface, you can use the following methods:

game.interface.getEntities({pos, radius}, {type, includeData})
game.interface.getTowns()
game.interface.getLines({stationGroup})
game.interface.getVehicles({line, depot, carrier})
game.interface.getStations({town, townRadius, carrier})
game.interface.getDepots()

All of these functions return an id, which is an integer. You can get the data behind an ID with the function game.interface.getEntity(id). Depending on which type of entity is returned, the data structures are different. game.interface.getEntities allows you to instantly fetch the data together with the ID. Also, this function allows you to specify an entity type filter.

ASSET_GROUP

Note: Assets with valid groundFaces are by definition a construction and will appear in the list CONSTRUCTION instead of ASSET_GROUP.

Display Spoiler

CONSTRUCTION

Display Spoiler

Lua

{
    ["baseNodes"] = { --these ids don't show up anywhere
        [1] = 1605,
        [2] = 1618,
        [3] = 1636,
        [4] = 1647,
        [5] = 1865,
        [6] = 2112,
        [7] = 2322,
        [8] = 2611
    },
    ["transf"] = {
        [1] = 0.41026905179024,
        [2] = -0.9119645357132,
        [3] = 0,
        [4] = 0,
        [5] = 0.9119645357132,
        [6] = 0.41026905179024,
        [7] = 0,
        [8] = 0,
        [9] = 0,
        [10] = 0,
        [11] = 1,
        [12] = 0,
        [13] = -2280.1704101563, -- \
        [14] = -648.66674804688, -- | X-Y-Z Position of the constructions origin (differs from position!)
        [15] = 107.94593048096, --  /
        [16] = 1
    },
    ["params"] = { --all params with which the construction was built
        ["productionLevel"] = 0,
        ["seed"] = -17799 --Auto-incrementing, unique parameter which appears on every construction.
    },
    ["name"] = "Würzburg Wald", --Set by the game. Assets with ground faces have the name "no name".
    ["type"] = "CONSTRUCTION",
    ["particleSystems"] = {
        [1] = 16621  --these ids don't show up anywhere
    },
    ["stations"] = {
        [1] = 15095  --STATION
    },
    ["simBuildings"] = {
        [1] = 4331 --SIM_BUILDING
    },
    ["baseEdges"] = { --these ids don't show up anywhere
        [1] = 3257,
        [2] = 2870,
        [3] = 2772,
        [4] = 3434,
        [5] = 2787,
        [6] = 3235,
        [7] = 2793,
        [8] = 3164,
        [9] = 3019
    },
    ["townBuildings"] = 
        { 
            [1] = 24067 --these ids don't show up anywhere
        },
    ["position"] = { -- X-Y-Z Position of the center of the constructions bounding box
        [1] = -2280.1704101563,
        [2] = -648.66674804688,
        [3] = 114.10034942627
    },
    ["id"] = 4256,
    ["dateBuilt"] = {["year"] = 1900, ["day"] = 1, ["month"] = 4},
    ["fileName"] = "industry/forest.con",
    ["depots"] = {
        [1] = 13945 --VEHICLE_DEPOT
    }
}

Display More

LINE

Note: lines can't be fetched with the game.interface.getEntities-method. Use game.interface.getLines instead.

SIM_BUILDING

STATION_GROUP

STATION

TOWN

Lua

{
    ["lu2cargoInfo"] = {
        ["RESIDENTIAL"] = {
            ["rating"] = 0,
            ["productionRating"] = 0, --unused?
            ["cargo2productionAndNeeds"] = {}, --unused?
            ["cargo2supplyAndNeeds"] = {},
            ["supplyRating"] = 0
        },
        ["INDUSTRIAL"] = {
            ["rating"] = 0,
            ["productionRating"] = 0, --unused?
            ["cargo2productionAndNeeds"] = {}, --unused?
            ["cargo2supplyAndNeeds"] = {
                ["FUEL"] = {
                    [1] = 0,
                    [2] = 52
                },
                ["MACHINES"] = {
                    [1] = 0,
                    [2] = 52
                },
                ["CONSTRUCTION_MATERIALS"] = {
                    [1] = 0,
                    [2] = 52
                }
            },
            ["supplyRating"] = 0
        },
        ["COMMERCIAL"] = {
            ["rating"] = 0,
            ["productionRating"] = 0, --unused?
            ["cargo2productionAndNeeds"] = {}, --unused?
            ["cargo2supplyAndNeeds"] = {
                ["GOODS"] = {
                    [1] = 0,
                    [2] = 51
                },
                ["TOOLS"] = {
                    [1] = 0,
                    [2] = 51
                },
                ["FOOD"] = {
                    [1] = 0,
                    [2] = 51
                }
            },
            ["supplyRating"] = 0
        }
    },
    ["useLinesCounts"] = {
        ["COMMERCIAL"] = 0,
        ["INDUSTRIAL"] = 0
    },
    ["position"] = {
        [1] = -2260.474609375,
        [2] = 3209.8505859375,
        [3] = 139.69999694824
    },
    ["name"] = "Köwerich",
    ["id"] = 741,
    ["townDestCounts"] = {
        -- travel destination [destination town id] = number
        ["COMMERCIAL"] = {[741] = 174},
        ["INDUSTRIAL"] = {[741] = 182}
    },
    ["useLinesPercentage"] = 0,
    ["type"] = "TOWN",
    ["counts"] = {
        ["RESIDENTIAL"] = 183,
        ["INDUSTRIAL"] = 182,
        ["COMMERCIAL"] = 174
    }
}

Display More

VEHICLE_DEPOT

Display Spoiler

VEHICLE

Display Spoiler

Data structures returned by game.interface

Willkommen in der Transport Fever Community

Share