BIS fnc logFormatServer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Function|= Comments " to "{{Function|Comments= ")
m (unified msg style)
 
(18 intermediate revisions by 2 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


<!---|arg= local |Multiplayer Arguments=--->
|descr= Logs (using [[diag_log]]) a debug message ([[profileName]], [[getPlayerUID|playerUID]], [[Magic Variables#fnc_scriptName|_fnc_scriptName]], provided text) to '''server'''<nowiki/>'s [[Crash Files|.RPT]]. In singleplayer, [[BIS_fnc_logFormat]] is used.
{{Feature|informative|{{hl|[[Description.ext#allowFunctionsLog|allowFunctionsLog]]}} has to be set to '''1''' in [[Description.ext]] for this function to have any effect.}}


<!---|eff= local |Multiplayer Effects=--->
|s1= [text, argument1, argument2, ...] call [[BIS_fnc_logFormatServer]]


| <pre>/*
|p1= text: [[String]] or [[Anything]] - text using [[format]] standard (with %). Any non-[[String]] value will be converted (with [[str]])
Author: Karel Moricky


Description:
|p2= argument1..n: [[Anything]] - same as [[format]] arguments - referenced in ''text'' as %1, %2 etc
Display debug message


Parameter(s):
|r1= [[Boolean]] - [[true]] when done
_this select 0: STRING - Formatted message or first param
_this select n (Optional): ANY - additional parameters


Returns:
|x1= <sqf>private _currentFPS = diag_fps;
BOOL - true when done
if (_currentFPS < 10) then
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=
{
["Player %1 has performance issues (%2 FPS)", name player, _currentFPS] call BIS_fnc_logFormatServer;
};
</sqf>


|[] call [[BIS_fnc_logFormatServer]]|Syntax=
|seealso= [[BIS_fnc_error]] [[BIS_fnc_logFormat]] [[BIS_fnc_errorMsg]] [[BIS_fnc_log]]
 
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
 
|Datatype - description|Return value=
 
|x1= <code></code>|Example 1=
 
| |See also=
}}
}}
[[Category:Function Group: Debug|{{uc:logFormatServer}}]]
[[Category:Functions|{{uc:logFormatServer}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:logFormatServer}}]]

Latest revision as of 22:45, 30 December 2023

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

Description

Description:
Logs (using diag_log) a debug message (profileName, playerUID, _fnc_scriptName, provided text) to server's .RPT. In singleplayer, BIS_fnc_logFormat is used.
ⓘ
allowFunctionsLog has to be set to 1 in Description.ext for this function to have any effect.
Execution:
call
Groups:
Diagnostic

Syntax

Syntax:
[text, argument1, argument2, ...] call BIS_fnc_logFormatServer
Parameters:
text: String or Anything - text using format standard (with %). Any non-String value will be converted (with str)
argument1..n: Anything - same as format arguments - referenced in text as %1, %2 etc
Return Value:
Boolean - true when done

Examples

Example 1:
private _currentFPS = diag_fps; if (_currentFPS < 10) then { ["Player %1 has performance issues (%2 FPS)", name player, _currentFPS] call BIS_fnc_logFormatServer; };

Additional Information

See also:
BIS_fnc_error BIS_fnc_logFormat 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_logFormatServer&oldid=351746"