Graphics::startScreenEffect: Difference between revisions

From RAGE Multiplayer Wiki
(yay)
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
playLength - is how long to play the effect for in milliseconds. If 0, it plays the default length<br>if loop is true, the effect wont stop until you call _STOP_SCREEN_EFFECT on it. (only loopable effects)<br><br>Example and list of screen FX: www.pastebin.com/dafBAjs0<br>
duration - is how long to play the effect for in milliseconds. If 0, it plays the default length<br>if loop is true, the effect wont stop until you call _STOP_SCREEN_EFFECT on it. (only loopable effects)<br><br>Example and list of screen FX: www.pastebin.com/dafBAjs0<br>
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">graphics.startScreenEffect(effectName, duration, looped);</syntaxhighlight>
<syntaxhighlight lang="javascript">mp.game.graphics.startScreenEffect(effectName, duration, looped);</syntaxhighlight>
=== Required Arguments ===
=== Required Arguments ===
*'''effectName:''' String
*'''effectName:''' String
Line 10: Line 10:
==Example==
==Example==
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
todo
// todo
</syntaxhighlight>
</syntaxhighlight>
==See also==
==See also==
{{Graphics_function_c}}
{{Graphics_s_function_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:TODO: Example]]
[[Category:TODO: Example]]

Latest revision as of 21:17, 22 February 2019

duration - is how long to play the effect for in milliseconds. If 0, it plays the default length
if loop is true, the effect wont stop until you call _STOP_SCREEN_EFFECT on it. (only loopable effects)

Example and list of screen FX: www.pastebin.com/dafBAjs0

Syntax

mp.game.graphics.startScreenEffect(effectName, duration, looped);

Required Arguments

  • effectName: String
  • duration: int
  • looped: Boolean

Return value

  • Undefined

Example

// todo

See also