BIS fnc error: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
(Fixed wrong documentation, expanded sa and description)
Line 6: Line 6:
|gr1= Diagnostic
|gr1= Diagnostic


|descr= 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.<br>
|descr= Logs an error message and displays it at bottom of the UI during a mission or via [[BIS_fnc_3DENNotification]] in [[Eden Editor]].  
Output is: "''[[profileName]]/log: ERROR: <your content>''"<br><br>
If it is called from a function, it will include the function name before your content.
[[File:BIS_fnc_error.png|750px|left|An error logged by BIS_fnc_error.]]


|s1= [message, param1, ..., param9] call [[BIS_fnc_error]]
Output is: {{hl|[profileName]]/log: ERROR: <your content>}}
 
[[File:BIS_fnc_error.png|300px|right]]
 
{{Feature|informative|{{hl|[[Description.ext#allowFunctionsLog|allowFunctionsLog]]}} has to be set to '''1''' in [[Description.ext]] for this function to have any effect.}}
 
|s1= [message, param1, ..., paramN] call [[BIS_fnc_error]]


|p1= message: [[String]] - ([[format]]ted) logged message
|p1= message: [[String]] - ([[format]]ted) logged message


|p2= param1..param9: [[Anything]] - (Optional) [[format]] arguments, if any
|p2= param1..paramN: [[Anything]] - (Optional) [[format]] arguments, if any


|r1= [[String]] - displayed message
|r1= [[Array]] in format: [message, param1..paramN]


|x1= <sqf>["Player is too far away (%1)", player distance [0, 0, 0]] call BIS_fnc_error;</sqf>
|x1= <sqf>["Player is too far away (%1)", player distance [0, 0, 0]] call BIS_fnc_error;</sqf>
Line 27: Line 32:
</sqf>
</sqf>


|seealso= [[BIS_fnc_errorMsg]] [[BIS_fnc_log]] [[BIS_fnc_logFormat]]
|seealso= [[BIS_fnc_errorMsg]] [[BIS_fnc_log]] [[BIS_fnc_logFormat]] [[BIS_fnc_logFormatServer]]
}}
 
{{Note
|user= Kylania
|timestamp= 20130827175300
|text= To allow this function to log to the RPT you need to use {{Link|Description.ext#allowFunctionsLog}}:
<syntaxhighlight lang="cpp">
allowFunctionsLog = 1;
</syntaxhighlight>
}}
}}

Revision as of 22:29, 30 December 2023

Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Logs an error message and displays it at bottom of the UI during a mission or via BIS_fnc_3DENNotification in Eden Editor. If it is called from a function, it will include the function name before your content. Output is: [profileName]]/log: ERROR: <your content>
BIS fnc error.png
ⓘ
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)", 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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_error&oldid=351741"