Difference between revisions of "Play - EffectShader"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>MoopusMaximus
imported>Chesko
m
 
Line 30: Line 30:


== Notes ==
== Notes ==
*The effects created by this function stack, so using it multiple times without stopping may cause frame rate issues.
*The effects created by this function stack, so using it multiple times without stopping may cause frame rate issues.<sup>[ [[Talk:Play_-_EffectShader|Verification needed - See Discussion page]] ]</sup>


== See Also ==
== See Also ==
*[[EffectShader Script]]
*[[EffectShader Script]]
*[[Stop - EffectShader]]
*[[Stop - EffectShader]]

Latest revision as of 19:36, 2 February 2015

Member of: EffectShader Script

Plays this magic effect shader on the object for the specified duration in seconds.

Syntax[edit | edit source]

Function Play(ObjectReference akObject, float afDuration = -1.0) native

Parameters[edit | edit source]

  • akObject: The object to play the effect on.
  • afDuration: How long to play the effect for, in seconds. If duration is negative, the effect will play until told to stop.
    • Default: -1.0

Return Value[edit | edit source]

None.

Examples[edit | edit source]

; Play the sparkle effect on the werewolf until told to stop
Sparkle.Play(Werewolf)


; Play the sparkle effect on the werewolf for 5 seconds
Sparkle.Play(Werewolf, 5.0)

Notes[edit | edit source]

See Also[edit | edit source]