11. MessageLink

Description

If the MessageLink was embedded into the RPG_RT (for this see the manual of the DestinyPatcher) then are some new placeholders added to the message command. These placeholder can be used to display the content of Destiny.dll scopes. The formatting is similar to the formatting of the Format method of the String object. The differences are that you must add a backslash in the front of the placeholder, an index at the end of the placeholder and that you can use the a-placeholder for strings. All in all you have three additional placeholder with the MessageLink: A for strings, D for dwords and F for Doubles (the placeholders are equal to the identifers of the scopes).
 
MessageBox:
Hello, this is the first string: "\a[1]"
This is the second dword: \d[2]
and this is the third double: \f[3]
The formatting of the placeholders looks like the formatting of the default RPG-Maker placeholders. But each of these three placeholders has its own properties.

The string placeholder

Description

The only special property of the string placeholder is that it doesn't support line breaks. This depends on the RPG_RT which internal handles lines separated. A text, which has usually multiple lines, is shown in a single line. The chars, which indicate a line break, are displayed.

Example

1
2
$
a[1] = "Line 1" + CRLF + "Line 2"
 
MessageBox:
"\a[1]"
At the end the following MessageBox whould be displayed:
Display of a multiline string
As you can see the two chars of a line break (CarriageReturn and LineFeet) are displayed as arrows. If a string shall be displayed over multiple lines then you must split it first. You can use the Pos method and the SubStr method of the String object for this.

The dword placeholder

Description

This placeholder can display dwords with a minimum number of digits. To do this you simply write the number of digits behind the placeholder.

Example

1
2
$
d[1] = 1500
 
MessageBox:
\d[1]
\d6[1]
\d2[1]
At the end the following MessageBox whould be displayed:
Display of dwords
In the first line the number of digits is determined automatically. In the second line we specified a minimum number of digits which is greater than the required number of digits to display the number. Hence zeros are added to the beginning of the number. In the third line the specified minimum number of digits is exceeded by the required number of digits to display the number. Hence the number is displayed normally.

The double placeholder

Description

This placeholder can display doubles with a minimum number of integer places and an exact number of decimal places. To do this you simply write the minimum number of digits for the integer places, a dot (as decimal separator) and the exact number of digits for the decimal places.

Example

1
2
$
f[1] = 123.456
 
MessageBox:
\f[1]
\f4[1]
\f0.2[1]
\f4.4[1]
At the end the following MessageBox whould be displayed:
Display of doubles
In the first line the length of the integer places and the decimal places is determined automatically. In the second line a minimum length is specified for the integer places. The length of the integer places is shorter than the minimum length so zeros are added to the beginning of the number. In the third line we specified minimum 0 digits for the integer places (this is the default option) and exact 2 decimal places. In the fourth line we specified minimum 4 integer places and exact 4 decimal places.
Information
If a number is specified that it should not display any decimal places then only integer places will be displayed. This means that even the decimal separator will not be displayed. (e. g. \f0.0[1] will display 123 if f[1] is 123.456)