Difference between revisions of "cameraEffect"

From Bohemia Interactive Community
Jump to navigation Jump to search
(linked to description.ext)
(description)
Line 23: Line 23:
  
 
|p4= position: [[String]] - position of the effect. One of:
 
|p4= position: [[String]] - position of the effect. One of:
* "TOP"
+
* "TOP"
 
*  "LEFT"
 
*  "LEFT"
 
*  "RIGHT"
 
*  "RIGHT"
Line 37: Line 37:
 
*  "BACK TOP"
 
*  "BACK TOP"
 
*  "BOTTOM"
 
*  "BOTTOM"
 +
 +
These are usually used with "Fixed" and "FixedWithZoom" effect types. If not sure which position to use, set it to "BACK";
 +
 
|= Parameter 4
 
|= 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

Revision as of 18:28, 3 April 2015

Introduced with Operation Flashpoint version 1.00
  Arguments of this scripting command have to be local to the client the command is executed onEffects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint
Version:
1.00

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.

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"
These are usually used with "Fixed" and "FixedWithZoom" effect types. If not sure which position to use, set it to "BACK";
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

Multiplayer:
-
See also:
switchCamerasetCameraEffectcameraViewcameraOnsetPiPEffect

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section