BIS fnc establishingShot: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= GUI |GROUP1=
|gr1= GUI


|arg= global |MParg= Arguments in MP
|arg= global |MParg= Arguments in MP
Line 11: Line 11:
|eff= local |MPEffects=
|eff= local |MPEffects=


| Play a fake UAV observational sequence which serves as an establishing shot. [[File:BIS fnc establishingShot.gif|left|400px]] |DESCRIPTION=
| Play a fake UAV observational sequence which serves as an establishing shot. [[File:BIS fnc establishingShot.gif|left|400px]]


| [target, text, altitude, radius, angle, rotation, iconOptions, mode, fadeIn,waitTime] spawn [[BIS_fnc_establishingShot]] |SYNTAX=
| [target, text, altitude, radius, angle, rotation, iconOptions, mode, fadeIn,waitTime] spawn [[BIS_fnc_establishingShot]]


|p1= target: [[Object]] or [[Array]] - Target or target's position |PARAMETER1=
|p1= target: [[Object]] or [[Array]] - Target or target's position
|p2= text: [[String]] - Text to display |PARAMETER2=
|p2= text: [[String]] - Text to display
|p3= altitude: [[Number]] - (optional) Altitude (in meters) |PARAMETER3=
|p3= altitude: [[Number]] - (optional) Altitude (in meters)
|p4= radius: [[Number]] - (optional) Radius of the circular movement (in meters) |PARAMETER4=
|p4= radius: [[Number]] - (optional) Radius of the circular movement (in meters)
|p5= angle: [[Number]] - Viewing angle (in degrees) |PARAMETER5=
|p5= angle: [[Number]] - Viewing angle (in degrees)
|p6= rotation: [[Number]] - Direction of camera movement (0: anti-clockwise, 1: clockwise, default: random) |PARAMETER6=
|p6= rotation: [[Number]] - Direction of camera movement (0: anti-clockwise, 1: clockwise, default: random)
|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
Line 30: Line 30:
*6: text: [[String]] - Text displayed underneath the icon (Optional, default "")
*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)
*7: shadow: [[Number]] - 0 to draw now shadow, 1 to draw a shadow (Optional, default 0)
|PARAMETER7=
 
|p8= mode: [[Number]] - 0: normal (default), 1: world scenes |PARAMETER8=
|p8= mode: [[Number]] - 0: normal (default), 1: world scenes
|p9= fadeIn: [[Boolean]] - Fade in after completion (default: true) |PARAMETER9=
|p9= fadeIn: [[Boolean]] - Fade in after completion (default: true)
|p10= waitTime: [[Number]] - Wait time in seconds after the shot has been completed (Since Arma 3 1.81) |PARAMETER10=
|p10= waitTime: [[Number]] - Wait time in seconds after the shot has been completed (Since Arma 3 1.81) |PARAMETER10=


| [[Boolean]] - true when done |RETURNVALUE=
| [[Boolean]] - true when done


|x1= <code><nowiki>[</nowiki>[[player]], "I can see my house from here", 500, 250, 75, 1, [], 0, [[true]]] [[spawn]] [[BIS_fnc_establishingShot]]</code> |EXAMPLE1=
|x1= <code><nowiki>[</nowiki>[[player]], "I can see my house from here", 500, 250, 75, 1, [], 0, [[true]]] [[spawn]] [[BIS_fnc_establishingShot]]</code>


|x2= <code>[
|x2= <code>[
Line 53: Line 53:
   [[true]],
   [[true]],
   15
   15
] [[spawn]] [[BIS_fnc_establishingShot]];</code> |EXAMPLE2=
] [[spawn]] [[BIS_fnc_establishingShot]];</code>




|exec= spawn |Execution=
|exec= spawn |Execution=


| [[BIS_fnc_dynamicText]], [[:Category:Function Group: GUI|GUI functions]] |SEEALSO=
| [[BIS_fnc_dynamicText]], [[:Category:Function Group: GUI|GUI functions]]
}}
}}


Revision as of 00:04, 18 January 2021

Arma 3 logo black.png1.00
GAGlobalLELocal
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:
GUI

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
Example 2:
[ [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;

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


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.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_establishingShot&oldid=202955"