BIS fnc error: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Some wiki formatting) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| 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 | |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> | ||
Output is: "''[[profileName]]/log: ERROR: <your content>''"<br | Output is: "''[[profileName]]/log: ERROR: <your content>''"<br><br> | ||
<br | |||
[[File:BIS_fnc_error.png|750px|left|An error logged by BIS_fnc_error.]] | [[File:BIS_fnc_error.png|750px|left|An error logged by BIS_fnc_error.]] | ||
|s1= [message, param1, ..., param9] call [[BIS_fnc_error]] | |s1= [message, param1, ..., param9] call [[BIS_fnc_error]] | ||
|p1= message: [[String]] - | |p1= message: [[String]] - ([[format]]ted) logged message | ||
|p2= param1 | |p2= param1..param9: [[Anything]] - (Optional) [[format]] arguments, if any | ||
|r1= [[String]] - displayed message | |r1= [[String]] - displayed message | ||
|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> | ||
|x2= <sqf> | |||
// 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 }; | |||
</sqf> | |||
|seealso= [[BIS_fnc_errorMsg]] [[BIS_fnc_log]] [[BIS_fnc_logFormat]] | |seealso= [[BIS_fnc_errorMsg]] [[BIS_fnc_log]] [[BIS_fnc_logFormat]] | ||
| Line 27: | Line 33: | ||
|user= Kylania | |user= Kylania | ||
|timestamp= 20130827175300 | |timestamp= 20130827175300 | ||
|text= To allow this function to log to the RPT you need to | |text= To allow this function to log to the RPT you need to use {{Link|Description.ext#allowFunctionsLog}}: | ||
<syntaxhighlight lang="cpp"> | <syntaxhighlight lang="cpp"> | ||
allowFunctionsLog = 1; | allowFunctionsLog = 1; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
}} | }} | ||
Revision as of 19:06, 21 May 2023
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>"
- 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:
- 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
- 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;