cameraEffect

Description

Sets the given effect on the given camera. 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.

Since Arma 3 v1.74, it is possible to terminate individual r2t source. For example:

cam cameraEffect ["terminate", "back", "rtt1"]; // would terminate "rtt1" r2t source
cam cameraEffect ["terminate", "back"]; // would terminate all r2t sources

Important

One cannot mix and match cameraEffect and can either have multiple r2t cameras or a single camera for the whole screen. If one needs a background stream overlayed with r2t streams, this could be achieved by creating an object and using switchCamera to switch to it for background image, while using cameraEffect for r2t overlay (see Example 4).

Syntax

camera cameraEffect [effectName, effectPosition, r2tName]

Parameters:

• camera: Object - object of type "camera"

• effectName: String - the effect type (defined in main config or CfgCameraEffects >> Array). Defaults are: "Internal", "External", "Fixed", "FixedWithZoom", "Terminate"

• effectPosition: String - position of the effect. Can be 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".

• r2tName: String - (Optional) Render To Texture surface reference

Returns: 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";

Example 4

_ctrl = findDisplay 46 createDisplay "RscDisplayEmpty" ctrlCreate ["RscPicture", -1];
_ctrl ctrlSetPosition [0.5, 0, 0.5, 0.5];
_ctrl ctrlSetText "#(argb,512,512,1)r2t(rtt1,1.0)";
_ctrl ctrlCommit 0;
_cam1 = "camera" camCreate (ASLToAGL eyePos player vectorAdd [0, -10, 0]);
_cam1 cameraEffect ["Internal", "Back", "rtt1"];
_cam2 = "Land_HandyCam_F" createVehicle [0,0,0];
_cam2 enableSimulation false;
_cam2 setPos (ASLToAGL eyePos player vectorAdd [0, 10, 0]);
_cam2 setDir (_cam2 getDir player);
switchCamera _cam2;

See also

switchCamera · cameraView · cameraOn · setPiPEffect · camCreate · cameraEffectEnableHUD · camUseNVG · setCamUseTI