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: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-|arma|= Game name
+|game1= ofpe
-|1.00|= Game version
+|version1= 1.00
-____________________________________________________________________________________________
-| '''Name''' defines the effect type (a subclass of CfgCameraEffects.Array):
+|game2= arma1
+|version2= 1.00
-*"TERMINATE",
+|game3= arma2
-*"INTERNAL",
+|version3= 1.00
-*"ZOOMIN",
-*"ZOOMINSLOW",
-*"AROUND",
-*"AROUNDSLOW",
-*"ZOOMANDAROUND",
-*"AROUNDANDZOOMINSLOW",
-*"ZOOMINS",
-*"FIXED",
-*"FIXEDWITHZOOM",
-*"EXTERNAL"
-*"$TERMINATE$" to cancel the current effect.
-'''Placement''' is camera placement:
+|game4= arma2oa
+|version4= 1.50
-*"TOP",
+|game5= tkoh
-*"LEFT",
+|version5= 1.00
-*"RIGHT",
-*"FRONT",
-*"BACK",
-*"LEFT FRONT",
-*"RIGHT FRONT",
-*"LEFT BACK",
-*"RIGHT BACK",
-*"LEFT TOP",
-*"RIGHT TOP",
-*"FRONT TOP",
-*"BACK TOP"
-*"BOTTOM". |= Description
-____________________________________________________________________________________________
-| trigger '''setCameraEffect''' [name, position] |= Syntax
+|gr1= Camera Control
-|p1= trigger: [[Object]] |= Parameter 1
+|descr= Applies an effect to the current camera of the player.
-|p2= [name, position]: [[Array]] |= Parameter 2
+{{Feature|arma3|This command is not present in {{arma3}}.}}
-|p3= name: [[String]] |= Parameter 3
+|s1= triggerOrWaypoint [[setCameraEffect]] [type, position]
-|p4= position: [[String]] |= Parameter 4
+|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]
-| [[Nothing]] |= Return value
+|p2= type: [[String]] - effect type (a subclass of CfgCameraEffects.Array)
+{{{!}} class="wikitable"
-____________________________________________________________________________________________
+! Effect
+! Position
-|s2= waypoint '''setCameraEffect''' [name, position] |= Syntax
+{{!}}-
+{{!}} style="vertical-align: top" {{!}}
-|p21= waypoint: [[Waypoint]]: [[Array]] |= Parameter 1
+{{Columns|2|
+* "TERMINATE"
-|p2= [name, position]: [[Array]] |= Parameter 2
+* "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"
+}}
+{{!}}}
-|p3= name: [[String]] |= Parameter 3
+|p3= position: [[String]] - relative position
-|p4= position: [[String]] |= Parameter 4
+|r1= [[Nothing]]
-|r2= [[Nothing]] |= Return value
+|x1= <sqf>myTrigger setCameraEffect ["ZoomIn", "FRONT"];</sqf>
-____________________________________________________________________________________________
-|x1= <pre>trigger setCameraEffect ["ZoomIn", "FRONT"]</pre> |= Example 1
-____________________________________________________________________________________________
-|  |= See also
+|x2= <sqf>_waypoint1 setCameraEffect ["FIXED", "RIGHT TOP"];</sqf>
+|seealso= [[cameraEffect]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Scripting Commands|SETCAMERAEFFECT]]
-[[Category:Scripting Commands OFP Elite |SETCAMERAEFFECT]]
-[[Category:Scripting Commands ArmA|SETCAMERAEFFECT]]
-[[Category:Command Group: Camera Control|SETCAMERAEFFECT]]