Difference between revisions of "Play - VisualEffect"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jlundin
(New page: Category:Scripting Category:Papyrus '''Member of:''' VisualEffect Script Plays this visual effect on the object for the specified duration in seconds - possibly facing the sec...)
 
imported>MoopusMaximus
 
(One intermediate revision by the same user not shown)
Line 30: Line 30:
SoulSucking.Play(Werewolf, akFacingObject = Human)
SoulSucking.Play(Werewolf, akFacingObject = Human)
</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 ==
*[[VisualEffect Script]]
*[[VisualEffect Script]]
*[[Stop - VisualEffect]]
*[[Stop - VisualEffect]]

Latest revision as of 00:45, 22 April 2012

Member of: VisualEffect Script

Plays this visual effect on the object for the specified duration in seconds - possibly facing the second object.

Syntax[edit | edit source]

Function Play(ObjectReference akObject, float afTime = -1.0, ObjectReference akFacingObject = None) native

Parameters[edit | edit source]

  • akObject: The object to play the effect on.
  • afTime: How long to play the effect for, in seconds. If time is negative, the effect will play until told to stop.
    • Default: -1.0
  • akFacingObject: What object the effect should face. Only works on effects that can be facing other objects.
    • Default: None

Return Value[edit | edit source]

None.

Examples[edit | edit source]

; Play the soul-sucking effect on the werewolf until told to stop
SoulSucking.Play(Werewolf)


; Play the soul-sucking effect on the werewolf - pointing it at the human
SoulSucking.Play(Werewolf, akFacingObject = Human)

Notes[edit | edit source]

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

See Also[edit | edit source]