BIS fnc error: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\<dt class\=\"note\"\>\'\'\'\[\[(.*)\]\]\'\'\'" to "<dt class="note">$1")
m (Some wiki formatting)
(41 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 0.50


|0.50|Game version=
|gr1= Diagnostic
____________________________________________________________________________________________


| Log error message and display it (bottom of the UI). If it's called from a function, it'll include the function name before your content.
|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><br>
[[File:BIS_fnc_error.png|750px|left|An error logged by BIS_fnc_error.]]


Output is: "''[[profileName]]/log: ERROR: <your content>''"|DESCRIPTION=
|s1= [message, param1, ..., param9] call [[BIS_fnc_error]]
____________________________________________________________________________________________


| [param1,param2,...,param10] call [[BIS_fnc_error]]; |SYNTAX=
|p1= message: [[String]] - ([[format]]ted) logged message


|p1= param1: [[String]] - Logged message ([[format|formatted]])  |PARAMETER1=
|p2= param1..param9: [[Anything]] - (Optional) [[format]] arguments, if any


|p2= param2 - param10: [[Anything]] |PARAMETER2=
|r1= [[String]] - displayed message


| [[String]] - displayed message |RETURNVALUE=
|x1= <sqf>["Player is too far away (%1)", player distance [0, 0, 0]] call BIS_fnc_error;</sqf>
____________________________________________________________________________________________
 
|x1= <code>["Player is too far away (%1)",[[player]] [[distance]] dude] [[call]] [[BIS_fnc_error]];</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[BIS_fnc_errorMsg]] [[BIS_fnc_log]] [[BIS_fnc_logFormat]] |SEEALSO=
|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]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Kylania
<!-- Note Section BEGIN -->
|timestamp= 20130827175300
<dd class="notedate">Posted on Aug 27, 2013
|text= To allow this function to log to the RPT you need to use {{Link|Description.ext#allowFunctionsLog}}:
<dt class="note">[[User:Kylania|Kylania]]<dd class="note">To allow this function to log to the RPT you need to include the following in your [[description.ext]]:
<syntaxhighlight lang="cpp">
 
allowFunctionsLog = 1;
  allowFunctionsLog=1;
</syntaxhighlight>
 
}}
 
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Debug|{{uc:error}}]]
[[Category:Functions|{{uc:error}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:error}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:error}}]]

Revision as of 20:06, 21 May 2023

Arma 3 logo black.png0.50
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;
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_error&oldid=341324"