OpenTTD GameScript API: Class Hierarchy

OpenTTD GameScript API 12.0-beta1

Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12345]

C GSController | The Controller, the class each GS should extend
C GSInfo | 'Abstract' class of the GSs use to register themselves
▼CGSObject |
C GSAccounting | Class that keeps track of the costs, so you can request how much a block of commands did cost in total
C GSAdmin | Class that handles communication with the AdminPort
C GSAirport | Class that handles all airport related functions
C GSBase | Class that handles some basic functions
►C GSBaseStation | Base class for stations and waypoints
C GSStation | Class that handles all station related functions
C GSWaypoint | Class that handles all waypoint related functions
C GSBridge | Class that handles all bridge related functions
C GSCargo | Class that handles all cargo related functions
C GSCargoMonitor | Class that handles all cargo movement monitoring related functions
C GSClient | Class that handles all client related functions
C GSCompany | Class that handles all company related functions
C GSCompanyMode | Class to switch the current company
C GSDate | Class that handles all date related (calculation) functions
C GSEngine | Class that handles all engine related functions
C GSError | Class that handles all error related functions
►C GSEvent | Class that handles all event related functions
C GSEventAdminPort | Event Admin Port, indicating the admin port is sending you information
C GSEventCompanyBankrupt | Event Company Bankrupt, indicating a company has gone bankrupt
C GSEventCompanyInTrouble | Event Company In Trouble, indicating a company is in trouble and might go bankrupt soon
C GSEventCompanyMerger | Event Company Merger, indicating a company has been bought by another company
C GSEventCompanyNew | Event Company New, indicating a new company has been created
►C GSEventCompanyTown | Base class for events involving a town and a company
C GSEventExclusiveTransportRights | Event Exclusive Transport Rights, indicating that company bought exclusive transport rights in a town
C GSEventRoadReconstruction | Event Road Reconstruction, indicating that company triggered road reconstructions in a town
C GSEventGoalQuestionAnswer | Event Goal Question Answer, where you receive the answer given to your questions
C GSEventIndustryClose | Event Industry Close, indicating an industry is going to be closed
C GSEventIndustryOpen | Event Industry Open, indicating a new industry has been created
C GSEventStationFirstVehicle | Event Station First Vehicle, indicating a station has been visited by a vehicle for the first time
C GSEventStoryPageButtonClick | Event StoryPageButtonClick, indicating a player clicked a push button on a storybook page
C GSEventStoryPageTileSelect | Event StoryPageTileSelect, indicating a player clicked a tile selection button on a storybook page, and selected a tile
C GSEventStoryPageVehicleSelect | Event StoryPageTileSelect, indicating a player clicked a tile selection button on a storybook page, and selected a tile
C GSEventSubsidyAwarded | Event Subsidy Awarded, indicating a subsidy is awarded to some company
C GSEventSubsidyExpired | Event Subsidy Expired, indicating a route that was once subsidized no longer is
C GSEventSubsidyOffer | Event Subsidy Offered, indicating someone offered a subsidy
C GSEventSubsidyOfferExpired | Event Subsidy Offer Expired, indicating a subsidy will no longer be awarded
C GSEventTownFounded | Event Town Founded, indicating a new town has been created
C GSEventVehicleCrashed | Event Vehicle Crash, indicating a vehicle of yours is crashed
C GSEventWindowWidgetClick | Event Window Widget Click, when a user clicks on a highlighted widget
C GSEventController | Class that handles all event related functions
C GSExecMode | Class to switch current mode to Execute Mode
C GSGame | Class that handles some game related functions
C GSGameSettings | Class that handles all game settings related functions
C GSGoal | Class that handles some goal related functions
C GSIndustry | Class that handles all industry related functions
C GSIndustryType | Class that handles all industry-type related functions
C GSInfrastructure | Class that handles all company infrastructure related functions
►C GSList | Class that creates a list which can keep item/value pairs, which you can walk
C GSBridgeList | Create a list of bridges types
C GSBridgeList_Length | Create a list of bridges types that can be built on a specific length
C GSCargoList | Creates a list of cargoes that can be produced in the current game
C GSCargoList_IndustryAccepting | Creates a list of cargoes that the given industry accepts
C GSCargoList_IndustryProducing | Creates a list of cargoes that the given industry can produce
C GSCargoList_StationAccepting | Creates a list of cargoes that the given station accepts
C GSClientList | Creates a list of clients that are currently in game
C GSClientList_Company | Creates a list of clients that are playing in the company
C GSDepotList | Creates a list of the locations of the depots (and hangars) of which you are the owner
C GSEngineList | Create a list of engines based on a vehicle type
C GSIndustryList | Creates a list of industries that are currently on the map
C GSIndustryList_CargoAccepting | Creates a list of industries that accepts a given cargo
C GSIndustryList_CargoProducing | Creates a list of industries that can produce a given cargo
C GSIndustryTypeList | Creates a list of valid industry types
C GSNewGRFList | Create a list of loaded NewGRFs
C GSRailTypeList | Creates a list of all available railtypes
C GSRoadTypeList | Creates a list of all available roadtypes
C GSSignList | Create a list of signs your company has created
C GSStationList | Creates a list of stations of which you are the owner
►C GSStationList_Cargo | Creates a list of stations associated with cargo at a station
►C GSStationList_CargoPlanned | Creates a list of stations associated with cargo planned to pass a station
C GSStationList_CargoPlannedByFrom | Creates a list of origin stations of cargo planned to pass a station, with the monthly amounts of cargo planned for each of those origin stations as values
C GSStationList_CargoPlannedByVia | Creates a list of next hops of cargo planned to pass a station, with the monthly amounts of cargo planned for each of those next hops as values
C GSStationList_CargoPlannedFromByVia | Creates a list of next hops of cargo planned to pass a station and originating from another station, with the monthly amounts of cargo planned for each of those next hops as values
C GSStationList_CargoPlannedViaByFrom | Creates a list of origin stations of cargo planned to pass a station going via another station, with the monthly amounts of cargo planned for each of those origin stations as values
►C GSStationList_CargoWaiting | Creates a list of stations associated with cargo waiting at a station
C GSStationList_CargoWaitingByFrom | Creates a list of origin stations of waiting cargo at a station, with the amounts of cargo waiting from each of those origin stations as values
C GSStationList_CargoWaitingByVia | Creates a list of next hops of waiting cargo at a station, with the amounts of cargo waiting for each of those next hops as values
C GSStationList_CargoWaitingFromByVia | Creates a list of next hops of waiting cargo from a specific station at another station, with the amounts of cargo waiting for each of those next hops as values
C GSStationList_CargoWaitingViaByFrom | Creates a list of origin stations of cargo waiting at a station for a transfer via another station, with the amounts of cargo waiting from each of those origin stations as values
C GSStationList_Vehicle | Creates a list of stations which the vehicle has in its orders
C GSStoryPageElementList | Create a list of all story page elements
C GSStoryPageList | Create a list of all story pages
C GSSubsidyList | Creates a list of all current subsidies
►C GSTileList | Creates an empty list, in which you can add tiles
C GSTileList_IndustryAccepting | Creates a list of tiles that will accept cargo for the given industry
C GSTileList_IndustryProducing | Creates a list of tiles which the industry checks to see if a station is there to receive cargo produced by this industry
C GSTileList_StationType | Creates a list of tiles which have the requested StationType of the StationID
C GSTownEffectList | Creates a list of all TownEffects known in the game
C GSTownList | Creates a list of towns that are currently on the map
C GSVehicleList | Creates a list of vehicles of which you are the owner
C GSVehicleList_Depot | Creates a list of vehicles that have orders to a given depot
C GSVehicleList_SharedOrders | Creates a list of vehicles that share orders
C GSVehicleList_Station | Creates a list of vehicles that have orders to a given station
C GSWaypointList | Creates a list of waypoints of which you are the owner
C GSWaypointList_Vehicle | Creates a list of waypoints which the vehicle has in its orders
C GSLog | Class that handles all log related functions
C GSMap | Class that handles all map related functions
C GSMarine | Class that handles all marine related functions
C GSNewGRF | Class that handles all NewGRF related functions
C GSNews | Class that handles news messages
C GSOrder | Class that handles all order related functions
C GSPriorityQueue | Class that creates a queue which keeps its items ordered by an item priority
C GSRail | Class that handles all rail related functions
C GSRoad | Class that handles all road related functions
C GSSign | Class that handles all sign related functions
C GSStoryPage | Class that handles story page related functions
C GSSubsidy | Class that handles all subsidy related functions
C GSTestMode | Class to switch current mode to Test Mode
C GSTile | Class that handles all tile related functions
C GSTown | Class that handles all town related functions
C GSTunnel | Class that handles all tunnel related functions
C GSVehicle | Class that handles all vehicle related functions
C GSViewport | Class that manipulates the user's viewport
C GSWindow | Class that handles window interaction
▼CText |
C GSText | Class that handles all text related functions
▼CZeroedMemoryAllocator |
C GSText | Class that handles all text related functions