Cam::shakeCinematic: Difference between revisions

From RAGE Multiplayer Wiki
(Created page with " {{ClientsideJsFunction}} {{JSContainer| ===Required Params=== *'''p0:''' {{RageType|string}} *'''p1:''' {{RageType|number}} ===Return value=== *''' {{RageType|void}} ''' ==Syntax== <syntaxhighlight lang="javascript"> mp.game.cam.shakeCinematic(p0, p1) </syntaxhighlight> ==Example== <syntaxhighlight lang="javascript"> //todo </syntaxhighlight> }} ==See also== {{Cam_functions_c}} Category:Clientside API Category:TODO: Example")
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{ClientsideJsFunction}}
{{ClientsideJsFunction}}
{{JSContainer|
{{JSContainer|
==Explanation==
This function triggers a cinematic camera shake effect, allowing you to specify the shake type and intensity. This can be useful for enhancing in-game events like explosions or impacts with visual effects.


===Required Params===
===Required Params===
*'''p0:''' {{RageType|string}}
*'''type:''' {{RageType|string}} - Type of shake effect.
*'''p1:''' {{RageType|number}}
*'''intensity:''' {{RageType|number}} - Intensity of the shake (0.0 - 1.0).
 
===Available Shake Types===
* "HAND_SHAKE"
* "SMALL_EXPLOSION_SHAKE"
* "MEDIUM_EXPLOSION_SHAKE"
* "LARGE_EXPLOSION_SHAKE"
* "JOLT_SHAKE"
* "ROAD_VIBRATION_SHAKE"
* "DRUNK_SHAKE"
* "VIBRATE_SHAKE"


===Return value===
===Return value===
Line 12: Line 24:
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.game.cam.shakeCinematic(p0, p1)
mp.game.cam.shakeCinematic(type, intensity)
</syntaxhighlight>
</syntaxhighlight>


==Example==
==Example==
The following example applies a hand-held camera shake effect with medium intensity:
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
//todo
mp.game.cam.shakeCinematic("HAND_SHAKE", 0.5);
</syntaxhighlight>
</syntaxhighlight>
}}
}}

Latest revision as of 18:59, 5 November 2024

Client-Side
Function

 JavaScript



JavaScript Syntax


Explanation

This function triggers a cinematic camera shake effect, allowing you to specify the shake type and intensity. This can be useful for enhancing in-game events like explosions or impacts with visual effects.

Required Params

  • type: string - Type of shake effect.
  • intensity: number - Intensity of the shake (0.0 - 1.0).

Available Shake Types

  • "HAND_SHAKE"
  • "SMALL_EXPLOSION_SHAKE"
  • "MEDIUM_EXPLOSION_SHAKE"
  • "LARGE_EXPLOSION_SHAKE"
  • "JOLT_SHAKE"
  • "ROAD_VIBRATION_SHAKE"
  • "DRUNK_SHAKE"
  • "VIBRATE_SHAKE"

Return value

  • void

Syntax

mp.game.cam.shakeCinematic(type, intensity)

Example

The following example applies a hand-held camera shake effect with medium intensity: 

mp.game.cam.shakeCinematic("HAND_SHAKE", 0.5);


See also

Retrieved from "https://wiki.rage.mp/w/index.php?title=Cam::shakeCinematic&oldid=26823"