132
edits
Escaping characters: Difference between revisions
no edit summary
No edit summary |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
When you manage your AGS Strings, you might want to pay special attention to | When you manage your AGS Strings, you might want to pay special attention to these characters: | ||
* '''"''' (double quote) | * '''"''' (double quote) | ||
* '''\''' (backslash) | * '''\''' (backslash) | ||
* '''[''' (opening square bracket, also known as left brace) | * '''[''' (opening square bracket, also known as left brace) | ||
* '''%''' (percent symbol) | |||
For easy solutions, simply read [[String_formatting#Displaying_special_characters]]. For thourough explanations, read below. | For easy solutions, simply read [[String_formatting#Displaying_special_characters]]. For thourough explanations, read below. | ||
| Line 12: | Line 13: | ||
| '''How to read this walkthrough''' | | '''How to read this walkthrough''' | ||
There are 3 stages in managing your strings : | There are 3 stages in managing your strings : | ||
# How you type them into the '''Editor''' | |||
# How they will actually be stored into the engine's '''memory''', at runtime | |||
# How they will be '''rendered''' into the display: in a ''Label'', in a ''Listbox'', or in a ''Display'' command. | |||
|} | |} | ||
| Line 50: | Line 51: | ||
The first two backslashes become just "\", "\[" stays "\[", "\b" becomes just "b". | The first two backslashes become just "\", "\[" stays "\[", "\b" becomes just "b". | ||
Tricky, isn't it? | Tricky, isn't it? | ||
|- | |||
| '''Any number of percent symbols''' || String s = "aaa%bbb"; ''or'' String s="aaa%%bbb"; || 97 97 97 37 98 98 98 or 97 97 97 37 37 98 98 98 || The string will be stored in memory exactly as you typed it in. Trouble may arise only if you decide to use that particular String as the first parameter of the ''String.Format'' or ''Display'' function (read further). | |||
|} | |} | ||
| Line 67: | Line 70: | ||
* What you type in the "Text" property of the Label control is ''exactly'' what will be in memory. No escape characters apply. | * What you type in the "Text" property of the Label control is ''exactly'' what will be in memory. No escape characters apply. | ||
* What will appear in the Label preview (in the GUI Editor, on the left) is rendered following the rules described in this page for Labels (read further). | * What will appear in the Label preview (in the GUI Editor, on the left) is rendered following the rules described in this page for Labels (read further). | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 76: | Line 80: | ||
| aaa\[bbb || aaa[bbb || See Label rendering rules. | | aaa\[bbb || aaa[bbb || See Label rendering rules. | ||
|- | |- | ||
| aaa\\\\[bbb || aaa[bbb || See Label rendering rules. All the backslashes get swallowed up at once! | | aaa\\\\[bbb || aaa[bbb || See Label rendering rules. BEFORE AGS 3.4patch3: All the backslashes get swallowed up at once! FROM AGS3.4 patch3 : Same behaviour as everywhere else. Every backslash counts. | ||
|- | |- | ||
| aaa\bbb || aaa\bbb || (identical) See Label rendering rules. | | aaa\bbb || aaa\bbb || (identical) See Label rendering rules. | ||
|- | |- | ||
| aaa\\\\bbb || aaa\\\\bbb || (identical) See Label rendering rules. | | aaa\\\\bbb || aaa\\\\bbb || (identical) See Label rendering rules. | ||
|- | |||
| aaa%bbb || aaa%bbb || The percent symbol is rendered identically when displayed in a Label.Text.<br> Remember, though, that it has a special effect only when used as the first parameter of the ''String.Format'' or ''Display'' function (read the next section). | |||
|} | |} | ||
'''IMPORTANT NOTE:''' There was a bug in some versions of AGS older than 3.2 : typing aaa\[bbb in the Text property of a Label would render it as follows in the Label: | |||
{| class="wikitable" | |||
| aaa\<br>bbb | |||
|} | |||
<big>'''2) At runtime, in a Label or a Display()'''</big> | <big>'''2) At runtime, in a Label or a Display()'''</big> | ||
| Line 95: | Line 106: | ||
| aaa\[bbb || aaa[bbb || The brace's special behaviour is disabled if it's preceded by one or more backslashes. The backslashes are not rendered. | | aaa\[bbb || aaa[bbb || The brace's special behaviour is disabled if it's preceded by one or more backslashes. The backslashes are not rendered. | ||
|- | |- | ||
| aaa\\\\[bbb || aaa[bbb || Please note that ''all'' the backslashes before a '[' don't get rendered.<br>Not only do they not get rendered, but they get '''deleted from the String''' (in-memory) if you make use of any of the following functions: '''Append''', '''AppendChar''', '''Replace''', etc. Also when you do a ''string'' -> ''String'' conversion (Reminder: ''string'' is the old-style AGS string, while ''String'' is the new-style AGS string since 3.x).<br>It doesn't seem to happen when you use ''String.Chars[i]'' | | aaa\\\\[bbb || aaa[bbb || BEFORE AGS 3.4 patch 3: Please note that ''all'' the backslashes before a '[' don't get rendered.<br>Not only do they not get rendered, but they get '''deleted from the String''' (in-memory) if you make use of any of the following functions: '''Append''', '''AppendChar''', '''Replace''', etc. Also when you do a ''string'' -> ''String'' conversion (Reminder: ''string'' is the old-style AGS string, while ''String'' is the new-style AGS string since 3.x).<br>It doesn't seem to happen when you use ''String.Chars[i]'' STARTING FROM AGS 3.4 patch 3 : Every backslash counts. \[ gives [, \\ gives \, etc. | ||
|- | |- | ||
| aaa\bbb || aaa\bbb || The string gets rendered exactly as in memory, as the backslashes are not followed by '''['''. | | aaa\bbb || aaa\bbb || The string gets rendered exactly as in memory, as the backslashes are not followed by '''['''. | ||
| Line 101: | Line 112: | ||
| aaa\\\\bbb || aaa\\\\bbb || The string gets rendered exactly as in memory, as the backslashes are not followed by '''['''. | | aaa\\\\bbb || aaa\\\\bbb || The string gets rendered exactly as in memory, as the backslashes are not followed by '''['''. | ||
|- | |- | ||
| aaa% | | aaa%ddd || '''In Label.Text:''' aaa%ddd<br>'''In Display:''' aaa%?dd ''(where ? could be any character)'' || '''%''' is a special character meant for formatting Strings, as in ''String s = String.Format("The value of i is %d", i);''.<br>In Labels, it will have no effect. However the ''Display'' function works the same way as ''String.Format'', so you must avoid having a single percent symbol. Use double percents instead. | ||
|- | |- | ||
| aaa%% | | aaa%%ddd || '''In Label.Text:''' aaa%%ddd<br>'''In Display:''' aaa%ddd || '''%''' is a special character meant for formatting Strings, as in ''String s = String.Format("The value of i is %d", i);''.<br>In Labels, it will have no effect. However the ''Display'' function works the same way as ''String.Format'', so if you want to display ''one'' percent symbol, you must have ''two'' in your string. | ||
|} | |} | ||
<big>'''3) At runtime, in a Listbox'''</big> | |||
The string is rendered exactly as it is stored in memory. the Listbox doesn't handle line breaks, so a '''[''' or a '''\[''' in memory will appear as-is in the Listbox. | |||
But remember this : | |||
* If your string contains ''one'' percent symbol, it can cause issues if at some stage before rendering it's used in a ''String.Format'' function (see previous section for recommendations about the double-percents) | |||
* If your string contains several '''\''' followed by one '''[''', then all the '''\''' will be deleted from memory if your string gets manipulated by any String-manipulation function (Append, AppendChar, etc.). See previous section to know more. | |||
[[Category:Scripting]][[Category:Advanced Tutorials]] | [[Category:Scripting]][[Category:Advanced Tutorials]] | ||