Difference between revisions of "Play - EffectShader"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jlundin
 
imported>MoopusMaximus
Line 28: Line 28:
Sparkle.Play(Werewolf, 5.0)
Sparkle.Play(Werewolf, 5.0)
</source>
</source>
== Notes ==
*The effects created by this function stack, so using it multiple times without stopping may cause frame rate issues.


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

Revision as of 00:41, 22 April 2012

Member of: EffectShader Script

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

Syntax

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

Parameters

  • 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

None.

Examples

; 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

  • The effects created by this function stack, so using it multiple times without stopping may cause frame rate issues.

See Also