Difference between revisions of "ImageSpaceModifier Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎Properties: Formatting Change)
imported>CraftySentinel
(Reverted to List)
 
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]


Line 17: Line 13:
== Global Functions ==
== Global Functions ==


{|class="wikitable" width =100%
:'''[[RemoveCrossFade - ImageSpaceModifier|RemoveCrossFade]](Float ''afFadeDuration'')'''
!style="text-align:left;"|Function
:*Removes the last modifier on the cross-fade chain, fading it out.
!style="text-align:left;"|Description
|-
|[[RemoveCrossFade - ImageSpaceModifier|'''RemoveCrossFade'''(Float ''afFadeDuration'')]]
|Removes the last modifier on the cross-fade chain, fading it out.
|-


|}


== Member Functions ==
== Member Functions ==


{|class="wikitable" width =100%
:'''[[Apply - ImageSpaceModifier|Apply]](Float ''afStrength'')'''
!style="text-align:left;"|Function
:*Applies this image-space modifier to the screen at the specified strength.
!style="text-align:left;"|Description
|-
|[[Apply - ImageSpaceModifier|'''Apply'''(Float ''afStrength'')]]
|Applies this image-space modifier to the screen at the specified strength.
|-


|[[ApplyCrossFade - ImageSpaceModifier|'''ApplyCrossFade'''(Float ''afFadeDuration'')]]
:'''[[ApplyCrossFade - ImageSpaceModifier|ApplyCrossFade]](Float ''afFadeDuration'')'''
|Applies this modifier to the cross-fade chain, fading between the last modifier on the chain and this one.
:*Applies this modifier to the cross-fade chain, fading between the last modifier on the chain and this one.
|-


|[[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'''()]]
:'''[[Remove - ImageSpaceModifier|Remove]]()'''
|Removes this image-space modifier from the screen.
:*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