BIS fnc error: Difference between revisions
Jump to navigation
Jump to search
(Fixed wrong documentation, expanded sa and description) |
Lou Montana (talk | contribs) m (Fix's fix) |
||
Line 6: | Line 6: | ||
|gr1= Diagnostic | |gr1= Diagnostic | ||
|descr= Logs an error message and displays it at bottom of the UI during a mission or via [[BIS_fnc_3DENNotification]] in [[Eden Editor]]. | |descr= [[File:BIS_fnc_error.png|300px|right]] | ||
If it is called from a function, it will include | 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 that function's name before the provided message. | |||
Output is: {{hl|[profileName]]/log: ERROR: < | Output is: {{hl|[[profileName]]/log: ERROR: <message>}} | ||
{{Feature|informative|{{hl|[[Description.ext#allowFunctionsLog|allowFunctionsLog]]}} has to be set to '''1''' in [[Description.ext]] for this function to have any effect.}} | {{Feature|informative|{{hl|[[Description.ext#allowFunctionsLog|allowFunctionsLog]]}} has to be set to '''1''' in [[Description.ext]] for this function to have any effect.}} | ||
Line 23: | Line 22: | ||
|r1= [[Array]] in format: [message, param1..paramN] | |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 metres)", round (player distance [0, 0, 0])] call BIS_fnc_error;</sqf> | ||
|x2= <sqf> | |x2= <sqf> |
Revision as of 12:41, 1 January 2024
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 that function's name before the provided message.
Output is: profileName/log: ERROR: <message>
- 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:
- 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
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