Difference between revisions of "ImagePathFunctions"
From The Battle for Wesnoth Wiki
m |
|||
| Line 1: | Line 1: | ||
| − | Image Path Functions provide a simple method for WML coders to alter the way their specified images will be displayed in the game. All of the function parameters are included at the end of an image path and should not contain any spaces or special characters | + | Image Path Functions provide a simple method for WML coders to alter the way their specified images will be displayed in the game. All of the function parameters are included at the end of an image path and should not contain any spaces or special characters (other than those specified here). |
== Team-Color Function == | == Team-Color Function == | ||
| + | In Wesnoth version 1.2, the only Image Path Function is '''~TC()''', which takes two comma-separated parameters: the team number and the source color palette. The valid values for both of these parameters are defined in the file ''data/team-colors.cfg'' | ||
| + | |||
| + | === Syntax === | ||
'''~TC(''' ''team number'' ''',''' ''source color palette'' ''')''' | '''~TC(''' ''team number'' ''',''' ''source color palette'' ''')''' | ||
| − | *''team number'' - this is the first parameter, a number 1-9 signifying the team number of a unit. Number 1 typically means the red team, 2 typically means the blue team, | + | *''team number'' - this is the first parameter, a number 1-9 signifying the team number of a unit. Number 1 typically means the red team, 2 typically means the blue team, and so on (unless the scenario color settings for any side have been altered). |
*''source color palette'' - the second parameter is a source color palette, usually magenta. Do not surround this parameter with quotes. | *''source color palette'' - the second parameter is a source color palette, usually magenta. Do not surround this parameter with quotes. | ||
| + | === Example === | ||
In the following example, the elvish captain image is given the team color for team 3, making his magenta regions turn a healthy shade of green: | In the following example, the elvish captain image is given the team color for team 3, making his magenta regions turn a healthy shade of green: | ||
[message] | [message] | ||
| Line 12: | Line 16: | ||
message=_ "Now I am on the green team." | message=_ "Now I am on the green team." | ||
[/message] | [/message] | ||
| + | |||
| + | == Re-Color Function == | ||
| + | {{DevFeature}} May be used to change some colors in an image | ||
| + | === Syntax === | ||
| + | '''~RC(''' ''source color palette'' '''>''' ''color range ID'' ''')''' | ||
| + | *''source color palette'' - the first parameter is a source color palette, usually magenta. Do not surround this parameter with quotes. | ||
| + | *''color range ID'' - this is the second parameter, a number 1-9 signifying the ID of a color range defined in the file ''data/team-colors.cfg'' (or it may be a custom ID for a color range defined locally). | ||
| + | |||
| + | == Flip Function == | ||
| + | {{DevFeature}} May be used to flip an image horizontally and/or vertically | ||
| + | === Syntax === | ||
| + | '''~FL(''' ''optional argument list'' ''')''' | ||
| + | *''vertical'' - if the string "vert" is found anywhere in the argument list, the image will be flipped vertically. | ||
| + | *''horizontal'' - if the string "horiz" is found anywhere in the argument list, the image will be flipped horizantally. | ||
| + | *if the argument list is empty, the image will only be flipped horizantally. | ||
Revision as of 04:40, 15 February 2007
Image Path Functions provide a simple method for WML coders to alter the way their specified images will be displayed in the game. All of the function parameters are included at the end of an image path and should not contain any spaces or special characters (other than those specified here).
Contents
Team-Color Function
In Wesnoth version 1.2, the only Image Path Function is ~TC(), which takes two comma-separated parameters: the team number and the source color palette. The valid values for both of these parameters are defined in the file data/team-colors.cfg
Syntax
~TC( team number , source color palette )
- team number - this is the first parameter, a number 1-9 signifying the team number of a unit. Number 1 typically means the red team, 2 typically means the blue team, and so on (unless the scenario color settings for any side have been altered).
- source color palette - the second parameter is a source color palette, usually magenta. Do not surround this parameter with quotes.
Example
In the following example, the elvish captain image is given the team color for team 3, making his magenta regions turn a healthy shade of green:
[message]
speaker=narrator
image=units/elves-wood/captain.png~TC(3,magenta)
message=_ "Now I am on the green team."
[/message]
Re-Color Function
Template:DevFeature May be used to change some colors in an image
Syntax
~RC( source color palette > color range ID )
- source color palette - the first parameter is a source color palette, usually magenta. Do not surround this parameter with quotes.
- color range ID - this is the second parameter, a number 1-9 signifying the ID of a color range defined in the file data/team-colors.cfg (or it may be a custom ID for a color range defined locally).
Flip Function
Template:DevFeature May be used to flip an image horizontally and/or vertically
Syntax
~FL( optional argument list )
- vertical - if the string "vert" is found anywhere in the argument list, the image will be flipped vertically.
- horizontal - if the string "horiz" is found anywhere in the argument list, the image will be flipped horizantally.
- if the argument list is empty, the image will only be flipped horizantally.