Difference between revisions of "Callback: Ambient sound effects"
From GRFSpecs
Jump to navigationJump to search (grf version 8)  | 
				 (use new grf templates)  | 
				||
| Line 6: | Line 6: | ||
To decide whether to play a sound, and what sound to play, Var.Action 2 variable 10 holds the following information:  | 
  To decide whether to play a sound, and what sound to play, Var.Action 2 variable 10 holds the following information:  | 
||
| − | * {{  | 
  + | * {{grfTill|7}} For GRF version 7 and below: THRRxxxt  | 
| − | * {{  | 
  + | * {{grfFrom|8}} For GRF version 8 and above: xTHHRRtt  | 
{| |-  | 
  {| |-  | 
||
| Line 15: | Line 15: | ||
|-  | 
  |-  | 
||
|HH||  | 
  |HH||  | 
||
| − | {{  | 
  + | {{grfTill|7}} Height of north corner of tile (multiple of 8)<br/>  | 
| − | {{  | 
  + | {{grfFrom|8}} Height of lowest corner of tile (multiple of 1)  | 
|-  | 
  |-  | 
||
|RR||8 random bits  | 
  |RR||8 random bits  | 
||
| Line 24: | Line 24: | ||
|tt||  | 
  |tt||  | 
||
* Bits 0..2: Terrain type: 0 normal (grass), 1 desert, 2 rainforest, 4 on or above snowline.  | 
  * Bits 0..2: Terrain type: 0 normal (grass), 1 desert, 2 rainforest, 4 on or above snowline.  | 
||
| − | * Bits 3..5: {{  | 
  + | * Bits 3..5: {{grfFrom|8}} Water class: 0 - undefined / land; 1 - sea; 2 - canal; 3 - river.   | 
|}  | 
  |}  | 
||
Revision as of 13:32, 1 April 2012
Ambient sound effects (144)
This callback is a generic callback for feature 0C (new sounds) used for playing ambient sound effects.
The 15-bit return value is the sound effect number. Values from 0 to 72 (dec) are TTD's built-in sound effects, values beyond that refer to the sounds from Action 11.
To decide whether to play a sound, and what sound to play, Var.Action 2 variable 10 holds the following information:
- GRFv≤7 For GRF version 7 and below: THRRxxxt
 - GRFv≥8 For GRF version 8 and above: xTHHRRtt
 
| Field | Meaning | 
|---|---|
| T | Tile class, 0=bare land, 4=trees, 6=water | 
| HH | 
 GRFv≤7 Height of north corner of tile (multiple of 8)  | 
| RR | 8 random bits | 
| xxx | Reserved | 
| tt | 
  | 
This callback must be enabled by bit 4 in action D var 9E.