Background for Skyrim SE
Member of the VisualEffect script
voidfunctionPlay(ObjectReferenceakObject, floatafTime=-1, ObjectReferenceakFacingObject=NONE)Native

Description

Wiki Description

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

Documentation Comment

Plays this visual effect on the specified object, for a certain length of time (negative for infinite) and possibly facing another object


Caveats

CK Wiki - Notes

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

Parameters

ObjectReferenceakObject

CK Wiki Description

The object to play the effect on.

floatafTime=-1

CK Wiki Description

How long to play the effect for, in seconds. If time is negative, the effect will play until told to stop.

  • Default:-1.0

ObjectReferenceakFacingObject=NONE

CK Wiki Description

What object the effect should face. Only works on effects that can be facing other objects.

  • Default:None

Examples

; 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)

Auto-Generated Example

ObjectReference myObjectReference__akObject
float myFloat__afTime
ObjectReference myObjectReference__akFacingObject

myVisualEffect__toCallFunctionOn.Play(myObjectReference__akObject, myFloat__afTime, myObjectReference__akFacingObject)

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.