Difference between revisions of "BIS fnc error"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "description.ext" to "description.ext")
 
(46 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 +
{{RV|type=function
  
{{Function|= Comments
+
|game1= arma3
____________________________________________________________________________________________
+
|version1= 0.50
  
| tkoh |= Game name
+
|gr1= Diagnostic
  
|1.00|= Game version
+
|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.]]
  
| <pre>/*
+
|s1=[param1,param2,...,param10] call [[BIS_fnc_error]]
  
Description:
+
|p1= param1: [[String]] - Logged message ([[format|formatted]])
Display error message
 
  
Parameter(s):
+
|p2= param2 - param10: [[Anything]]
_this select 0: STRING - Formatted message
 
_this select n (Optional): ANY - additional parameters
 
  
Returns:
+
|r1= [[String]] - displayed message
STRING - displayed message
 
*/
 
  
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+
|x1= <code>["Player is too far away (%1)",[[player]] [[distance]] dude] [[call]] [[BIS_fnc_error]];</code>
____________________________________________________________________________________________
 
  
| <!-- [] call [[BIS_fnc_error]]; --> |= Syntax
+
|seealso= [[BIS_fnc_errorMsg]] [[BIS_fnc_log]] [[BIS_fnc_logFormat]]
 +
}}
  
|p1= |= Parameter 1
+
<dl class="command_description">
 
 
| |= Return value
 
____________________________________________________________________________________________
 
 
 
|x1= <code></code> |=
 
____________________________________________________________________________________________
 
 
 
| |= See also
 
  
}}
+
<dt></dt>
 +
<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">Notes</h3>
+
  allowFunctionsLog=1;
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
  
<!-- Note Section END -->
 
 
</dl>
 
</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}}]]
 

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;