BIS_fnc_error

From Bohemia Interactive Community
Revision as of 20:06, 21 May 2023 by Lou Montana (talk | contribs) (Some wiki formatting)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Log error message and display it (bottom of the UI). If it is called from a function, it will include the function name before your content.
Output is: "profileName/log: ERROR: <your content>"

An error logged by BIS_fnc_error.
Execution:
call
Groups:
Diagnostic

Syntax

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

Examples

Example 1:
["Player is too far away (%1)", 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

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
Kylania - c
Posted on Aug 27, 2013 - 17:53 (UTC)
To allow this function to log to the RPT you need to use Description.ext - allowFunctionsLog:
allowFunctionsLog = 1;