cameraEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(bottom)
(positions/example)
Line 20: Line 20:
|p2= [name, position]: [[Array]] |= Parameter 2
|p2= [name, position]: [[Array]] |= Parameter 2


|p3= name: [[String]] - the effect type. One of "Internal", "External", "Fixed", "FixedWithZoom" and "Terminate" |= Parameter 3
|p3= name: [[String]] - the effect type (defined in CfgCameraEffects >> Array). Defaults are: "Internal", "External", "Fixed", "FixedWithZoom" and "Terminate" |= Parameter 3


|p4= position: [[String]] - position of the effect. One of "TOP", "BOTTOM", "LEFT", "RIGHT", "FRONT" and "BACK" ("BACK" is normally used) |= Parameter 4
|p4= position: [[String]] - position of the effect. One of:
* "TOP"
"LEFT"
*  "RIGHT"
*  "FRONT"
*  "BACK"
*  "LEFT FRONT"
*  "RIGHT FRONT"
*  "LEFT BACK"
*  "RIGHT BACK"
"LEFT TOP"
"RIGHT TOP"
"FRONT TOP"
"BACK TOP"
"BOTTOM"
|= Parameter 4
|p5= rtt: [[String]] - (optional) [[Procedural_Textures#Render_To_Texture|Render To Texture]] surface reference |= Parameter 5
|p5= rtt: [[String]] - (optional) [[Procedural_Textures#Render_To_Texture|Render To Texture]] surface reference |= Parameter 5


Line 29: Line 44:
   
   
|x1= <code>_cam [[cameraEffect]] ["internal", "BACK"];</code> |= Example 1
|x1= <code>_cam [[cameraEffect]] ["internal", "BACK"];</code> |= Example 1
|x2= <code>_cam [[cameraEffect]] ["internal", "back", "rendersurface"];</code> |= Example 1
|x2= <code>_cam [[cameraEffect]] ["internal", "back", "rendersurface"];</code> |= Example 2
|x3= <code>cam = "seagull" [[camCreate]] ([[player]] [[modelToWorld]] [0,0,100]);
cam [[cameraEffect]] ["FIXED", "LEFT TOP"];
cam [[camCommand]] "MANUAL ON";</code> |= Example 3
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 13:07, 3 April 2015

Hover & click on the images for description

Description

Description:
Switch to the given camera or object with the given effect. If you want to switch the screen directly to the first-person, aiming, third-person or group view of an object, use switchCamera instead. The effect type "Terminate" is used to exit the current camera view and switch back to the player's view. Does not need camCommit.
Groups:
Uncategorised

Syntax

Syntax:
camera cameraEffect [name, position, rtt]
Parameters:
camera: Object - object of type "camera"
[name, position]: Array
name: String - the effect type (defined in CfgCameraEffects >> Array). Defaults are: "Internal", "External", "Fixed", "FixedWithZoom" and "Terminate"
position: String - position of the effect. One of:
  • "TOP"
  • "LEFT"
  • "RIGHT"
  • "FRONT"
  • "BACK"
  • "LEFT FRONT"
  • "RIGHT FRONT"
  • "LEFT BACK"
  • "RIGHT BACK"
  • "LEFT TOP"
  • "RIGHT TOP"
  • "FRONT TOP"
  • "BACK TOP"
  • "BOTTOM"
rtt: String - (optional) Render To Texture surface reference
Return Value:
Nothing

Examples

Example 1:
_cam cameraEffect ["internal", "BACK"];
Example 2:
_cam cameraEffect ["internal", "back", "rendersurface"];
Example 3:
cam = "seagull" camCreate (player modelToWorld [0,0,100]); cam cameraEffect ["FIXED", "LEFT TOP"]; cam camCommand "MANUAL ON";

Additional Information

See also:
switchCamerasetCameraEffectcameraViewcameraOnsetPiPEffect

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

Notes

Bottom Section