Difference between revisions of "NML:Canals"
From GRFSpecs
Jump to navigationJump to search (Move ID section to the top, add some usage notes) |
m (Changed the appropriate tables from t to sortable) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
The 'normal sprites' column contains the amount of sprites that should be provided for this feature. If the appropriate bit in the graphics_flags-property (see below) the amount of sprites stated in the 'alternative sprites' column must be provided instead. |
The 'normal sprites' column contains the amount of sprites that should be provided for this feature. If the appropriate bit in the graphics_flags-property (see below) the amount of sprites stated in the 'alternative sprites' column must be provided instead. |
||
| − | {| class=" |
+ | {| class="wikitable sortable" |
!name |
!name |
||
!use |
!use |
||
| Line 60: | Line 60: | ||
==Canal properties== |
==Canal properties== |
||
| − | item ( |
+ | item (FEAT_CANALS, item_name, id) { ... } |
{| class="t" |
{| class="t" |
||
| Line 71: | Line 71: | ||
| There is currently only one possible bit: <code style="color:darkgreen">WATERFEATURE_ALTERNATIVE_SPRITES</code> |
| There is currently only one possible bit: <code style="color:darkgreen">WATERFEATURE_ALTERNATIVE_SPRITES</code> |
||
|} |
|} |
||
| − | |||
== Canal variables == |
== Canal variables == |
||
| − | {| class=" |
+ | {| class="wikitable sortable" |
! name |
! name |
||
! value range |
! value range |
||
| Line 94: | Line 93: | ||
:In tropical climate only: some tiles in the mountains, distant from desert and sea |
:In tropical climate only: some tiles in the mountains, distant from desert and sea |
||
;TILETYPE_SNOW |
;TILETYPE_SNOW |
||
| + | |- |
||
| + | |dike_map |
||
| + | |bitmask(CANAL_DIRECTION_XXX, ...) |
||
| + | |{{ottdp|1.4|no|ottdrev=r25229}} bitmask of the directions where there is a dike: CANAL_DIRECTION_XXX where XXX: |
||
| + | ; along the grid: |
||
| + | :NORTHEAST = 0 |
||
| + | :SOUTHEAST = 1 |
||
| + | :SOUTHWEST = 2 |
||
| + | :NORTHWEST = 3 |
||
| + | ; vertical and horizontal: |
||
| + | :EAST = 4 |
||
| + | :SOUTH = 5 |
||
| + | :WEST = 6 |
||
| + | :NORTH = 7 |
||
|- |
|- |
||
|random_bits |
|random_bits |
||
Latest revision as of 20:56, 30 August 2022
Vehicles, Stations, Canals, Bridges, Towns, Houses, Industries (Tiles), Cargos, Airports+Tiles, Objects, Railtypes, Roadtypes, Tramtypes, Terrain
- common props | vars | CBs
- train | roadveh | ship | aircr props
- common variables
- industry props | vars | CBs
- tile props | vars | CBs
- airport props | vars | CBs
- tile props | vars | CBs
Canal ids
The used item ID defines what sprites this item provides. Item IDs should be picked from the following table (WF_XXX).
The 'normal sprites' column contains the amount of sprites that should be provided for this feature. If the appropriate bit in the graphics_flags-property (see below) the amount of sprites stated in the 'alternative sprites' column must be provided instead.
| name | use | normal sprites | alternative sprites |
|---|---|---|---|
| WF_WATERCLIFFS |  1.1  2.6 water for canals / locks
|
4 slope sprites | 1 flat ground sprite followed by 4 slope sprites |
| WF_LOCKS | 0.6 2.5 Locks
|
24 | undefined |
| WF_DIKES | 0.6 2.5 Dikes
|
12 | undefined |
| WF_CANAL_GUI |  2.5 Canal GUI
|
1 | undefined |
| WF_FLAT_DOCKS | 2.5 Flat docks
|
4 | undefined |
| WF_RIVER_SLOPE | 1.1 2.6 River water
|
4 | 1 flat ground sprite followed by 4 slope sprites |
| WF_RIVERBANKS | 0.6 2.6 Riverbanks
|
12*5 (Last 4 for slopes) | undefined |
| WF_RIVER_GUI | 2.6 River GUI
|
2 | undefined |
| WF_BUOY | 1.2  Buoy
|
1 | undefined |
Canal properties
item (FEAT_CANALS, item_name, id) { ... }
| name | value range | comment |
|---|---|---|
| graphic_flags | bitmask(flags) | There is currently only one possible bit: WATERFEATURE_ALTERNATIVE_SPRITES
|
Canal variables
| name | value range | comment |
|---|---|---|
| tile_height | 0 .. max_tile_height | NML 0.2 Tile height in pixels (=tiles * 8).
NML 0.3 Tile height in tiles. |
| terrain_type | TILETYPE_XXX |
|
| dike_map | bitmask(CANAL_DIRECTION_XXX, ...) | 1.4 bitmask of the directions where there is a dike: CANAL_DIRECTION_XXX where XXX:
|
| random_bits | 0 .. 255 | random bits of that tile |
Canal callbacks
| callback | return value | comment |
|---|---|---|
| default | spriteset | graphics for the canal id |
| sprite_offset | numeric offset into the spriteset for the canal id |
