---
name: "BIS_fnc_error"
type: function
status: ok
groups: ["Diagnostic"]
arma3_since: "0.50"
locality: {"argument": null, "effect": null, "server_exec": false}
source: https://community.bistudio.com/wiki/BIS_fnc_error
revid: 352467
updated: 2024-02-11T23:23:56Z
---

# BIS_fnc_error

*Function · Diagnostic · Arma 3 v0.50*

## Description

Logs an error message and shows an ingame error message. The message is shown when either of the following is true:

- In 2D Editor
- In Eden Editor via [BIS_fnc_3DENNotification](../functions/BIS_fnc_3DENNotification.md)
- Display `313` (Eden Editor display) is available
- `profileNamespace getVariable ["BIS_fnc_init_displayErrors", false]` is set to `true`.

**Output format:**

- In multiplayer ([isMultiplayer](../commands/isMultiplayer.md)) the function will add the [profileName](../commands/profileName.md) in front of the message
- If `_fnc_error_exit` is set to `true` before the function call, the log message will display `HALT:` instead of `ERROR:`
- If function is called from within another function, the name of the parent function will be displayed. This can be overwritten by setting `_fnc_scriptName` to a custom value

> [!NOTE]
> `allowFunctionsLog` has to be set to **1** in [Description.ext](../topics/Description.ext.md) for this function to have any effect.

## Syntax

```sqf
[message, param1, ..., paramN] call BIS_fnc_error
```

**Parameters:**

- `message`: [String](../topics/String.md) - ([format](../commands/format.md)ted) logged message
- `param1..paramN`: [Anything](../topics/Anything.md) - (Optional) [format](../commands/format.md) arguments, if any

**Returns:** [Array](../topics/Array.md) in format: [message, param1..paramN]

## Examples

### Example 1

```sqf
["Player is too far away (%1 metres)", round (player distance [0, 0, 0])] call BIS_fnc_error;
```

### Example 2

```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 };
```

### Example 3

```sqf
// Change rpt log to "HALT" indicating that function exited
private _fnc_error_exit = true;
if (exitHere) exitWith
{
    "Some error message!" call BIS_fnc_error; // Output in rpt: "log: HALT: [BIS_fnc_debugConsoleExec] Some error message!"
};
```

### Example 4

```sqf
private _fnc_scriptName = "My_Awesome_Custom_Function";
"Some error message!" call BIS_fnc_error; // Output in rpt: "log: ERROR: [My_Awesome_Custom_Function] Some error message!"
```

## See also

[BIS_fnc_errorMsg](../functions/BIS_fnc_errorMsg.md) · [BIS_fnc_log](../functions/BIS_fnc_log.md) · [BIS_fnc_logFormat](../functions/BIS_fnc_logFormat.md) · [BIS_fnc_logFormatServer](../functions/BIS_fnc_logFormatServer.md)

<sub>Source: [BI Community Wiki — BIS fnc error](https://community.bistudio.com/wiki/BIS_fnc_error) (revision 352467).</sub>