setCameraEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


|game1= arma1
|game1= ofpe
 
|version1= 1.00
|version1= 1.00


|game2= arma2
|game2= arma1
 
|version2= 1.00
|version2= 1.00


|game3= arma2oa
|game3= arma2
|version3= 1.51
 
|version3= 1.00
 
|game4= arma2oa
 
|version4= 1.51


|gr1= Camera Control
|gr1= Camera Control


|descr= {{Feature|arma3|This command is not available in Arma 3.}}
|descr= Applies an effect to the current camera of the player.


'''Name''' defines the effect type (a subclass of CfgCameraEffects.Array) and '''Position''' the effect's relative position.
|s1= triggerOrWaypoint [[setCameraEffect]] [type, position]
 
|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]


|p2= type: [[String]] - Effect type (a subclass of CfgCameraEffects.Array)
{{{!}} class="wikitable"
{{{!}} class="wikitable"
! Name
! Effect
! Placement
! Position
{{!}}-
{{!}}-
{{!}} style="vertical-align: top" {{!}}
{{!}} style="vertical-align: top" {{!}}
Line 55: Line 65:
{{!}}}
{{!}}}


|s1= triggerOrWaypoint [[setCameraEffect]] [name, position]
|p3= position: [[String]] - Relative position
 
|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]
 
|p2= [name, position]: [[Array]]
 
|p3= name: [[String]]
 
|p4= position: [[String]]


|r1= [[Nothing]]
|r1= [[Nothing]]
   
   
|x1= <code>myTrigger [[setCameraEffect]] ["ZoomIn", "FRONT"];</code>
|x1= <code>myTrigger [[setCameraEffect]] ["ZoomIn", "FRONT"];</code>
|x2= <code>_waypoint1 [[setCameraEffect]] ["FIXED", "RIGHT TOP"];</code>
|x2= <code>_waypoint1 [[setCameraEffect]] ["FIXED", "RIGHT TOP"];</code>


|seealso= [[cameraEffect]]
|seealso= [[cameraEffect]]
}}
}}
{{GameCategory|ofpe|Scripting Commands}}

Revision as of 15:19, 15 March 2021

Hover & click on the images for description

Description

Description:
Applies an effect to the current camera of the player.
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