BIS fnc establishingShot: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
m (template:command argument fix) |
||
| Line 17: | Line 17: | ||
| [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]] |SYNTAX= | ||
|p1= target: [[Object]] or [[Array]] - Target or target's position |= | |p1= target: [[Object]] or [[Array]] - Target or target's position |PARAMETER1= | ||
|p2= text: [[String]] - Text to display |= | |p2= text: [[String]] - Text to display |PARAMETER2= | ||
|p3= altitude: [[Number]] - (optional) Altitude (in meters) |= | |p3= altitude: [[Number]] - (optional) Altitude (in meters) |PARAMETER3= | ||
|p4= radius: [[Number]] - (optional) Radius of the circular movement (in meters) |= | |p4= radius: [[Number]] - (optional) Radius of the circular movement (in meters) |PARAMETER4= | ||
|p5= angle: [[Number]] - Viewing angle (in degrees) |= | |p5= angle: [[Number]] - Viewing angle (in degrees) |PARAMETER5= | ||
|p6= rotation: [[Number]] - Direction of camera movement (0: anti-clockwise, 1: clockwise, default: random) |= | |p6= rotation: [[Number]] - Direction of camera movement (0: anti-clockwise, 1: clockwise, default: random) |PARAMETER6= | ||
|p7= iconOptions: [[Array]] - Objects/positions/groups to display icons over<br /> | |p7= iconOptions: [[Array]] - Objects/positions/groups to display icons over<br /> | ||
Syntax: <nowiki>[[icon, color, target, size X, size Y, angle, text, shadow], (...)]</nowiki> |= | Syntax: <nowiki>[[icon, color, target, size X, size Y, angle, text, shadow], (...)]</nowiki> |PARAMETER7= | ||
|p8= mode: [[Number]] - 0: normal (default), 1: world scenes |= | |p8= mode: [[Number]] - 0: normal (default), 1: world scenes |PARAMETER8= | ||
|p9= fadeIn: [[Boolean]] - Fade in after completion (default: true) |= | |p9= fadeIn: [[Boolean]] - Fade in after completion (default: true) |PARAMETER9= | ||
|p10= waitTime: [[Number]] - Wait time in seconds after the shot has been completed (Since Arma 3 1.81)|= | |p10= waitTime: [[Number]] - Wait time in seconds after the shot has been completed (Since Arma 3 1.81)|PARAMETER1=0 | ||
| [[Boolean]] - true when done |RETURNVALUE= | | [[Boolean]] - true when done |RETURNVALUE= | ||
Revision as of 14:30, 7 April 2019
Description
- Description:
- Play a fake UAV observational sequence which serves as an establishing shot.
- 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 - 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)
- 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]; };