format

From Bohemia Interactive Community

Jump to: navigation, search
Editors, please check Policy: Scripting Command Page Syntax.
Introduced in Operation Flashpoint version 1.00

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint
Version:
1.00

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.

Syntax

Syntax:
String = format ["FormatString", var1, var2 ...]
Parameters:
FormatString: 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, and so on
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"

Additional Information

Multiplayer:
Behaviour unknown.

Notes

Notes

+ Add Note

Only post proven facts here. Use the talk page or the forums for discussions.

Notes

Unknown
The format command is very strong in combination with call. Dynamic code can be created using format and then executed with call.

Posted on August 5, 2006 - 14:12
hardrock
Notes from before the conversion:

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"

Dr_Eyeball
Object array parameters work very nicely. Eg:

_MyArray = [Obj1, Obj2, Obj3];
Hint Format["MyArray=%1", _MyArray];

Posted on August 5, 2006 - 14:12

Bottom Section

Personal tools
Buy ArmA now!