Background for Fallout 4
Member of the EffectShader script
voidfunctionPlay(ObjectReferenceakObject, floatafDuration=-1)Native

Description

Wiki Description

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

Documentation Comment

Starts playing this effect shader on the specified object for the specified length of time in seconds. Negative values indiciate "infinite"


Caveats


Parameters

ObjectReferenceakObject

CK Wiki Description

The object to play the effect on.

floatafDuration=-1

CK Wiki Description

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

  • Default:-1.0

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)

Auto-Generated Example

ObjectReference myObjectReference__akObject
float myFloat__afDuration

myEffectShader__toCallFunctionOn.Play(myObjectReference__akObject, myFloat__afDuration)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.