Main Page: Difference between revisions

From GRFSpecs
Jump to navigation Jump to search
Content deleted Content added
Initial TOC
Ishtar (talk | contribs)
link to badge labels page from NewGRF Commons section
 
(58 intermediate revisions by 11 users not shown)
Line 1: Line 1:
== Action0 ==
== Sprite types ==
;[[Action0]] - Defines new properties for anything added or changed by the NewGRF
Defines new graphics feature properties
:{| |-
* Action0General - Action 0 properties common to all vehicle types
|rowspan="5" align="center" style="width:3em"|'''0'''
* Action0Trains - Action 0 properties for trains
| [[Action0/Vehicles | Vehicles]]
* Action0RoadVehicles - Action 0 properties for road vehicles
| [[Action0/Vehicles/Trains | Trains]]
* Action0Ships - Action 0 properties for ships
| [[Action0/Vehicles/RoadVehicles | RoadVehicles]]
* Action0Planes - Action 0 properties for planes
| [[Action0/Vehicles/Ships | Ships]]
* Action0Stations - Action 0 properties for new stations
| [[Action0/Vehicles/Planes | Aircraft]]
* Action0Canals - Action 0 - Properties for canals / rivers
|-
* Action0Bridges - Defining properties of bridges
| [[Action0/Stations | Stations]]
* Action0Houses - Action 0 properties of houses
| [[Action0/Canals | Canals & Rivers]]
** DefaultHouseProps - Default property values for TTD's houses
| [[Action0/Bridges | Bridges]]
* Action0GeneralVariables - Action 0 properties for general variables
| [[Action0/Houses | Houses]]
* Action0IndustryTiles - Action 0 properties for industry tiles
| [[Action0/Global Settings | Global Settings]]
** IndustryTileDefaultProps - Default property values for TTD's industry tiles
|-
* Action0Industries - Action 0 properties for industries
| [[Action0/Industry Tiles | Industry Tiles]]
** IndustryDefaultProps - Default properties values for TTD's industries
| [[Action0/Industries | Industries]]
* Action0Cargos - Action 0 properties for cargo types
| [[Action0/Cargos | Cargos]]
** CargoDefaultProps - Default property values for TTD's cargo types
| [[Action0/Sound Effects | Sound Effects]]
* Action0SoundEffects - Action 0 properties for new sound effects
| [[Action0/Airports | Airports]]
* Action0Objects - Action 0 properties for new objects
|-
* Action0Railtypes - Action 0 properties for rail types
| ''Signals''
* Action0AirportTiles - Action 0 properties for airport tiles
| [[Action0/Objects | Objects]]
* Action0Airports - Action 0 properties for airports
| [[Action0/Railtypes | Railtypes]]
== Action1 ==
| [[Action0/Airport Tiles | Airport Tiles]]
Defines a set of real sprites
| [[Action0/Roadtypes | Roadtypes]]
== Action2 ==
|-
Defines graphics set IDs
| [[Action0/Tramtypes | Tramtypes]]
* Action2Vehicles - Defining set-IDs for vehicles
| [[Action0/Road Stops| Road Stops]]
* Action2Stations - Defining station set-IDs
| [[Action0/Badges | Badges]]
* Action2Canals - Defining an action2 for canals
| ''Towns''
* Action2HousesIndustryTiles - Defining an action 2 for houses, industry tiles and object
|
* Action2Industries - Defining the industry production callback
|}
* Action2Cargos - Defining set-IDs for cargos
;[[Action1]] - Defines one or more graphics sets
* Action2Objects - Action2 for Objects
;[[Action2]] - Defines graphics set IDs
* Action2Railtypes - Action2 for Railtypes
* Basic Action2
* VariationalAction2 - Variational Action 2
:{| |-
** VarAction2Advanced - Advanced features of Variational Action 2
|rowspan="5" align="center" style="width:3em"|'''2'''
** VarAction2Vehicles - Variational Action 2 Variables for Vehicles
|colspan=5| [[Action2/Vehicles | Vehicles]]
** VarAction2Stations - Variational Action 2 Variables for Stations
|-
** VarAction2Cities - Variational Action 2 Variables for Cities
| [[Action2/Stations | Stations]]
** VarAction2Canals - Variational Action 2 Variables for Canals
| [[Action2/Single Set | Canals & Rivers]]
** VarAction2Bridges - Variational Action 2 Variables for Bridges
| ''Bridges''
** VarAction2Houses - Variational Action 2 Variables for Houses
| [[Action2/Sprite Layout | Houses]]
** VarAction2IndustryTiles - Variational Action 2 Variables for Industry and Airport Tiles
| ''Global Settings''
** VarAction2Industries - Variational Action 2 Variables for Industries
|-
** VarAction2Cargos - Variational Action 2 Variables for cargos
| [[Action2/Sprite Layout | Industry Tiles]]
** VarAction2NewSignals - Variational Action 2 Variables for New Signals
| [[Action2/Industries | Industries]]
** VarAction2Objects - Variational Action 2 Variables for Objects
| [[Action2/Single Set | Cargos]]
** VarAction2Railtypes - Variational Action 2 for Railtypes
| [[Action2/Only Callback Failure | Sound Effects]]
* RandomAction2 - Randomized Action 2
| [[Action2/Single Set | Airports]]
* Callbacks - List of available callbacks
|-
== Action3 ==
| [[Action2/Only Callback Failure | Signals]]
Associates vehicles with graphics set IDs
| [[Action2/Sprite Layout | Objects]]
* Action3LiveryOverride - Change wagon livery to match the engine
| [[Action2/Single Set | Railtypes]]
== Action4 ==
| [[Action2/Sprite Layout | Airport Tiles]]
Defines text strings
| [[Action2/Single Set | Roadtypes]]
== Action5 ==
|-
Defines specific base graphics sets
| [[Action2/Single Set | Tramtypes]]
== Action6 ==
| [[Action2/Sprite Layout | Road Stops]]
Modifies the contents of the following sprite
| [[Action2/Single Set | Badges]]
== Action7 ==
| ''Towns''
Conditionally skips sprites or jumps to a label
|
* TTDPatchFlags - TTDPatch Flags for Action 7/9 Variable 85
|}
== Action8 ==
* [[VariationalAction2]] - A conditional switch that determines a [[Callbacks|callback]] result or chains to another Action 2
Defines GRF ID, Name and Description
: [[VarAction2Advanced]] - Advanced features of Variational Action 2
== Action9 ==
: [[GlobalVariables | Global Variables]]
(see action 7 above)
:{| |-
== ActionA ==
|rowspan="5" align="center" style="width:3em"|'''VA2'''
Modifies TTD base set sprites
|colspan=5| [[VariationalAction2/Vehicles | Vehicles]]
== ActionB ==
|-
Generates an error message
| [[VariationalAction2/Stations | Stations]]
== ActionC ==
| [[VariationalAction2/Canals | Canals & Rivers]]
Does nothing.
| [[VariationalAction2/Bridges | Bridges]]
== ActionD ==
| [[VariationalAction2/Houses | Houses]]
Assigns parameters and calculates results
| ''Global Settings''
* ReadingOtherGRFParameters - Reading another GRF file's parameters
|-
* ReadingPatchVariables
| [[VariationalAction2/Industry Tiles | Industry Tiles]]
* GRFResourceManagement - Preventing conflicts with limited resources
| [[VariationalAction2/Industries | Industries]]
== ActionE ==
| [[VariationalAction2/Cargos | Cargos]]
Deactivates a NewGRF file
| ''Sound Effects''
== ActionF ==
| [[VariationalAction2/Airports | Airports]]
Defines new town name styles
|-
== Action10 ==
| [[VariationalAction2/Signals | Signals]]
Defines GOTO label for action 7/9
| [[VariationalAction2/Objects | Objects]]
== Action11 ==
| [[VariationalAction2/Railtypes | Railtypes]]
Defines new sound data
| [[VariationalAction2/Airport Tiles | Airport Tiles]]
== Action12 ==
| [[VariationalAction2/Roadtypes | Roadtypes]]
Load font glyphs
|-
== Action13 ==
| [[VariationalAction2/Tramtypes | Tramtypes]]
Translates GRF-specific strings (TTDPatch only)
| [[VariationalAction2/Road Stops | Road Stops]]
== Action14 ==
| [[VariationalAction2/Badges | Badges]]
Static NewGRF Information (OpenTTD only)
| [[VariationalAction2/Towns | Towns]]
== RealSprites ==
|
Sprites that actually get drawn on the screen
|}
== RecolorSprites ==
* [[RandomAction2]] - A randomized Variational Action 2
Changing how other sprites are drawn
:{| |-
|rowspan="5" align="center" style="width:3em"|'''R'''
|colspan=5| [[RandomAction2#Vehicles | Vehicles]]
|-
| [[RandomAction2#Stations | Stations]]
| [[RandomAction2#Canals | Canals & Rivers]]
| ''Bridges''
| [[RandomAction2#Town_building_triggers | Houses]]
| ''Global Settings''
|-
| [[RandomAction2#Industry_tile_triggers | Industry Tiles]]
| [[RandomAction2#Industry_tile_triggers | Industries]]
| ''Cargos''
| ''Sound Effects''
| [[RandomAction2#Stations | Airports]]
|-
| ''Signals''
| [[RandomAction2#Objects | Objects]]
| [[RandomAction2#Rail_types | Railtypes]]
| [[RandomAction2#Stations | Airport Tiles]]
| [[RandomAction2#Road_types | Roadtypes]]
|-
| [[RandomAction2#Tram_types | Tramtypes]]
| [[RandomAction2#Road_stops | Road Stops]]
| ''Badges''
| ''Towns''
|
|}


* [[Callbacks]] - List of available callbacks


;[[Action3]] - Associates Action 2s with an Action 0
== Getting started with media wiki ==
:{| |-
Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
|rowspan="5" align="center" style="width:3em"|'''3'''
* [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
|colspan=5| [[Action3 | Vehicles]]
* [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
|-
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
| [[Action3 | Stations]]
| [[Action3/Canals | Canals & Rivers]]
| ''Bridges''
| [[Action3 | Houses]]
| ''Global Settings''
|-
| [[Action3 | Industry Tiles]]
| [[Action3 | Industries]]
| [[Action3 | Cargos]]
| [[Action3 | Sound Effects]]
| [[Action3 | Airports]]
|-
| [[Action3 | Signals]]
| [[Action3 | Objects]]
| [[Action3/Railtypes | Railtypes]]
| [[Action3 | Airport Tiles]]
| [[Action3/Roadtypes | Roadtypes]]
|-
| [[Action3/Tramtypes | Tramtypes]]
| [[Action3 | Road Stops]]
| [[Action3/Badges | Badges]]
| ''Towns''
|
|}
: [[Action3LiveryOverride]] - Change wagon livery to match the engine
;[[Action4]] - Defines text strings
;[[Action5]] - Replaces base set sprites not present in the original TTD.
;[[Action6]] - Modifies the contents of the following sprite
;[[Action7]] - Conditionally skips sprites or jumps to a label
: [[TTDPatchFlags| GameConfigFlags]] - Configuration flags for Action 7/9 Variable 85
;[[Action8]] - Defines GRFID, Name and Description
;[[Action9]] - (see action 7 above)
;[[ActionA]] - Replaces TTD base set sprites
;[[ActionB]] - Generates an error message
;[[ActionC]] - Does nothing (can be used to embed comments)
;[[ActionD]] - Assigns parameters and calculates results
* [[ReadingOtherGRFParameters]] - Reading another GRF file's parameters
* [[ReadingPatchVariables| ReadingGameSettings]] - Reading game configuration settings
* [[GRFResourceManagement]] - Preventing conflicts with limited resources
;[[ActionE]] - Deactivates a NewGRF file
;[[ActionF]] - Defines new town name styles
;[[Action10]] - Defines a label for action 7/9
;[[Action11]] - Defines new sounds
;[[Action12]] - Adds Unicode font glyphs
;[[Action13]] - Translates GRF-specific strings
;[[Action14]] - Static NewGRF information (OpenTTD only)
;[[RealSprites]] - Sprites that actually are drawn on the screen
;[[RecolorSprites]] - Changing other sprites' colors

== Graphics properties ==
* [[PalettesAndCoordinates#Palettes | Palettes]] - Palettes used by the game
* [[PalettesAndCoordinates#Coordinates | Coordinates]] - Coordinates used for sprite alignement

== TTD defaults ==
* [[DefaultHouseProps]] - Default property values for TTD's houses
* [[IndustryTileDefaultProps]] - Default property values for TTD's industry tiles
* [[IndustryDefaultProps]] - Default properties values for TTD's industries
* [[CargoDefaultProps]] - Default property values for TTD's cargo types
* [[VehicleIDs]] - Default vehicle IDs
* [[NML:Default_Vehicle_Properties]] - Default Vehicle Properties (NML)
* [[AirportTypes]] - Default Airport IDs
* [[AirportTileDefaultProps]] - Default airport tile properties

== NewGRF commons ==
* [[Action0Cargos#CargoClasses_.2816.29 | Cargo classes]] - Commonly used cargo classes
* [[CargoTypes | Cargo labels]] - Commonly used cargo labels
* [[ObjectLabels | Object classes]] - Commonly used object clases
* [[TracktypeLabels | Rail/road/tram type labels]] - Commonly used labels for rail/road/tram types
* [[Badge labels]] - Commonly used badge labels

== Misc ==
* [[Features]] - List of all features and feature-specific actions.
* [[BaseCosts | Base Costs]]
* [[VehicleRefitting | Vehicle Refitting]]
* [[GrfLoadingStages | GRF loading stages]]
* [[GlobalVariables | Global variables]]
* [[Storages | Storages]]
* [[StringCodes | String control codes]]
* [[TextIDs | Text IDs (TTD + TTDPatch + NewGRF defined)]]
* [[GRFActionsDetailed | Syntax details]]
* [[Version numbers | Types of version numbers used throughout the specs]]
* [[DebuggingGRFCode | Debugging NewGRFs]]
* [[SpriteErrors | TTDPatch error codes on loading NewGRFs]]
* [[GRFv9 | GRFv9 Proposals]]
* [https://wiki.openttd.org/en/Development/NewGRF/Specification%20Status Specification Status]

== Game mechanics ==
* [[TownZones | Town zones]]
* [[NMLMain | NML]]

Latest revision as of 20:11, 10 March 2026

Sprite types

Action0 - Defines new properties for anything added or changed by the NewGRF
0 Vehicles Trains RoadVehicles Ships Aircraft
Stations Canals & Rivers Bridges Houses Global Settings
Industry Tiles Industries Cargos Sound Effects Airports
Signals Objects Railtypes Airport Tiles Roadtypes
Tramtypes Road Stops Badges Towns
Action1 - Defines one or more graphics sets
Action2 - Defines graphics set IDs
  • Basic Action2
2 Vehicles
Stations Canals & Rivers Bridges Houses Global Settings
Industry Tiles Industries Cargos Sound Effects Airports
Signals Objects Railtypes Airport Tiles Roadtypes
Tramtypes Road Stops Badges Towns
VarAction2Advanced - Advanced features of Variational Action 2
Global Variables
VA2 Vehicles
Stations Canals & Rivers Bridges Houses Global Settings
Industry Tiles Industries Cargos Sound Effects Airports
Signals Objects Railtypes Airport Tiles Roadtypes
Tramtypes Road Stops Badges Towns
R Vehicles
Stations Canals & Rivers Bridges Houses Global Settings
Industry Tiles Industries Cargos Sound Effects Airports
Signals Objects Railtypes Airport Tiles Roadtypes
Tramtypes Road Stops Badges Towns
Action3 - Associates Action 2s with an Action 0
3 Vehicles
Stations Canals & Rivers Bridges Houses Global Settings
Industry Tiles Industries Cargos Sound Effects Airports
Signals Objects Railtypes Airport Tiles Roadtypes
Tramtypes Road Stops Badges Towns
Action3LiveryOverride - Change wagon livery to match the engine
Action4 - Defines text strings
Action5 - Replaces base set sprites not present in the original TTD.
Action6 - Modifies the contents of the following sprite
Action7 - Conditionally skips sprites or jumps to a label
GameConfigFlags - Configuration flags for Action 7/9 Variable 85
Action8 - Defines GRFID, Name and Description
Action9 - (see action 7 above)
ActionA - Replaces TTD base set sprites
ActionB - Generates an error message
ActionC - Does nothing (can be used to embed comments)
ActionD - Assigns parameters and calculates results
ActionE - Deactivates a NewGRF file
ActionF - Defines new town name styles
Action10 - Defines a label for action 7/9
Action11 - Defines new sounds
Action12 - Adds Unicode font glyphs
Action13 - Translates GRF-specific strings
Action14 - Static NewGRF information (OpenTTD only)
RealSprites - Sprites that actually are drawn on the screen
RecolorSprites - Changing other sprites' colors

Graphics properties

TTD defaults

NewGRF commons

Misc

Game mechanics