BIS fnc establishingShot: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ :\\\-\/|()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(page formatting)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3


|1.00
|version1= 1.00


|gr1= GUI
|gr1= GUI


|arg= global |MParg= Arguments in MP
|arg= global


|eff= local
|eff= local


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


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


|p1= target: [[Object]] or [[Array]] - Target or target's position
|p1= target: [[Object]] or [[Array]] - Target or target's position
|p2= text: [[String]] - Text to display
 
|p3= altitude: [[Number]] - (optional) Altitude (in meters)
|p2= text: [[String]] - (optional, default "") Text to display
|p4= radius: [[Number]] - (optional) Radius of the circular movement (in meters)
 
|p5= angle: [[Number]] - Viewing angle (in degrees)
|p3= altitude: [[Number]] - (optional, default 500) Altitude in meters
|p6= rotation: [[Number]] - Direction of camera movement (0: anti-clockwise, 1: clockwise, default: random)
 
|p7= iconOptions: [[Array]] - Each array in format:
|p4= radius: [[Number]] - (optional, default 200) Radius of the circular movement in meters
 
|p5= angle: [[Number]] - (optional, default random) Viewing angle in degrees
 
|p6= rotation: [[Number]] - (optional, default random) Direction of camera movement  
* 0: anti-clockwise
* 1: clockwise)
 
|p7= iconOptions: [[Array]] - (optional, default []) 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]] - (Optional, default 1) Size of icon in x
*4: sizeY: [[Number]] Size of icon in y (Optional, default 1)
*4: sizeY: [[Number]] - (Optional, default 1) Size of icon in y
*5: angle: [[Number]] - Angle of icon (Optional, default [[random]] 360)
*5: angle: [[Number]] - (Optional, default [[random]] 360) Angle of icon
*6: text: [[String]] - Text displayed underneath the icon (Optional, default "")
*6: text: [[String]] - (Optional, default "") Text displayed underneath the icon
*7: shadow: [[Number]] - 0 to draw now shadow, 1 to draw a shadow (Optional, default 0)
*7: shadow: [[Number]] - (Optional, default 0)
** 0 to draw now shadow
** 1 to draw a shadow  
 
|p8= mode: [[Number]] - (optional, default 0)  
* 0: normal (Disables saving and sets <tt>BIS_missionStarted</tt> to [[nil]])
* 1: world scenes


|p8= mode: [[Number]] - 0: normal (default), 1: world scenes
|p9= fadeIn: [[Boolean]] - (optional, default [[true]]) Fade in after completion
|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)


| [[Boolean]] - true when done
|p10= waitTime: [[Number]] - (optional, default 2) Wait time in seconds after the shot has been completed {{Since|arma3|1.81|right}}
 
|r1= [[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>
|x1= <code><nowiki>[</nowiki>[[player]], "I can see my house from here", 500, 250, 75, 1, [], 0, [[true]]] [[spawn]] [[BIS_fnc_establishingShot]]</code>
Line 57: Line 71:
|exec= spawn
|exec= spawn


|seealso= [[BIS_fnc_dynamicText]], [[:Category:Function Group: GUI|GUI functions]]
|seealso= [[BIS_fnc_dynamicText]] [[Arma 3: Mission Presentation]]
}}
}}


<!-- CONTINUE Notes -->
<!-- CONTINUE Notes -->

Revision as of 20:40, 18 February 2021

Arma 3 logo black.png1.00
GAGlobalLELocal
Hover & click on the images for description

Description

Description:
Plays 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 - (optional, default "") Text to display
altitude: Number - (optional, default 500) Altitude in meters
radius: Number - (optional, default 200) Radius of the circular movement in meters
angle: Number - (optional, default random) Viewing angle in degrees
rotation: Number - (optional, default random) Direction of camera movement
  • 0: anti-clockwise
  • 1: clockwise)
iconOptions: Array - (optional, default []) 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 - (Optional, default 1) Size of icon in x
  • 4: sizeY: Number - (Optional, default 1) Size of icon in y
  • 5: angle: Number - (Optional, default random 360) Angle of icon
  • 6: text: String - (Optional, default "") Text displayed underneath the icon
  • 7: shadow: Number - (Optional, default 0)
    • 0 to draw now shadow
    • 1 to draw a shadow
mode: Number - (optional, default 0)
  • 0: normal (Disables saving and sets BIS_missionStarted to nil)
  • 1: world scenes
fadeIn: Boolean - (optional, default true) Fade in after completion
waitTime: Number - (optional, default 2) Wait time in seconds after the shot has been completed Template:Since
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_dynamicText Arma 3: Mission Presentation

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 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=249330"