BIS fnc establishingShot: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (updated parameters)
mNo edit summary
Line 24: Line 24:
|p7= iconOptions: [[Array]] - Each array in format:
|p7= iconOptions: [[Array]] - Each array in format:
*0: icon: [[String]] - Path to icon texture
*0: icon: [[String]] - Path to icon texture
*1: color: [[Array]] - Color in format [R,G,B,A]]
*1: color: [[Array]] - Color in format [R,G,B,A]
*2: target: [[Object]], [[Position]] or [[Group]] - Where the texture should be drawn
*2: target: [[Object]], [[Position]] or [[Group]] - Where the texture should be drawn
*3: sizeX: [[Number]] - Size of icon in x (Optional, default 1)
*3: sizeX: [[Number]] - Size of icon in x (Optional, default 1)

Revision as of 01:31, 21 March 2020

Hover & click on the images for description

Description

Description:
Play a fake UAV observational sequence which serves as an establishing shot.
BIS fnc establishingShot.gif
Execution:
spawn
Groups:
Uncategorised

Syntax

Syntax:
[target, text, altitude, radius, angle, rotation, iconOptions, mode, fadeIn,waitTime] spawn BIS_fnc_establishingShot
Parameters:
target: Object or Array - Target or target's position
text: String - Text to display
altitude: Number - (optional) Altitude (in meters)
radius: Number - (optional) Radius of the circular movement (in meters)
angle: Number - Viewing angle (in degrees)
rotation: Number - Direction of camera movement (0: anti-clockwise, 1: clockwise, default: random)
iconOptions: Array - Each array in format:
  • 0: icon: String - Path to icon texture
  • 1: color: Array - Color in format [R,G,B,A]
  • 2: target: Object, Position or Group - Where the texture should be drawn
  • 3: sizeX: Number - Size of icon in x (Optional, default 1)
  • 4: sizeY: Number Size of icon in y (Optional, default 1)
  • 5: angle: Number - Angle of icon (Optional, default random 360)
  • 6: text: String - Text displayed underneath the icon (Optional, default "")
  • 7: shadow: Number - 0 to draw now shadow, 1 to draw a shadow (Optional, default 0)
mode: Number - 0: normal (default), 1: world scenes
fadeIn: Boolean - Fade in after completion (default: true)
waitTime: Number - Wait time in seconds after the shot has been completed (Since Arma 3 1.81)
Return Value:
Boolean - true when done

Examples

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

Additional Information

See also:
BIS_fnc_dynamicTextGUI functions

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

Notes

Bottom Section


Posted on January 28, 2018 - 02:01 (UTC)
Lou Montana
Be aware that spawning this function will set enableSaving to true. Quick workaround: _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: _savingEnabled = savingEnabled; _handle = [player, "myText"] spawn BIS_fnc_establishingShot; _handle spawn { waitUntil { scriptDone _this }; enableSaving [_savingEnabled, false]; };
Posted on July 30, 2019 - 12:01 (UTC)
R3vo
In order to change the camera to TI or NVG mode execute the following right after BIS_fnc_establishingShot was spawned. true setCamUseTI 1; The effect will automatically be terminated once the establishing shot ended.