format: Difference between revisions

Revision as of 14:49, 16 February 2021

Hover & click on the images for description

Description:: Composes a string containing other variables or other variable types. Converts any variable type to a string. If you want to convert a string back to a number, use parseNumber.
⚠
The output of this command is limited to ~8Kb. joinString on the other hand doesn't have such limit and is a bit faster!
Groups:: Strings

Syntax:: format [formatString, var1, var2, ...]
Parameters:: formatString: String - a string containing text and/or references to the variables listed below in the array. The references appear in the form of %1, %2 etc.
: var1: Any Value - variable referenced by %1
: var2: Any Value - variable referenced by %2
Return Value:: String - The full string (up to 8kb, see above) is returned.

Example 1:: format ["Player:%1, player's side:%2", player, side player]; // returns "Player:WEST 1-1-A:1 (Username), player's side:WEST"
Example 2:: player addEventHandler ["HandleDamage", { hint format ["You just sustained %1%2 damage!", ceil ((_this select 2) * 100), "%"]; }]; // Shows "You just sustained 20% damage!"

: 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

Worldeater: The maximum number of characters returned by the format command seems to depend on the total byte count. For plain ASCII strings the limit is 2048 characters.

Posted on March 28, 2015 - 09:22 (UTC)
Heeeere's Johnny!: In addition to the note above, formatTexted strings are Structured Text, hence cannot be used like formatted strings (with most scripting commands). A workaround to get strings of type String with more than 8191 characters is:str formatText ["%1", _string]

@@ Line 20: / Line 20: @@
 |r1= [[String]] - The full string (up to 8kb, see above) is returned.
-|x1= <code>[[format]] ["Player:%1, player's side:%2", [[player]], [[side]] [[player]]];{{cc|returns "Player:WEST 1-1-A:1 (Username), player's side:WEST"}}</code>
+|x1= <code>[[format]] ["Player:%1, player's side:%2", [[player]], [[side]] [[player]]]; {{cc|returns "Player:WEST 1-1-A:1 (Username), player's side:WEST"}}</code>
 |x2= <code>[[player]] [[addEventHandler]] ["HandleDamage", {
 	[[hint]] [[format]] ["You just sustained %1%2 damage!", [[ceil]] (([[_this]] [[select]] 2) * 100), "%"];
-}];{{cc|Shows "You just sustained 20% damage!"}}</code>
+}]; {{cc|Shows "You just sustained 20% damage!"}}</code>
 |seealso= [[formatText]], [[endl]], [[str]], [[toString]], [[joinString]]