setCameraEffect: Difference between revisions

Latest revision as of 15:47, 8 November 2023

1.00

1.50

1.00

Hover & click on the images for description

Description

Description:: Applies an effect to the current camera of the player.
This command is not present in Arma 3.
Groups:: Camera Control

Syntax

Syntax:

triggerOrWaypoint setCameraEffect [type, position]

Parameters:

triggerOrWaypoint: Object or Array format Waypoint

type: String - effect type (a subclass of CfgCameraEffects.Array)

Effect	Position
"TERMINATE" "INTERNAL" "ZOOMIN" "ZOOMINSLOW" "AROUND" "AROUNDSLOW" "ZOOMANDAROUND" "AROUNDANDZOOMINSLOW" "ZOOMINS" "FIXED" "FIXEDWITHZOOM" "EXTERNAL" "$TERMINATE$"	"TOP" "LEFT" "RIGHT" "FRONT" "BACK" "LEFT FRONT" "RIGHT FRONT" "LEFT BACK" "RIGHT BACK" "LEFT TOP" "RIGHT TOP" "FRONT TOP" "BACK TOP" "BOTTOM"

position: String - relative position

Return Value:

Nothing

Examples

Example 1:: myTrigger setCameraEffect ["ZoomIn", "FRONT"];
Example 2:: _waypoint1 setCameraEffect ["FIXED", "RIGHT TOP"];

Additional Information

See also:: cameraEffect

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

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands|SETCAMERAEFFECT]]
+{{RV|type=command
-[[Category:Scripting Commands OFP Elite |SETCAMERAEFFECT]]
-[[Category:Scripting Commands ArmA|SETCAMERAEFFECT]]
+|game1= ofpe
+|version1= 1.00
-<h2 style="color:#000066">'''''trigger or waypoint'' setCameraEffect ''[name, position]'''''</h2>
+|game2= arma1
+|version2= 1.00
+|game3= arma2
+|version3= 1.00
-'''Operand types:'''
+|game4= arma2oa
+|version4= 1.50
-'''trigger or waypoint:''' [[Object]] or [[Array]]
+|game5= tkoh
+|version5= 1.00
-'''[name, position]:''' [[Array]]
+|gr1= Camera Control
-'''Type of returned value:'''
+|descr= Applies an effect to the current camera of the player.
-[[Nothing]]
+{{Feature|arma3|This command is not present in {{arma3}}.}}
-'''Compatibility:'''
+|s1= triggerOrWaypoint [[setCameraEffect]] [type, position]
-Version 1.86 required.
+|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]
-'''Description:'''
+|p2= type: [[String]] - effect type (a subclass of CfgCameraEffects.Array)
+{{{!}} class="wikitable"
+! Effect
+! Position
+{{!}}-
+{{!}} style="vertical-align: top" {{!}}
+{{Columns|2|
+* "TERMINATE"
+* "INTERNAL"
+* "ZOOMIN"
+* "ZOOMINSLOW"
+* "AROUND"
+* "AROUNDSLOW"
+* "ZOOMANDAROUND"
+* "AROUNDANDZOOMINSLOW"
+* "ZOOMINS"
+* "FIXED"
+* "FIXEDWITHZOOM"
+* "EXTERNAL"
+* "$TERMINATE$"
+}}
+{{!}} style="vertical-align: top" {{!}}
+{{Columns|3|
+* "TOP"
+* "LEFT"
+* "RIGHT"
+* "FRONT"
+* "BACK"
+* "LEFT FRONT"
+* "RIGHT FRONT"
+* "LEFT BACK"
+* "RIGHT BACK"
+* "LEFT TOP"
+* "RIGHT TOP"
+* "FRONT TOP"
+* "BACK TOP"
+* "BOTTOM"
+}}
+{{!}}}
-Name defines the effect type (a subclass of CfgCameraEffects.Array) or "$TERMINATE$" to cancel the current effect. Position is camera placement: "TOP", "LEFT", "RIGHT", "FRONT", "BACK", "LEFT FRONT", "RIGHT FRONT", "LEFT BACK", "RIGHT BACK", "LEFT TOP", "RIGHT TOP", "FRONT TOP", "BACK TOP" or "BOTTOM".
+|p3= position: [[String]] - relative position
-'''Example:'''
+|r1= [[Nothing]]
-trigger '''setCameraEffect''' ["ZoomIn", "FRONT"]
+|x1= <sqf>myTrigger setCameraEffect ["ZoomIn", "FRONT"];</sqf>
+|x2= <sqf>_waypoint1 setCameraEffect ["FIXED", "RIGHT TOP"];</sqf>
+|seealso= [[cameraEffect]]
+}}