endl: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.70


|1.70|= Game version
|gr1= Strings
____________________________________________________________________________________________


| Creates a string containing a line break, similar to [[lineBreak]] for [[text]]. The name is inspired by c++ std::endl (line end). The command returns "\r\n", which contains control characters rather than printable characters:
|descr= Creates a string containing a line break, similar to [[lineBreak]] for [[text]]. The name is inspired by c++ std::endl ('''end''' '''l'''ine).
* <tt>[[hint]] [[str]] [[count]] "\r\n"; // 4</tt>
The command returns {{hl|"\r\n"}}, which contains control characters rather than printable characters:
* <tt>[[hint]] [[str]] [[count]] [[endl]]; // 2</tt>
<sqf>
The line break works for [[diag_log]] and [[ctrlSetText]]. It doesn't work with the [[hint]] because [[hint]] interprets printable "\n" as line break instead. Alternatively one can use [[toString]] command to get other characters.
hint str count "\r\n"; // 4
|= Description
hint str count endl; // 2
____________________________________________________________________________________________
</sqf>
The line break works for [[diag_log]] and [[ctrlSetText]].
It does not work with the [[hint]] because [[hint]] interprets printable "\n" as line break instead.
Alternatively one can use [[toString]] command to get other characters.


| '''endl''' |= Syntax
|s1= [[endl]]


| [[String]] - line break |= Return value
|r1= [[String]] - line break
____________________________________________________________________________________________
 
|x1= <code>[[diag_log]] ("line1" + [[endl]] + "line2");</code> |= Example 1
|x2= <code>_ctrl = [[findDisplay]] 46 [[ctrlCreate]] ["RscTextMulti", -1];
_ctrl [[ctrlSetPosition]] [0,0,1,1];
_ctrl [[ctrlCommit]] 0;
_ctrl [[ctrlSetText]] [[format]] ["line1%1line2%1line3", [[endl]]];</code> |= Example 2
____________________________________________________________________________________________


| [[lineBreak]], [[str]], [[format]], [[toString]], [[joinString]], [[splitString]], [[toArray]] |= See also
|x1= <sqf>diag_log ("line1" + endl + "line2");</sqf>


|x2= <sqf>
_ctrl = findDisplay 46 ctrlCreate ["RscTextMulti", -1];
_ctrl ctrlSetPosition [0,0,1,1];
_ctrl ctrlCommit 0;
_ctrl ctrlSetText format ["line1%1line2%1line3", endl];
</sqf>
|seealso= [[lineBreak]] [[str]] [[format]] [[toString]] [[joinString]] [[splitString]] [[toArray]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= 7erra
<!-- Note Section BEGIN -->
|timestamp= 20200715115000
 
|text= <sqf inline>toArray endl</sqf> results in <sqf inline>[13, 10]</sqf>. <sqf inline>toString [13, 10]</sqf> is therefore equivalent (or at least very similar) to [[endl]].
<!-- Note Section END -->
}}
</dl>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|LINEBREAK]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:52, 11 July 2022

Arma 3 logo black.png1.70
Hover & click on the images for description

Description

Description:
Creates a string containing a line break, similar to lineBreak for text. The name is inspired by c++ std::endl (end line). The command returns "\r\n", which contains control characters rather than printable characters:
hint str count "\r\n"; // 4 hint str count endl; // 2
The line break works for diag_log and ctrlSetText. It does not work with the hint because hint interprets printable "\n" as line break instead. Alternatively one can use toString command to get other characters.
Groups:
Strings

Syntax

Syntax:
endl
Return Value:
String - line break

Examples

Example 1:
diag_log ("line1" + endl + "line2");
Example 2:
_ctrl = findDisplay 46 ctrlCreate ["RscTextMulti", -1]; _ctrl ctrlSetPosition [0,0,1,1]; _ctrl ctrlCommit 0; _ctrl ctrlSetText format ["line1%1line2%1line3", endl];

Additional Information

See also:
lineBreak str format toString joinString splitString toArray

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
7erra - c
Posted on Jul 15, 2020 - 11:50 (UTC)
toArray endl results in [13, 10]. toString [13, 10] is therefore equivalent (or at least very similar) to endl.
Retrieved from "https://community.bistudio.com/wiki?title=endl&oldid=325316"