Difference between revisions of "cameraEffect"

From Bohemia Interactive Community
Jump to navigation Jump to search
(docs updated)
Line 11: Line 11:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| 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]].|= 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]].
 +
<br><br>
 +
Since Arma 3 v1.73.142217, it is possible to terminate individual r2t source. For example: <code>cam [[cameraEffect]] ["terminate", "back", "rtt1"]; // would terminate "rtt1" rt2 source
 +
cam [[cameraEffect]] ["terminate", "back"]; // would terminate all r2t sources</code>|= Description
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| camera '''cameraEffect''' [name, position, rtt] |= Syntax
+
| camera '''cameraEffect''' [effectName, effectPosition, r2tName] |= Syntax
  
 
|p1= camera: [[Object]] - object of type "camera" |= Parameter 1
 
|p1= camera: [[Object]] - object of type "camera" |= Parameter 1
  
−
|p2= [name, position, rtt]: [[Array]] |= Parameter 2
+
|p2= effectName, effectPosition, r2tName]: [[Array]] |= Parameter 2
  
−
|p3= name: [[String]] - the effect type (defined in [[Description.ext#CfgCameraEffects|CfgCameraEffects]] >> Array). Defaults are: "Internal", "External", "Fixed", "FixedWithZoom" and "Terminate" |= Parameter 3
+
|p3= effectName: [[String]] - the effect type (defined in main config or [[Description.ext#CfgCameraEffects|CfgCameraEffects]] >> Array). Defaults are: <tt>"Internal"</tt>, <tt>"External"</tt>, <tt>"Fixed"</tt>, <tt>"FixedWithZoom"</tt>, <tt>"Terminate"</tt> |= Parameter 3
  
−
|p4= position: [[String]] - position of the effect. One of:
+
|p4= effectPosition: [[String]] - position of the effect. One of: <tt>"TOP"</tt>, <tt>"LEFT"</tt>, <tt>"RIGHT"</tt>, <tt>"FRONT"</tt>, <tt>"BACK"</tt>, <tt>"LEFT FRONT"</tt>, <tt>"RIGHT FRONT"</tt>, <tt>"LEFT BACK"</tt>, <tt>"RIGHT BACK"</tt>, <tt>"LEFT TOP"</tt>, <tt>"RIGHT TOP"</tt>, <tt>"FRONT TOP"</tt>, <tt>"BACK TOP"</tt>, <tt>"BOTTOM"</tt>. These are usually used with "Fixed" and "FixedWithZoom" effect types. If not sure which position to use, set it to "BACK"; |= Parameter 4
−
*  "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";
+
|p5= r2tName (Optional): [[String]] - [[Procedural_Textures#Render_To_Texture|Render To Texture]] surface reference |= Parameter 5
−
 
−
|= Parameter 4
 
−
|p5= rtt: [[String]] - (optional) [[Procedural_Textures#Render_To_Texture|Render To Texture]] surface reference |= Parameter 5
 
  
 
| [[Nothing]] |= Return value
 
| [[Nothing]] |= Return value
Line 88: Line 74:
 
* CamTerminate <tt>type <nowiki>=</nowiki> 4;</tt> // terminate
 
* CamTerminate <tt>type <nowiki>=</nowiki> 4;</tt> // terminate
 
* CamInternal <tt>type <nowiki>=</nowiki> 5;</tt> // internal view
 
* CamInternal <tt>type <nowiki>=</nowiki> 5;</tt> // internal view
−
</dd>
 
−
</dl>
 
−
<!-- DISCONTINUE Notes -->
 
−
 
−
<!-- CONTINUE Notes -->
 
−
<dl class="command_description">
 
−
<dd class="notedate">Posted on June 25, 2017 - 18:59 (UTC)</dd>
 
−
<dt class="note">[[User:DrSova|DrSova]]</dt>
 
−
<dd class="note">
 
−
"terminate" didn't work propetly with PiP:
 
−
https://feedback.bistudio.com/T81853
 
 
</dd>
 
</dd>
 
</dl>
 
</dl>
 
<!-- DISCONTINUE Notes -->
 
<!-- DISCONTINUE Notes -->

Revision as of 19:46, 26 June 2017

Introduced with Operation Flashpoint version 1.001.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
Hover & click on the images for descriptions

Description

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.73.142217, it is possible to terminate individual r2t source. For example: cam cameraEffect ["terminate", "back", "rtt1"]; // would terminate "rtt1" rt2 source cam cameraEffect ["terminate", "back"]; // would terminate all r2t sources

Syntax

Syntax:
camera cameraEffect [effectName, effectPosition, r2tName]
Parameters:
camera: Object - object of type "camera"
effectName, effectPosition, r2tName]: Array
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. 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 (Optional): String - 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

i
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

Posted on October 30, 2016 - 16:40 (UTC)
Killzone Kid
Types of camera for CfgCameraEffects config:
  • CamExternal (CamInterpolated) type = 0; // linked directly with object
  • CamStatic type = 1; // fixed point in space
  • CamStaticWithZoom type = 2; // fixed point in space
  • CamChained type = 3; // chained
  • CamTerminate type = 4; // terminate
  • CamInternal type = 5; // internal view
Retrieved from "https://community.bistudio.com/wiki?title=cameraEffect&oldid=103623"