Difference between revisions of "BIS fnc error"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Created page with "{{Function|= Comments ____________________________________________________________________________________________ | TKOH |= Game name |1.00|= Game version ____________________...")
m (Text replacement - "description.ext" to "description.ext")
 
(45 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Function|= Comments
+
{{RV|type=function
____________________________________________________________________________________________
 
  
| TKOH |= Game name
+
|game1= arma3
 +
|version1= 0.50
  
|1.00|= Game version
+
|gr1= Diagnostic
____________________________________________________________________________________________
 
  
| Log error message. |= Description
+
|descr= Log error message and display it (bottom of the UI). If it is called from a function, it'll 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.]]
  
| [param1,param2,...,param10] call bis_fnc_param; |= Syntax
+
|s1=[param1,param2,...,param10] call [[BIS_fnc_error]]
  
|p1= param1: [[String]] - Logged message ([[format|formatted]]). |= Parameter 1
+
|p1= param1: [[String]] - Logged message ([[format|formatted]])
  
|p2= param2 - param10: [[Anything]] |= Parameter 2
+
|p2= param2 - param10: [[Anything]]
  
| [[Boolean]] |= Return value
+
|r1= [[String]] - displayed message
____________________________________________________________________________________________
 
 
 
|x1= <code>["Player is too far away (%1)",[[player]] distance dude] call bis_fnc_error;</code> |= Example 1
 
____________________________________________________________________________________________
 
  
| |= See also
+
|x1= <code>["Player is too far away (%1)",[[player]] [[distance]] dude] [[call]] [[BIS_fnc_error]];</code>
  
 +
|seealso= [[BIS_fnc_errorMsg]] [[BIS_fnc_log]] [[BIS_fnc_logFormat]]
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
 
  
<!-- Note Section END -->
+
<dt></dt>
</dl>
+
<dd class="notedate">Posted on Aug 27, 2013</dd>
 +
<dt class="note">[[User:Kylania|Kylania]]</dt>
 +
<dd class="note">To allow this function to log to the RPT you need to include the following in your [[Description.ext|description.ext]]:
  
<h3 style="display:none">Bottom Section</h3>
+
  allowFunctionsLog=1;
  
[[Category:Take_On_Helicopters:_Functions|error]]
+
</dl>

Latest revision as of 11:57, 18 August 2021

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'll 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:
[param1,param2,...,param10] call BIS_fnc_error
Parameters:
param1: String - Logged message (formatted)
param2 - param10: Anything
Return Value:
String - displayed message

Examples

Example 1:
["Player is too far away (%1)",player distance dude] 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
Kylania
To allow this function to log to the RPT you need to include the following in your description.ext: allowFunctionsLog=1;