cameraEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(positions/example)
m (Text replacement - "\|gr([0-9]+) = " to "|gr$1= ")
(41 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
| ofp


|1.00|= Game version
|1.00


|arg= local |= Arguments in MP
|gr1= Camera Control


|eff= local |= Effects in MP
|arg= local
____________________________________________________________________________________________


| 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
|eff= local
____________________________________________________________________________________________


| camera '''cameraEffect''' [name, position, rtt] |= Syntax
| 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.74, it is possible to terminate individual r2t source. For example: <code>cam [[cameraEffect]] ["terminate", "back", "rtt1"]; // would terminate "rtt1" r2t source
cam [[cameraEffect]] ["terminate", "back"]; // would terminate all r2t sources</code><br>
{{Feature | 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)}}


|p1= camera: [[Object]] - object of type "camera" |= Parameter 1
| camera '''cameraEffect''' [effectName, effectPosition, r2tName]


|p2= [name, position]: [[Array]] |= Parameter 2
|p1= camera: [[Object]] - object of type "camera"


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


|p4= position: [[String]] - position of the effect. One of:
|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>
* "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


| [[Nothing]] |= Return value
|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";
____________________________________________________________________________________________
 
|p5= r2tName (Optional): [[String]] - [[Procedural_Textures#Render_To_Texture|Render To Texture]] surface reference
 
| [[Nothing]]
   
   
|x1= <code>_cam [[cameraEffect]] ["internal", "BACK"];</code> |= Example 1
|x1= <code>_cam [[cameraEffect]] ["internal", "BACK"];</code>
|x2= <code>_cam [[cameraEffect]] ["internal", "back", "rendersurface"];</code> |= Example 2
|x2= <code>_cam [[cameraEffect]] ["internal", "back", "rendersurface"];</code>
|x3= <code>cam = "seagull" [[camCreate]] ([[player]] [[modelToWorld]] [0,0,100]);
|x3= <code>cam = "seagull" [[camCreate]] ([[player]] [[modelToWorld]] [0,0,100]);
cam [[cameraEffect]] ["FIXED", "LEFT TOP"];
cam [[cameraEffect]] ["FIXED", "LEFT TOP"];
cam [[camCommand]] "MANUAL ON";</code> |= Example 3
cam [[camCommand]] "MANUAL ON";</code>
____________________________________________________________________________________________
|x4= <code>_ctrl = [[findDisplay]] 46 [[createDisplay]] "RscDisplayEmpty" [[ctrlCreate]] ["RscPicture", -1];
 
_ctrl [[ctrlSetPosition]] [0.5, 0, 0.5, 0.5];
| [[switchCamera]], [[setCameraEffect]], [[cameraView]], [[cameraOn]], [[setPiPEffect]] |= See also
_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;</code>


|seealso= [[switchCamera]], [[cameraView]], [[cameraOn]], [[setPiPEffect]], [[camCreate]], [[cameraEffectEnableHUD]], [[camUseNVG]], [[setCamUseTI]]
}}
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


[[Category:Scripting Commands|CAMERAEFFECT]]
<dl class="command_description">
[[Category:Scripting Commands OFP 1.99|CAMERAEFFECT]]
<dt></dt>
[[Category:Scripting Commands OFP 1.96|CAMERAEFFECT]]
<dd class="notedate">Posted on October 30, 2016 - 16:40 (UTC)</dd>
[[Category:Scripting Commands OFP 1.46|CAMERAEFFECT]]
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
[[Category:Scripting Commands ArmA|CAMERAEFFECT]]
<dd class="note">
[[Category:Command Group: Camera Control|CAMERAEFFECT]]
Types of camera for [[Description.ext#CfgCameraEffects|CfgCameraEffects]] config:
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
* CamExternal (CamInterpolated) <tt>type <nowiki>=</nowiki> 0;</tt> // linked directly with object
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
* CamStatic <tt>type <nowiki>=</nowiki> 1;</tt> // fixed point in space
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
* CamStaticWithZoom <tt>type <nowiki>=</nowiki> 2;</tt> // fixed point in space
* CamChained <tt>type <nowiki>=</nowiki> 3;</tt> // chained
* CamTerminate <tt>type <nowiki>=</nowiki> 4;</tt> // terminate
* CamInternal <tt>type <nowiki>=</nowiki> 5;</tt> // internal view
</dd>
</dl>

Revision as of 13:49, 11 April 2021

Game1 needed - Version1 needed
LALocalLELocal
Hover & click on the images for description

Description

Description:
This article is a Stub. You can help BI Community Wiki by expanding it.
Description needed
Groups:
Camera Control

Syntax

Syntax:
Syntax needed
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:
Return value needed

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;

Additional Information

See also:
switchCameracameraViewcameraOnsetPiPEffectcamCreatecameraEffectEnableHUDcamUseNVGsetCamUseTI

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
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=255221"