BIS fnc logFormat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|gr1 = Debug |GROUP1=" to "|gr1 = Diagnostic |GROUP1=")
m (sa)
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Diagnostic


|gr1 = Diagnostic |GROUP1=
|descr= Display debug message.
{{Feature|informative|{{hl|[[Description.ext#allowFunctionsLog|allowFunctionsLog]]}} has to be set to '''1''' in [[Description.ext]] for this function to have any effect.}}


____________________________________________________________________________________________
|s1= [text, parameters] call [[BIS_fnc_logFormat]]


| Display debug message.
|p1= '''text''': [[String]] - formatted message or first param
{{informative|'''allowFunctionsLog''' has to be set to '''1''' in the [[description.ext]] for this function to work.}}|DESCRIPTION=
____________________________________________________________________________________________


| [Text, <Parameters>] call [[BIS_fnc_logFormat]]; |SYNTAX=
|p2= '''parameters''': [[Anything]] - (Optional) additional parameters


|p1= '''Text''': [[String]] - Formatted message or first param |Parameter1=
|r1= [[Boolean]] - [[true]] when done
|p2= '''Parameters''': [[Any Value]] - Optional, additional parameters |PARAMETER2=


|x1= <sqf>["My logged name: %1, My position: %2", name player, getPos player] call BIS_fnc_logFormat;
// RPT output:
// 12:34:56 "BIS_fnc_log: [BIS_fnc_debugConsoleExec] My logged name: Miller, My position: [4866.73,21947.9,0.00143433]"</sqf>


| [[Boolean]] - [[true]] when done |RETURNVALUE=
|seealso= [[BIS_fnc_error]] [[BIS_fnc_logFormatServer]] [[BIS_fnc_errorMsg]] [[BIS_fnc_log]]
____________________________________________________________________________________________
 
|x1= <code>["my message goes here"] [[call]] [[BIS_fnc_logFormat]];</code> |EXAMPLE1=
 
____________________________________________________________________________________________
 
| [[BIS_fnc_log]] |SEEALSO=
 
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Debug|{{uc:logFormat}}]]
[[Category:Functions|{{uc:logFormat}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:logFormat}}]]

Latest revision as of 22:46, 30 December 2023

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

Description

Description:
Display debug message.
ⓘ
allowFunctionsLog has to be set to 1 in Description.ext for this function to have any effect.
Execution:
call
Groups:
Diagnostic

Syntax

Syntax:
[text, parameters] call BIS_fnc_logFormat
Parameters:
text: String - formatted message or first param
parameters: Anything - (Optional) additional parameters
Return Value:
Boolean - true when done

Examples

Example 1:
["My logged name: %1, My position: %2", name player, getPos player] call BIS_fnc_logFormat; // RPT output: // 12:34:56 "BIS_fnc_log: [BIS_fnc_debugConsoleExec] My logged name: Miller, My position: [4866.73,21947.9,0.00143433]"

Additional Information

See also:
BIS_fnc_error BIS_fnc_logFormatServer BIS_fnc_errorMsg BIS_fnc_log

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_logFormat&oldid=351747"