BIS fnc establishingShot: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(added 8th parameter)
(page format)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Play a fake UAV observational sequence which serves as an establishing shot. |= Description
 
Description:
Play a fake UAV observational sequence which serves as an establishing shot.
 
Parameters:
_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)
 
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_establishingShot]]; --> |= Syntax
| [target, text, altitude, radius, angle, rotation, iconOptions, mode, fadeIn] spawn [[BIS_fnc_establishingShot]] |= Syntax


|p1= |= Parameter 1
|p1= target: [[Object]] or [[Array]] - Target or target's position |= Parameter 1
|p2= text: [[String]] - Text to display |= Parameter 2
|p3= altitude: [[Number]] - (optional) Altitude (in meters) |= Parameter 3
|p4= radius: [[Number]] - (optional) Radius of the circular movement (in meters) |= Parameter 4
|p5= angle: [[Number]] - Viewing angle (in degrees) |= Parameter 5
|p6= rotation: [[Number]] - Direction of camera movement (0: anti-clockwise, 1: clockwise, default: random) |= Parameter 6
|p7= iconOptions: [[Array]] - Objects/positions/groups to display icons over<br />
Syntax: <nowiki>[[icon, color, target, size X, size Y, angle, text, shadow], (...)]</nowiki> |= Parameter 7
|p8= mode: [[Number]] - 0: normal (default), 1: world scenes |= Parameter 8
|p9= fadeIn: [[Boolean]] - Fade in after completion (default: true) |= Parameter 9


| |= Return value
| [[Boolean]] true when done |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| |= See also
| |= See also


}}
}}
Line 61: Line 51:
<dt class="note">[[User:Revo|Revo]]</dt>
<dt class="note">[[User:Revo|Revo]]</dt>
<dd class="note">
<dd class="note">
This function needs to be excuted with [[spawn]].
This function needs to be executed with [[spawn]].
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 18:40, 26 January 2018


Hover & click on the images for description

Description

Description:
Play a fake UAV observational sequence which serves as an establishing shot.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[target, text, altitude, radius, angle, rotation, iconOptions, mode, fadeIn] 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 - Objects/positions/groups to display icons over
Syntax: [[icon, color, target, size X, size Y, angle, text, shadow], (...)]
mode: Number - 0: normal (default), 1: world scenes
fadeIn: Boolean - Fade in after completion (default: true)
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:
See also needed

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 July 8, 2017 - 16:35 (UTC)
Revo
This function needs to be executed with spawn.