GRFActionsDetailed - Revision history

Frosch: start escapes with backslash

2011-06-18T10:59:02Z

start escapes with backslash

← Older revision		Revision as of 10:59, 18 June 2011
Line 74:		Line 74:


	There are also certain action-specific escape sequences; these are of the format <action><operator>, where the sequence is used for the action <action>, and <operator> is a C operator related to the function of the sequence's byte value, or something vaguely related to a C operator. Or something else.		There are also certain action-specific escape sequences; these are of the format <tt>\<action><operator></tt>, where the sequence is used for the action <tt><action></tt>, and <tt><operator></tt> is a C operator related to the function of the sequence's byte value, or something vaguely related to a C operator. Or something else.

	These are discussed in further detail on the appropriate action's page.		These are discussed in further detail on the appropriate action's page.

FooBar: cleanup

2011-06-14T21:20:35Z

cleanup

Show changes

Orudge: 9 revisions

2011-06-12T19:22:44Z

9 revisions

← Older revision	Revision as of 19:22, 12 June 2011
(No difference)

Orudge: 8 revisions

2011-06-12T19:08:50Z

8 revisions

← Older revision	Revision as of 19:08, 12 June 2011
(No difference)

dmccoy at 00:54, 16 August 2007

2007-08-16T00:54:47Z

← Older revision		Revision as of 00:54, 16 August 2007
Line 64:		Line 64:

	\dx<hex>		\dx<hex>

			\d<date> (Only supported by nforenum 3.4.6 and grfcodec 0.9.11 (r1703) and later.)

	Where:		Where:
Line 75:		Line 77:
	<hex> is any big-endian hexadecimal integer that fits in the given width.		<hex> is any big-endian hexadecimal integer that fits in the given width.

	<date> is a date in one of the four formats YYYY-MM-DD, YYYY/MM/DD, DD-MM-YYYY, or DD/MM/YYYY. ~~For~~ DD ~~and MM~~, ~~the~~ leading 0 may be omitted~~, and the years 1932..2000 may be specified with only two digits~~.		<date> is a date in one of the four formats YYYY-MM-DD, YYYY/MM/DD, DD-MM-YYYY, or DD/MM/YYYY. In all cases, leading zeros may be omitted.

			In the word-sized dates, the years 1932..2000 may be specified with only two digits.

			To avoid ambiguity, dword-sized dates before 1 Jan 32 must be specified with the YMD formats, not the DMY formats. eg 10 Feb 20 is \d20-2-10.

	There are also certain action-specific escape sequences; these are of the format \<action><operator>, where the sequence is used for the action <action>, and <operator> is a C operator related to the function of the sequence's byte value, or something vaguely related to a C operator. Or something else.		There are also certain action-specific escape sequences; these are of the format \<action><operator>, where the sequence is used for the action <action>, and <operator> is a C operator related to the function of the sequence's byte value, or something vaguely related to a C operator. Or something else.

dmccoy at 05:32, 21 July 2006

2006-07-21T05:32:10Z

@@ Line 46: / Line 46: @@
 in D becomes 00012345, then 00 01 23 45, so finally 45 23 01 00
 ==Strings==
@@ Line 54: / Line 90: @@
 If you end up with any characters in the range 7B to 9F, remove them from the string. See StringCodes for more details.
 -=List of Actions=-

dmccoy at 07:54, 28 September 2005

2005-09-28T07:54:20Z

New page

'''''Technical reference of the new .grf actions'''''

=Technical reference of the new .grf actions=

-=General Information=-

The next few pages detail the syntax of TTDPatch's GRF actions.  In each page, you will find a list of syntax elements that make up a line for this action in the .nfo file.

Each element has a size (how many bytes it uses in the pseudo sprite data).  These are the possible sizes:

||Size|Description

dec|This value is given in decimal, not hexadecimal; the size is therefore irrelevant

B|This parameter is a single byte

B*|This parameter is an extended byte (either a byte, or a word value)

W|This parameter is a two-byte word, specified in little-endian byte order

D|This parameter is a four-byte dword, again in little-endian byte order

S|This parameter is variable-length, zero terminated text string

V|This parameter has a variable length, which depends on one of the previous parameters; it will be described there.||

Extended bytes work like this:
* To specify a value of 0..FE, simply use that byte value
* To specify a value of FF..FFFF, use a literal FF followed by the word value, e.g. for 320d (140 hex) use FF 40 01.

-=Comments=-

==Byte order==

For values larger than one byte (i.e. W and D), the value must be split into individual bytes in the right order.  This order is the so-called [http://en.wikipedia.org/w/wiki.phtml?title=Little-endian|little-endian] order, with the least significant bytes first.

Here's how you convert a hexadecimal number into its little-endian bytes
#Pad with zeroes from the left until you have twice as many digits as you need bytes (i.e. 4 digits for W, 8 digits for D)
#Split into groups of two digits
#Write these groups backwards

Examples:

123 in W becomes 0123, then 01 23, so finally 23 01

12345 in D becomes 00012345, then 00 01 23 45, so finally 45 23 01 00

==Strings==

Strings are written as individual characters in hex codes, with a final 00 to indicate the end of the string.  For example, "Hello" is 48 65 6D 6D 6F 00.

To convert text into the syntax needed for .nfo files, you can use the [http://www.ttdpatch.net/cgi-bin/str2hex.pl|str2hex] converter. As of grfcodec 0.9.6, you may also put literal strings right in the .nfo. Note that you may only use characters in the latin1 character set, which is what TTD uses.  Other characters will either not show up in TTD or they will mess up the entire display.

If you end up with any characters in the range 7B to 9F, remove them from the string. See StringCodes for more details.

-=List of Actions=-

{toc}