Class ImageSpaceModifierScript

Namespace

SkyrimForge.Papyrus

Assembly

SkyrimForge.Game.dll

Functions and comments from ImageSpaceModifier.psc.

public static class ImageSpaceModifierScript

Inheritance

object

ImageSpaceModifierScript

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Dispatcher

The dispatcher that binds this script to a form and calls the functions and properties that have no generated member.

public static PapyrusScriptDispatcher Dispatcher { get; }

Property Value

PapyrusScriptDispatcher

Methods

Apply(PapyrusScript<ImageSpaceModifier>, float)

Applies this modifier with the specified strength (which is not clamped)

[Obsolete("Uses the Papyrus virtual machine. Prefer ImageSpaceModifier.Apply(float).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task Apply(this PapyrusScript<ImageSpaceModifier> self, float afStrength = 1)

Parameters

self PapyrusScript<ImageSpaceModifier>

afStrength float

Returns

Task

ApplyCrossFade(PapyrusScript<ImageSpaceModifier>, float)

Adds this modifier to the cross-fade chain, removing the previous modifier, and fading over the specified duration (in seconds)

public static Task ApplyCrossFade(this PapyrusScript<ImageSpaceModifier> self, float afFadeDuration = 1)

Parameters

self PapyrusScript<ImageSpaceModifier>

afFadeDuration float

Returns

Task

PopTo(PapyrusScript<ImageSpaceModifier>, ImageSpaceModifier, float)

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)

[Obsolete("Uses the Papyrus virtual machine. Prefer ImageSpaceModifier.PopTo(ImageSpaceModifier, float).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task PopTo(this PapyrusScript<ImageSpaceModifier> self, ImageSpaceModifier akNewModifier, float afStrength = 1)

Parameters

self PapyrusScript<ImageSpaceModifier>

akNewModifier ImageSpaceModifier

afStrength float

Returns

Task

Remove(PapyrusScript<ImageSpaceModifier>)

Removes this modifier

[Obsolete("Uses the Papyrus virtual machine. Prefer ImageSpaceModifier.Remove().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task Remove(this PapyrusScript<ImageSpaceModifier> self)

Parameters

self PapyrusScript<ImageSpaceModifier>

Returns

Task

RemoveCrossFade(float)

Removes whatever modifier is on the cross-fade chain, fading it out

[Obsolete("Uses the Papyrus virtual machine. Prefer ImageSpaceModifierInstanceForm.StopCrossFade(float).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task RemoveCrossFade(float afFadeDuration = 1)

Parameters

afFadeDuration float

Returns

Task