Background for Skyrim SE
Member of the ImageSpaceModifier script
voidfunctionPopTo(ImageSpaceModifierakNewModifier, floatafStrength=1.0)Native

Description

Wiki Description

Disables this image space modifier and immediately enables the new one at the specified strength, "popping" to it. Note that this will not affect any image space modifier crossfade going on, assuming both this and the new modifier aren't involved in it.

Documentation Comment

Disables this modifier and enables the new one, "popping" between the two. Will not interrupt any running cross-fade (if the modifiers aren't the ones fading)


Parameters

  1. ImageSpaceModifierakNewModifier

    CK Wiki Description

    The new modifier to enable.

  2. floatafStrength=1.0

    CK Wiki Description

    How "strong" the effect will be. 0 is no effect, 1 is full effect, though the strength is not clamped to this range. Numbers outside this range may provide... interesting results.

    • Default:1.0

Examples

; Pop from modifier 1 to modifier 2 at full strength
Mod1.PopTo(Mod2)
; Pop from modifier 1 to modifier 2 at half strength
Mod1.PopTo(Mod2, 0.5)

Auto-Generated Example

ImageSpaceModifier myImageSpaceModifier__akNewModifier
float myFloat__afStrength

myImageSpaceModifier__toCallFunctionOn.PopTo(myImageSpaceModifier__akNewModifier, myFloat__afStrength)

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.