format: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Composes a string containing other variables of other variable types. Converts any variable type to a string. If you want to convert a string back to a number, use [[call]].
| 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 [[call]].
 
The array used with this command has to contain at least two items.|= Description
The array used with this command has to contain at least two items.|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 14:22, 5 August 2006

Hover & click on the images for description

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 call. The array used with this command has to contain at least two items.
Groups:
Uncategorised

Syntax

Syntax:
format [string, var1, var2 ...]
Parameters:
string: String - a string containing references to the variables listed below in the array. The references appear in form of %1, %2 etc.
var1: Any Value - variable referenced by %1
var2: Any Value - variable referenced by %2 a.s.o.
Return Value:
String - The full string is returned.

Examples

Example 1:
format ["Player side: %1 - Human players on that side: %2", side player, playersNumber side player]
returns "Player side: West - Human players on that side: 1"The format command is very strong in combination with call. You can put together dynamic lines of code using format and execute them with call.

Additional Information

See also:
See also needed

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

Notes

It is not advisable to use this command with string arguments only. Better use + for string concatenation then. Read more in String operators If variables don't exist, their value as string is generally "scalar bool array string 0xfcffffef"

Bottom Section