forceUnicode: Difference between revisions

Latest revision as of 11:43, 30 May 2024

Hover & click on the images for description

Description

Description:

List of the commands that work with forceUnicode:

Sets the Unicode flag which forces some of the string manipulation commands to switch to Unicode. The Unicode flag is always set right after forceUnicode command execution, but is reset depending on the command mode (see mode).

When the flag is set it will also affect all scopes within the script including child scopes (see diag_scope).

There are many other string manipulation commands like ctrlSetText, getTextWidth, etc. that support Unicode by design so no additional forcing is needed.

Groups:

Strings

Syntax

Syntax:

forceUnicode mode

Parameters:

mode: Number - mode of operation, can be:

-1 - resets previously set Unicode flag
0 - sets Unicode flag until the end of script
1 - sets Unicode flag until after next supported command or until the end of script, whichever comes earlier

Return Value:

Anything

Examples

Example 1:: copyToClipboard "д"; // copies "Ð´" to clipboard forceUnicode 1; copyToClipboard "д"; // copies "д" to clipboard
Example 2:: private _string = "привет"; // a string that uses Unicode characters systemChat str count _string; // 12 - the character count is wrong without forceUnicode call { systemChat str count _string; // 12 - identical result forceUnicode 0; systemChat str count _string; // 6 - correct result }; systemChat str count _string; // 6 - outer scope is affected by forceUnicode as well, because the command mode is 0 forceUnicode -1; // cancelled call { systemChat str count _string; // 12 - wrong count forceUnicode 1; systemChat str count _string; // 6 - correct result, but Unicode it reset after this operation, because command mode is 1 }; systemChat str count _string; // 12 - outer scope is not affected as it was reset right after count

Additional Information

See also:: copyToClipboard copyFromClipboard select count in insert find splitString reverse

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 2: / Line 2: @@
 |game1= arma3
 |version1= 2.02
 |gr1= Strings
-|descr= Switches the mode of operation of the following commands to unicode:
+|descr=
-<div style="columns: 5">
+<div style="float: right">
+List of the commands that work with [[forceUnicode]]:
+{{Columns|2|
 * [[copyFromClipboard]]
 * [[copyToClipboard]]
 * [[count]]
 * [[find]]
-* [[getTextWidth]]
 * [[in]]
 * [[insert]]
@@ Line 19: / Line 19: @@
 * [[select]]
 * [[splitString]]
+* [[trim]]
+* [[regexFind]]
+* [[regexMatch]]
+* [[regexReplace]]
+}}
 </div>
-{{Feature | important | [[forceUnicode]] usage with the argument <tt>0</tt> will also apply to [[call]]ed code.}}
+Sets the Unicode flag which forces some of the string manipulation commands to switch to {{Link|https://en.wikipedia.org/wiki/Unicode}}.
+The Unicode flag is always set right after [[forceUnicode]] command execution, but is reset depending on the command mode (see ''{{Link|#Syntax 1|mode}}'').
+When the flag is set it will also affect all scopes within the script including child scopes (see [[diag_scope]]).
+There are many other string manipulation commands like [[ctrlSetText]], [[getTextWidth]], etc. that support Unicode by design so no additional forcing is needed.
 |s1= [[forceUnicode]] mode
-|p1= mode: [[Number]] - Mode of operation, can be: <br>
+|p1= mode: [[Number]] - mode of operation, can be:
-* -1 - off
+* -1 - resets previously set Unicode flag
-* &nbsp;0 - on until end of script
+* &nbsp;0 - sets Unicode flag until the end of script
-* &nbsp;1 - on until next compatible command
+* &nbsp;1 - sets Unicode flag until after next supported command or until the end of script, whichever comes earlier
 |r1= [[Anything]]
-|x1= <code>[[copyToClipboard]] "д"; {{cc|Copies "Ð´" to clipboard}}
+|x1= <sqf>
+copyToClipboard "д"; // copies "Ð´" to clipboard
+forceUnicode 1;
+copyToClipboard "д"; // copies "д" to clipboard
+</sqf>
+|x2= <sqf>
+private _string = "привет";			// a string that uses Unicode characters
+systemChat str count _string;		// 12 - the character count is wrong without forceUnicode
+call {
+	systemChat str count _string;	// 12 - identical result
+	forceUnicode 0;
+	systemChat str count _string;	// 6 - correct result
+};
-[[forceUnicode]] 1;
+systemChat str count _string;		// 6 - outer scope is affected by forceUnicode as well, because the command mode is 0
-[[copyToClipboard]] "д"; {{cc|Copies "д" to clipboard}}</code>
-|x2= <code>[[private]] _string [[a = b|=]] "привет";			{{cc|a string that uses unicode characters}}
+forceUnicode -1; // cancelled
-[[systemChat]] [[str]] [[count]] _string;		{{cc|12 - the character count is wrong without forceUnicode}}
-[[call]] {
+call {
-	[[systemChat]] [[str]] [[count]] _string;	{{cc|12 - identical result}}
+	systemChat str count _string;	// 12 - wrong count
-	[[forceUnicode]] 0;
+	forceUnicode 1;
-	[[systemChat]] [[str]] [[count]] _string;	{{cc|6 - correct result}}
+	systemChat str count _string;	// 6 - correct result, but Unicode it reset after this operation, because command mode is 1
 };
-[[systemChat]] [[str]] [[count]] _string;		{{cc|6 - outer scope is affected by forceUnicode as well}}</code>
+systemChat str count _string;		// 12 - outer scope is not affected as it was reset right after count
+</sqf>
-|seealso= [[copyToClipboard]], [[copyFromClipboard]], [[select]], [[count]], [[in]], [[insert]], [[find]], [[splitString]] [[reverse]]
+|seealso= [[copyToClipboard]] [[copyFromClipboard]] [[select]] [[count]] [[in]] [[insert]] [[find]] [[splitString]] [[reverse]]
 }}