---
name: "BIS_fnc_establishingShot"
type: function
status: ok
groups: ["GUI"]
arma3_since: "1.00"
locality: {"argument": "global", "effect": "local", "server_exec": false}
source: https://community.bistudio.com/wiki/BIS_fnc_establishingShot
revid: 370443
updated: 2024-12-10T00:25:43Z
---

# BIS_fnc_establishingShot

*Function · GUI · Arma 3 v1.00*

Locality: arguments **global** · effect **local** · executed with **spawn**

## Description

Plays a fake UAV observational sequence which serves as an establishing shot.

## Syntax

```sqf
[target, text, altitude, radius, angle, rotation, iconOptions, mode, fadeIn, waitTime] spawn BIS_fnc_establishingShot
```

**Parameters:**

- `target`: [Object](../topics/Object.md) or [Array](../topics/Array.md) - target or target's position
- `text`: [String](../topics/String.md) - (Optional, default "") text to display
- `altitude`: [Number](../topics/Number.md) - (Optional, default 500) altitude in meters
- `radius`: [Number](../topics/Number.md) - (Optional, default 200) radius of the circular movement in meters
- `angle`: [Number](../topics/Number.md) - (Optional, default random) viewing angle in degrees
- `rotation`: [Number](../topics/Number.md) - (Optional, default random) direction of camera movement
  - 0: anti-clockwise
  - 1: clockwise
- `iconOptions`: [Array](../topics/Array.md) of [Array](../topics/Array.md)s - (Optional, default `[]`) each array in format [icon, color, target, sizeX, sizeY, angle, text, shadow]:
  - icon: [String](../topics/String.md) - path to icon texture
  - color: [Array](../topics/Array.md) format [Color (RGBA)](../topics/Color.md)
  - target: [Object](../topics/Object.md), [Position](../topics/Position.md) or [Group](../topics/Group.md) - where the texture should be drawn
  - sizeX: [Number](../topics/Number.md) - (Optional, default 1) icon width
  - sizeY: [Number](../topics/Number.md) - (Optional, default 1) icon height
  - angle: [Number](../topics/Number.md) - (Optional, default [random](../commands/random.md) 360) icon angle
  - text: [String](../topics/String.md) - (Optional, default "") text displayed underneath the icon
  - shadow: [Number](../topics/Number.md) - (Optional, default 0)
    - 0 to draw a flat icon
    - 1 to draw a shadowed icon
- `mode`: [Number](../topics/Number.md) - (Optional, default 0)
  - 0: normal (disables saving and sets `BIS_missionStarted` to [nil](../commands/nil.md))
  - 1: world scenes (i.e. for main menu background, doesn't display text and does not end)
- `fadeIn`: [Boolean](../topics/Boolean.md) - (Optional, default [true](../commands/true.md)) fade in after completion
- `waitTime`: [Number](../topics/Number.md) - (Optional, default 2) wait time in seconds after the shot has been completed *(since arma3 1.82)*

**Returns:** [Boolean](../topics/Boolean.md) - true when done

## Examples

### Example 1

```sqf
[player, "I can see my house from here", 500, 250, 75, 1, [], 0, true] spawn BIS_fnc_establishingShot;
```

### Example 2

```sqf
[
    [5229.97, 5233.07, 0],
    "BLUFOR and OPFOR firefight",
    500,
    250,
    75,
    1,
    [
        ["\A3\ui_f\data\map\markers\nato\b_inf.paa", [0, 0.3, 0.6, 1], group_1, 1, 1, 0, "BLUFOR"],
        ["\A3\ui_f\data\map\markers\nato\o_inf.paa", [0.5, 0, 0, 1], group_2, 1, 1, 0, "OPFOR"]
    ],
    0,
    true,
    15
] spawn BIS_fnc_establishingShot;
```

## See also

[BIS_fnc_dynamicText](../functions/BIS_fnc_dynamicText.md) · Arma 3: Mission Presentation

## Community notes

**Lou Montana** — 2018-01-28

Be aware that [spawn](../commands/spawn.md)ing this function will set [enableSaving](../commands/enableSaving.md) to true. Quick workaround:

```sqf
private _savingEnabled = savingEnabled;
_handle = [player, "myText"] spawn BIS_fnc_establishingShot;
waitUntil { scriptDone _handle };
enableSaving [_savingEnabled, false];
```

Or, if you can't wait the end of the establishing shot:

```sqf
private _savingEnabled = savingEnabled;
_handle = [player, "myText"] spawn BIS_fnc_establishingShot;
_handle spawn { waitUntil { scriptDone _this }; enableSaving [_savingEnabled, false]; };
```

---

**R3vo** — 2019-07-30

In order to change the camera to TI or NVG mode execute the following right after [BIS_fnc_establishingShot](../functions/BIS_fnc_establishingShot.md) was spawned.

```sqf
true setCamUseTI 1;
```

The effect will automatically be terminated once the establishing shot ended.

<sub>Source: [BI Community Wiki — BIS fnc establishingShot](https://community.bistudio.com/wiki/BIS_fnc_establishingShot) (revision 370443).</sub>
