BIS fnc error: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix's fix)
(More info about condition to show error msg)
Line 7: Line 7:


|descr= [[File:BIS_fnc_error.png|300px|right]]
|descr= [[File:BIS_fnc_error.png|300px|right]]
Logs an error message and displays it at bottom of the UI during a mission or via [[BIS_fnc_3DENNotification]] in [[Eden Editor]].  
Logs an error message and shows an ingame error message. The message is shown when either of the following is true:
 
* In [[2D Editor]]
* In [[Eden Editor]] via [[BIS_fnc_3DENNotification]]
* Display {{hl|313}} ([[Eden Editor]] display) is available
* <sqf inline>profilenamespace getvariable ["BIS_fnc_init_displayErrors",false]</sqf> is set to <sqf inline>true</sqf>.
 
If it is called from a function, it will include that function's name before the provided message.
If it is called from a function, it will include that function's name before the provided message.



Revision as of 12:09, 13 January 2024

Hover & click on the images for description

Description

Description:
BIS fnc error.png

Logs an error message and shows an ingame error message. The message is shown when either of the following is true:

If it is called from a function, it will include that function's name before the provided message.

Output is: profileName/log: ERROR: <message>

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

Syntax

Syntax:
[message, param1, ..., paramN] call BIS_fnc_error
Parameters:
message: String - (formatted) logged message
param1..paramN: Anything - (Optional) format arguments, if any
Return Value:
Array in format: [message, param1..paramN]

Examples

Example 1:
["Player is too far away (%1 metres)", round (player distance [0, 0, 0])] call BIS_fnc_error;
Example 2:
// some useful function cases if (!isServer) exitWith { ["This function must run on the server"] call BIS_fnc_error }; if (!hasInterface) exitWith { ["This function must not run on a headless machine"] call BIS_fnc_error }; if (!local _vehicle) exitWith { ["This function must run on the vehicle owner's machine"] call BIS_fnc_error };

Additional Information

See also:
BIS_fnc_errorMsg BIS_fnc_log BIS_fnc_logFormat BIS_fnc_logFormatServer

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