BIS fnc logFormat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\{\{cc\|([^{}]+)\}\} *<\/code>" to "<code>$1// $2</code>")
m (sa)
 
(3 intermediate revisions by 2 users not shown)
Line 7: Line 7:


|descr= Display debug message.  
|descr= Display debug message.  
{{Feature|Informative|'''allowFunctionsLog''' has to be set to '''1''' in the [[Description.ext]] for this function to work.}}
{{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]]
|s1= [text, parameters] call [[BIS_fnc_logFormat]]
Line 17: Line 17:
|r1= [[Boolean]] - [[true]] when done
|r1= [[Boolean]] - [[true]] when done


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


|seealso= [[BIS_fnc_log]]
|seealso= [[BIS_fnc_error]] [[BIS_fnc_logFormatServer]] [[BIS_fnc_errorMsg]] [[BIS_fnc_log]]
}}
}}

Latest revision as of 22:46, 30 December 2023

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