setCamShakeParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Category:Arma 2: Operation Arrowhead: New Scripting Commands List" to "Category:Arma 2: Operation Arrowhead: New Scripting Commands")
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2oa
|game1= arma2oa


|1.51
|version1= 1.51
 
|game2= tkoh
 
|version2= 1.00
 
|game3= arma3
 
|version3= 0.50


|gr1= Camera Control
|gr1= Camera Control


| Set camera shake parameters.  
|eff= local
Will not have any effect until shake is started via [[addCamShake]].
 
|descr= Sets camera shake parameters. Will not have any effect until shake is started via [[addCamShake]].


| '''setCamShakeParams'''  [posCoef, vertCoef, horzCoef, bankCoef, interpolation]
|s1= '''setCamShakeParams'''  [posCoef, vertCoef, horzCoef, bankCoef, interpolation]


|p1= posCoef: [[Number]] - Strength of positional movement (how far the whole position can change in X,Y&Z), should not be bigger than .1, or the camera might move into, or behind, the player
|p1= posCoef: [[Number]] - Strength of positional movement (how far the whole position can change in X,Y&Z). Should not be bigger than {{ic|0.1}} to prevent the camera from moving into or behind the player


|p2= vertCoef: [[Number]] - Strength of vertical camera pan (up/down), practical range: 0-10
|p2= vertCoef: [[Number]] - Strength of vertical camera pan (up/down), practical range: 0-10


|p3= horzCoef: [[Number]] - Strength of horizontal camera pan (left/right), practical range: 0-10
|p3= horzCoef: [[Number]] - Strength of horizontal camera pan (left/right), practical range: 0-10
|p4= bankCoef: [[Number]] - Strength of camera tilt/bank, practical range: 0-20
|p4= bankCoef: [[Number]] - Strength of camera tilt/bank, practical range: 0-20
|p5= interpolation: [[Boolean]] - If [[true]], then transitions in the different shaking directions will be smoother
|p5= interpolation: [[Boolean]] - If [[true]], then transitions in the different shaking directions will be smoother


| [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[[setCamShakeParams]] [0.1, 1, 1, 1, true]; </code>
|x1= <code>[[setCamShakeParams]] [0.1, 1, 1, 1, [[true]]]; </code>


|seealso= [[setCamShakeDefParams]], [[addCamShake]], [[enableCamShake]], [[resetCamShake]]
|seealso= [[setCamShakeDefParams]], [[addCamShake]], [[enableCamShake]], [[resetCamShake]]
}}
}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Arma 2: Operation Arrowhead: New Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 17:47, 13 April 2021

Hover & click on the images for description

Description

Description:
Sets camera shake parameters. Will not have any effect until shake is started via addCamShake.
Groups:
Camera Control

Syntax

Syntax:
setCamShakeParams [posCoef, vertCoef, horzCoef, bankCoef, interpolation]
Parameters:
posCoef: Number - Strength of positional movement (how far the whole position can change in X,Y&Z). Should not be bigger than 0.1 to prevent the camera from moving into or behind the player
vertCoef: Number - Strength of vertical camera pan (up/down), practical range: 0-10
horzCoef: Number - Strength of horizontal camera pan (left/right), practical range: 0-10
bankCoef: Number - Strength of camera tilt/bank, practical range: 0-20
interpolation: Boolean - If true, then transitions in the different shaking directions will be smoother
Return Value:
Nothing

Examples

Example 1:
setCamShakeParams [0.1, 1, 1, 1, true];

Additional Information

See also:
setCamShakeDefParamsaddCamShakeenableCamShakeresetCamShake

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