PopTo - ImageSpaceModifier

From the CreationKit Wiki
Revision as of 15:51, 26 April 2011 by imported>Jlundin (Created page with 'Category:Scripting Category:Papyrus '''Member of:''' ImageSpaceModifier Script Disables this image space modifier and immediately enables the new one at the specifie…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Member of: ImageSpaceModifier Script

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.

Syntax[edit | edit source]

Function PopTo(ImageSpaceModifier akNewModifier, float afStrength = 1.0) native

Parameters[edit | edit source]

  • akNewModifier: The new modifier to enable.
  • afStrength: 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

Return Value[edit | edit source]

None.

Examples[edit | edit source]

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

See Also[edit | edit source]