Difference between revisions of "ImageSpaceModifier Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>CraftySentinel
(Reverted to List)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]


Line 16: Line 12:


== Global Functions ==
== Global Functions ==
'''Function [[RemoveCrossFade - ImageSpaceModifier|RemoveCrossFade]](float afFadeDuration)'''
 
*Removes the last modifier on the cross-fade chain, fading it out.
:'''[[RemoveCrossFade - ImageSpaceModifier|RemoveCrossFade]](Float ''afFadeDuration'')'''
:*Removes the last modifier on the cross-fade chain, fading it out.
 


== Member Functions ==
== Member Functions ==
'''Function [[Apply - ImageSpaceModifier|Apply]](float afStrength)'''
*Applies this image-space modifier to the screen at the specified strength.


'''Function [[ApplyCrossFade - ImageSpaceModifier|ApplyCrossFade]](float afFadeDuration)'''
:'''[[Apply - ImageSpaceModifier|Apply]](Float ''afStrength'')'''
*Applies this modifier to the cross-fade chain, fading between the last modifier on the chain and this one.
:*Applies this image-space modifier to the screen at the specified strength.
 
:'''[[ApplyCrossFade - ImageSpaceModifier|ApplyCrossFade]](Float ''afFadeDuration'')'''
:*Applies this modifier to the cross-fade chain, fading between the last modifier on the chain and this one.


'''Function [[PopTo - ImageSpaceModifier|PopTo]](ImageSpaceModifier akNewModifier, float afStrength)'''
:'''[[PopTo - ImageSpaceModifier|PopTo]](ImageSpaceModifier ''akNewModifier'', Float ''afStrength'')'''
*Disables this modifier and immediately enables the other one - "popping" to it.
:*Disables this modifier and immediately enables the other one - "popping" to it.
 
:'''[[Remove - ImageSpaceModifier|Remove]]()'''
:*Removes this image-space modifier from the screen.


'''Function [[Remove - ImageSpaceModifier|Remove]]()'''
*Removes this image-space modifier from the screen.


== Events ==
== Events ==
None
None
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]

Latest revision as of 18:54, 2 February 2014

Extends: Form Script

Script for the manipulation of image-space modifiers.

Definition[edit | edit source]

ScriptName ImageSpaceModifier extends Form

Properties[edit | edit source]

None

Global Functions[edit | edit source]

RemoveCrossFade(Float afFadeDuration)
  • Removes the last modifier on the cross-fade chain, fading it out.


Member Functions[edit | edit source]

Apply(Float afStrength)
  • Applies this image-space modifier to the screen at the specified strength.
ApplyCrossFade(Float afFadeDuration)
  • Applies this modifier to the cross-fade chain, fading between the last modifier on the chain and this one.
PopTo(ImageSpaceModifier akNewModifier, Float afStrength)
  • Disables this modifier and immediately enables the other one - "popping" to it.
Remove()
  • Removes this image-space modifier from the screen.


Events[edit | edit source]

None