Difference between revisions of "cameraEffect"
Jump to navigation
Jump to search
m (+ categroy) |
m (template:command argument fix) |
||
(29 intermediate revisions by 13 users not shown) | |||
Line 11: | Line 11: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | | | + | | 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" r2t source | ||
+ | cam [[cameraEffect]] ["terminate", "back"]; // would terminate all r2t sources</code><br> | ||
+ | {{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)}}|DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | | camera '''cameraEffect''' [ | + | | camera '''cameraEffect''' [effectName, effectPosition, r2tName] |SYNTAX= |
− | |p1= camera: [[Object]] - object of type "camera" |= | + | |p1= camera: [[Object]] - object of type "camera" |PARAMETER1= |
− | |p2= | + | |p2= [effectName, effectPosition, r2tName]: [[Array]] |PARAMETER2= |
− | |p3= | + | |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> |PARAMETER3= |
− | | [[Nothing]] |= | + | |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"; |PARAMETER4= |
+ | |||
+ | |p5= r2tName (Optional): [[String]] - [[Procedural_Textures#Render_To_Texture|Render To Texture]] surface reference |PARAMETER5= | ||
+ | |||
+ | | [[Nothing]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | |x1= < | + | |x1= <code>_cam [[cameraEffect]] ["internal", "BACK"];</code> |EXAMPLE1= |
+ | |x2= <code>_cam [[cameraEffect]] ["internal", "back", "rendersurface"];</code> |EXAMPLE2= | ||
+ | |x3= <code>cam = "seagull" [[camCreate]] ([[player]] [[modelToWorld]] [0,0,100]); | ||
+ | cam [[cameraEffect]] ["FIXED", "LEFT TOP"]; | ||
+ | cam [[camCommand]] "MANUAL ON";</code> |EXAMPLE3= | ||
+ | |x4= <code>_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;</code> |EXAMPLE4= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | | [[switchCamera]] |= | + | | [[switchCamera]], [[cameraView]], [[cameraOn]], [[setPiPEffect]], [[camCreate]], [[cameraEffectEnableHUD]], [[camUseNVG]], [[setCamUseTI]] |SEEALSO= |
}} | }} | ||
Line 42: | Line 65: | ||
[[Category:Scripting Commands|CAMERAEFFECT]] | [[Category:Scripting Commands|CAMERAEFFECT]] | ||
+ | [[Category:Scripting Commands OFP 1.99|CAMERAEFFECT]] | ||
[[Category:Scripting Commands OFP 1.96|CAMERAEFFECT]] | [[Category:Scripting Commands OFP 1.96|CAMERAEFFECT]] | ||
[[Category:Scripting Commands OFP 1.46|CAMERAEFFECT]] | [[Category:Scripting Commands OFP 1.46|CAMERAEFFECT]] | ||
[[Category:Scripting Commands ArmA|CAMERAEFFECT]] | [[Category:Scripting Commands ArmA|CAMERAEFFECT]] | ||
[[Category:Command Group: Camera Control|CAMERAEFFECT]] | [[Category:Command Group: Camera Control|CAMERAEFFECT]] | ||
+ | [[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | ||
+ | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
+ | [[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] | ||
+ | |||
+ | <!-- CONTINUE Notes --> | ||
+ | <dl class="command_description"> | ||
+ | <dd class="notedate">Posted on October 30, 2016 - 16:40 (UTC)</dd> | ||
+ | <dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt> | ||
+ | <dd class="note"> | ||
+ | Types of camera for [[Description.ext#CfgCameraEffects|CfgCameraEffects]] config: | ||
+ | * CamExternal (CamInterpolated) <tt>type <nowiki>=</nowiki> 0;</tt> // linked directly with object | ||
+ | * CamStatic <tt>type <nowiki>=</nowiki> 1;</tt> // fixed point in space | ||
+ | * 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> | ||
+ | <!-- DISCONTINUE Notes --> |
Revision as of 14:34, 7 April 2019


Click on the images for descriptions
Introduced in
- Game:
- Operation Flashpoint
- Version:
- 1.00
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" r2t source cam cameraEffect ["terminate", "back"]; // would terminate all r2t sources
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
- 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";
- 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
- Multiplayer:
- -
- See also:
- switchCameracameraViewcameraOnsetPiPEffectcamCreatecameraEffectEnableHUDcamUseNVGsetCamUseTI
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
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
Categories:
- Pages using duplicate arguments in template calls
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Commands utilizing local arguments
- Commands with local effects
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.46
- Scripting Commands ArmA
- Command Group: Camera Control
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters