format: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
[[Category:Scripting Commands|FORMAT]]
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|FORMAT]]
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|FORMAT]]
[[Category:Scripting Commands ArmA|FORMAT]]


| ofp |= Game name


<h2 style="color:#000066">'''format ''format'''''</h2>
|1.00|= Game version
____________________________________________________________________________________________


| 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]].
The array used with this command has to contain at least two items.'''Note:''' It is not advisable to use this command with string arguments only. Better use + for string concatenation then. Read more in [[String
operators]]'''Note:''' If variables don't exist, their value as string is generally "scalar bool array string 0xfcffffef" |= Description
____________________________________________________________________________________________


'''Operand types:'''
| '''format''' [string, var1, var2 ...] |= Syntax


'''format:''' [[Array]]
|p1= string: [[String]] - a string containing references to the variables listed below in the array. The references appear in form of %1, %2 etc. |= Parameter 1


'''Type of returned value:'''
|p2= var1: [[Any Value]] - variable referenced by %1 |= Parameter 2


[[String]]
|p3= var2: [[Any Value]] - variable referenced by %2 a.s.o. |= Parameter 3


'''Description:'''
| [[String]] - 
The full string is returned. |= Return value
____________________________________________________________________________________________
 
|x1= <pre>format ["Player side: %1 - Human players on that side: %2", side player, playersNumber side player]</pre>


First argument of array is the format string.
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. |= Example 1
____________________________________________________________________________________________


Format string may contain references to following arguments in form '''%1''', '''%2''', etc.
|  |= See also


Each '''%x''' is replaced by the corresponding argument.
}}


'''%x''' may appear in the format string in any order.
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


'''\n''' makes a new line.
<!-- Note Section END -->
</dl>


 
<h3 style="display:none">Bottom Section</h3>
'''Examples:'''
[[Category:Scripting Commands|FORMAT]]
 
[[Category:Scripting Commands OFP 1.96|FORMAT]]
'''format''' ["'''%1''' - '''%2''' - '''%1'''", 1, "text"] ...... Result is "1 - text - 1"
[[Category:Scripting Commands OFP 1.46|FORMAT]]
 
[[Category:Scripting Commands ArmA|FORMAT]]
[[hint]] '''format''' ["'''%1'''", loon1 [[distance]] Tank1]
 
[[titleText]] ['''format''' ["Good morning, Captain '''%1'''.", [[name]] [[player]]], "plain", 1]

Revision as of 01:16, 2 August 2006

Logo A0.png1.00
Hover & click on the images for description

Description

Description:
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. The array used with this command has to contain at least two items.Note: It is not advisable to use this command with string arguments only. Better use + for string concatenation then. Read more in [[String operators]]Note: If variables don't exist, their value as string is generally "scalar bool array string 0xfcffffef"
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

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=format&oldid=16997"