setCameraEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1 = Camera Control |GROUP1= ")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


|arma|Game name=
|game1= ofpe
|1.00|Game version=
|version1= 1.00


|gr1 = Camera Control |GROUP1=
|game2= arma1
|version2= 1.00


|game3= arma2
|version3= 1.00


____________________________________________________________________________________________
|game4= arma2oa
|version4= 1.50


|{{Feature arma3 | This command is not available in Arma 3}}
|game5= tkoh
|version5= 1.00


'''Name''' efines the effect type (a subclass of CfgCameraEffects.Array):
|gr1= Camera Control


*"TERMINATE",
|descr= Applies an effect to the current camera of the player.
*"INTERNAL",
*"ZOOMIN",
*"ZOOMINSLOW",
*"AROUND",
*"AROUNDSLOW",
*"ZOOMANDAROUND",
*"AROUNDANDZOOMINSLOW",
*"ZOOMINS",
*"FIXED",
*"FIXEDWITHZOOM",
*"EXTERNAL"
*"$TERMINATE$" to cancel the current effect.


'''Placement''' is camera placement:
{{Feature|arma3|This command is not present in {{arma3}}.}}


*"TOP",
|s1= triggerOrWaypoint [[setCameraEffect]] [type, position]
*"LEFT",
*"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=
|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]


|p1= trigger: [[Object]] |PARAMETER1=
|p2= type: [[String]] - effect type (a subclass of CfgCameraEffects.Array)
 
{{{!}} class="wikitable"
|p2= [name, position]: [[Array]] |PARAMETER2=
! 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"
}}
{{!}}}


|p3= name: [[String]] |PARAMETER3=
|p3= position: [[String]] - relative position


|p4= position: [[String]] |PARAMETER4=
|r1= [[Nothing]]


| [[Nothing]] |RETURNVALUE=
|x1= <sqf>myTrigger setCameraEffect ["ZoomIn", "FRONT"];</sqf>


____________________________________________________________________________________________
|x2= <sqf>_waypoint1 setCameraEffect ["FIXED", "RIGHT TOP"];</sqf>
 
|s2= waypoint '''setCameraEffect''' [name, position] |SYNTAX2=
 
|p21= waypoint: [[Waypoint]]: [[Array]] |PARAMETER21=
 
|p22= [name, position]: [[Array]] |PARAMETER22=
 
|p23= name: [[String]] |PARAMETER23=
 
|p24= position: [[String]] |PARAMETER4=
 
|r2= [[Nothing]] |RETURNVALUE2=
____________________________________________________________________________________________
 
|x1= <pre>trigger setCameraEffect ["ZoomIn", "FRONT"]</pre> |EXAMPLE1=
____________________________________________________________________________________________
 
| [[cameraEffect]] |SEEALSO=


|seealso= [[cameraEffect]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|SETCAMERAEFFECT]]
[[Category:Scripting Commands OFP Elite |SETCAMERAEFFECT]]
[[Category:Scripting Commands Armed Assault|SETCAMERAEFFECT]]
[[Category:Command Group: Camera Control|SETCAMERAEFFECT]]

Latest revision as of 15: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"