Difference between revisions of "NML:Replace TTD sprites"

From GRFSpecs
Jump to navigationJump to search
(add nav template)
(Add base_graphics block, too as it follows the exact same syntax)
Line 1: Line 1:
 
{{NMLNavBlocksyntax}}
 
{{NMLNavBlocksyntax}}
   
Using a <code style="color:darkgreen">replace</code> block, it is possible to replace TTD's built-in sprites. The syntax is as follows:
+
Using a <code style="color:darkgreen">replace</code> block, it is possible to replace TTD's built-in sprites or for base grfs to define sprites via the <code style="color:darkgreen">base_graphics</code> block. The syntax is as follows:
   
 
replace(&lt;sprite-id&gt;, &lt;image-file&gt;) {
 
replace(&lt;sprite-id&gt;, &lt;image-file&gt;) {
 
[[#real sprites|list of realsprites]]
 
[[#real sprites|list of realsprites]]
 
}
 
}
  +
  +
and
  +
  +
base_graphics(&lt;sprite-id&gt;, &lt;image-file&gt;) {
  +
[[#real sprites|list of realsprites]]
  +
}
  +
  +
respectively
   
 
The first parameter <code style="color:darkgreen">&lt;sprite-id&gt;</code> indicates the sprite number of the first sprite to replace. Sprite numbers are equal to the sprite numbers in the base graphics file. The [http://mz.openttdcoop.org/opengfx/authors/script.php?feature=spritesbyfile&q=ogfx1_base OpenGFX author overview] can be used as a reference to look up these sprite numbers. The second parameter <code style="color:darkgreen">&lt;image-file&gt;</code> specifies the image file that contains the new sprites. A series of real sprites has to be specified between the curly braces (<code style="color:darkgreen">{</code> and <code style="color:darkgreen">}</code>). The first sprite in this list replaces the sprite with id <code style="color:darkgreen">sprite-id</code>, the second replaces <code style="color:darkgreen">sprite-id + 1</code> and so on. Sprite templates can be used as well. For example:
 
The first parameter <code style="color:darkgreen">&lt;sprite-id&gt;</code> indicates the sprite number of the first sprite to replace. Sprite numbers are equal to the sprite numbers in the base graphics file. The [http://mz.openttdcoop.org/opengfx/authors/script.php?feature=spritesbyfile&q=ogfx1_base OpenGFX author overview] can be used as a reference to look up these sprite numbers. The second parameter <code style="color:darkgreen">&lt;image-file&gt;</code> specifies the image file that contains the new sprites. A series of real sprites has to be specified between the curly braces (<code style="color:darkgreen">{</code> and <code style="color:darkgreen">}</code>). The first sprite in this list replaces the sprite with id <code style="color:darkgreen">sprite-id</code>, the second replaces <code style="color:darkgreen">sprite-id + 1</code> and so on. Sprite templates can be used as well. For example:

Revision as of 22:47, 6 October 2011

Block Syntax

Using a replace block, it is possible to replace TTD's built-in sprites or for base grfs to define sprites via the base_graphics block. The syntax is as follows:

replace(<sprite-id>, <image-file>) {
	list of realsprites
}

and

base_graphics(<sprite-id>, <image-file>) {
	list of realsprites
}

respectively

The first parameter <sprite-id> indicates the sprite number of the first sprite to replace. Sprite numbers are equal to the sprite numbers in the base graphics file. The OpenGFX author overview can be used as a reference to look up these sprite numbers. The second parameter <image-file> specifies the image file that contains the new sprites. A series of real sprites has to be specified between the curly braces ({ and }). The first sprite in this list replaces the sprite with id sprite-id, the second replaces sprite-id + 1 and so on. Sprite templates can be used as well. For example:

 // Rail overlays for crossings
 replace (1005, "src/gfx/rails_overlays.png") {
 		[ 20,198, 40,21, -20,  5]
 		[ 71,198, 40,21, -20,  5]
 		[117,198, 40, 7, -20,  5]
 		[165,198, 40, 7, -20, 21]
 		[216,198, 12,19,  10,  5]
 		[248,198, 12,19, -24, 11]
 }