BIS fnc establishingShot: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(added 8th parameter)
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(76 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= GUI


|1.00|= Game version
|arg= global
____________________________________________________________________________________________


| <pre>/*
|eff= local


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


Parameters:
|s1= [target, text, altitude, radius, angle, rotation, iconOptions, mode, fadeIn, waitTime] spawn [[BIS_fnc_establishingShot]]
_this select 0: OBJECT or ARRAY - Target position/object
_this select 1: STRING - Text to display
_this select 2 (Optional): NUMBER - Altitude (in meters)
_this select 3 (Optional): NUMBER - Radius of the circular movement (in meters)
_this select 4 (Optional): NUMBER - Viewing angle (in degrees)
_this select 5 (Optional): NUMBER - Direction of camera movement (0: anti-clockwise, 1: clockwise, default: random)
_this select 6 (Optional): ARRAY - Objects/positions/groups to display icons over
Syntax: [[icon, color, target, size X, size Y, angle, text, shadow]]
_this select 7 (Optional): NUMBER - Mode (0: normal (default), 1: world scenes)
        _this select 8 (Optional): BOOL - Fade in after completion (default: true)


*/
|p1= target: [[Object]] or [[Array]] - target or target's position


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p2= text: [[String]] - (Optional, default "") text to display
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_establishingShot]]; --> |= Syntax
|p3= altitude: [[Number]] - (Optional, default 500) altitude in meters


|p1= |= Parameter 1
|p4= radius: [[Number]] - (Optional, default 200) radius of the circular movement in meters


| |= Return value
|p5= angle: [[Number]] - (Optional, default random) viewing angle in degrees
____________________________________________________________________________________________


|x1= <code></code> |=  
|p6= rotation: [[Number]] - (Optional, default random) direction of camera movement
____________________________________________________________________________________________
* 0: anti-clockwise
* 1: clockwise


| |= See also
|p7= iconOptions: [[Array]] of [[Array]]s - (Optional, default <sqf inline>[]</sqf>) each array in format [icon, color, target, sizeX, sizeY, angle, text, shadow]:
* icon: [[String]] - path to icon texture
* color: [[Array]] format [[Color|Color (RGBA)]]
* target: [[Object]], [[Position]] or [[Group]] - where the texture should be drawn
* sizeX: [[Number]] - (Optional, default 1) icon width
* sizeY: [[Number]] - (Optional, default 1) icon height
* angle: [[Number]] - (Optional, default [[random]] 360) icon angle
* text: [[String]] - (Optional, default "") text displayed underneath the icon
* shadow: [[Number]] - (Optional, default 0)
** 0 to draw a flat icon
** 1 to draw a shadowed icon


|p8= mode: [[Number]] - (Optional, default 0)
* 0: normal (disables saving and sets {{hl|BIS_missionStarted}} to [[nil]])
* 1: world scenes
|p9= fadeIn: [[Boolean]] - (Optional, default [[true]]) fade in after completion
|p10= waitTime: [[Number]] - (Optional, default 2) wait time in seconds after the shot has been completed
|p10since= arma3 1.82
|r1= [[Boolean]] - true when done
|x1= <sqf>[player, "I can see my house from here", 500, 250, 75, 1, [], 0, true] spawn BIS_fnc_establishingShot;</sqf>
|x2= <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;
</sqf>
|exec= spawn
|seealso= [[BIS_fnc_dynamicText]] [[Arma 3: Mission Presentation]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Lou Montana
<!-- Note Section BEGIN -->
|timestamp= 20180128020100
|text= Be aware that [[spawn]]ing this function will set [[enableSaving]] to true. Quick workaround:
<sqf>
private _savingEnabled = savingEnabled;
_handle = [player, "myText"] spawn BIS_fnc_establishingShot;
waitUntil { scriptDone _handle };
enableSaving [_savingEnabled, false];
</sqf>


<!-- Note Section END -->
Or, if you can't wait the end of the establishing shot:
</dl>
<sqf>private _savingEnabled = savingEnabled;
_handle = [player, "myText"] spawn BIS_fnc_establishingShot;
_handle spawn { waitUntil { scriptDone _this }; enableSaving [_savingEnabled, false]; };</sqf>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Function Group: GUI|{{uc:establishingShot}}]]
|user= R3vo
[[Category:Functions|{{uc:establishingShot}}]]
|timestamp= 20190730120100
[[Category:{{Name|arma3}}: Functions|{{uc:establishingShot}}]]
|text= In order to change the camera to TI or NVG mode execute the following right after [[BIS_fnc_establishingShot]] was spawned.
 
<sqf>true setCamUseTI 1;</sqf>
<!-- CONTINUE Notes -->
The effect will automatically be terminated once the establishing shot ended.
<dl class="command_description">
}}
<dd class="notedate">Posted on July 8, 2017 - 16:35 (UTC)</dd>
<dt class="note">[[User:Revo|Revo]]</dt>
<dd class="note">
This function needs to be excuted with [[spawn]].
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 18:09, 8 November 2023

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 of Arrays - (Optional, default []) each array in format [icon, color, target, sizeX, sizeY, angle, text, shadow]:
  • icon: String - path to icon texture
  • color: Array format Color (RGBA)
  • target: Object, Position or Group - where the texture should be drawn
  • sizeX: Number - (Optional, default 1) icon width
  • sizeY: Number - (Optional, default 1) icon height
  • angle: Number - (Optional, default random 360) icon angle
  • text: String - (Optional, default "") text displayed underneath the icon
  • shadow: Number - (Optional, default 0)
    • 0 to draw a flat icon
    • 1 to draw a shadowed icon
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
since Arma 3 logo black.png1.82
waitTime: Number - (Optional, default 2) wait time in seconds after the shot has been completed
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
Lou Montana - c
Posted on Jan 28, 2018 - 02:01 (UTC)
Be aware that spawning this function will set enableSaving to true. Quick workaround:
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:
private _savingEnabled = savingEnabled; _handle = [player, "myText"] spawn BIS_fnc_establishingShot; _handle spawn { waitUntil { scriptDone _this }; enableSaving [_savingEnabled, false]; };
R3vo - c
Posted on Jul 30, 2019 - 12:01 (UTC)
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=349481"