setCameraEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(9 intermediate revisions by 2 users not shown)
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.50
 
|game5= tkoh
|version5= 1.00


|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.
 
{{Feature|arma3|This command is not present in {{arma3}}.}}


'''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" {{!}}
<div style="columns: 2">
{{Columns|2|
* "TERMINATE"
* "TERMINATE"
* "INTERNAL"
* "INTERNAL"
Line 35: Line 46:
* "EXTERNAL"
* "EXTERNAL"
* "$TERMINATE$"
* "$TERMINATE$"
</div>
}}
{{!}} style="vertical-align: top" {{!}}
{{!}} style="vertical-align: top" {{!}}
<div style="columns: 3">
{{Columns|3|
* "TOP"
* "TOP"
* "LEFT"
* "LEFT"
Line 52: Line 63:
* "BACK TOP"
* "BACK TOP"
* "BOTTOM"
* "BOTTOM"
</div>
}}
{{!}}}
{{!}}}


|s1= triggerOrWaypoint [[setCameraEffect]] [name, position]
|p3= position: [[String]] - relative position


|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]
|r1= [[Nothing]]
 
|p2= [name, position]: [[Array]]
 
|p3= name: [[String]]


|p4= position: [[String]]
|x1= <sqf>myTrigger setCameraEffect ["ZoomIn", "FRONT"];</sqf>


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


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

Latest revision as of 16:47, 8 November 2023

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00
Hover & click on the images for description

Description

Description:
Applies an effect to the current camera of the player.
Arma 3
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
Retrieved from "https://community.bistudio.com/wiki?title=setCameraEffect&oldid=349041"