Class IngredientScript

Namespace

SkyrimForge.Papyrus

Assembly

SkyrimForge.Game.dll

Functions and comments from Ingredient.psc.

public static class IngredientScript

Inheritance

object

IngredientScript

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

GetCostliestEffectIndex(PapyrusScript<Ingredient>)

return the index of the costliest effect

public static Task<int> GetCostliestEffectIndex(this PapyrusScript<Ingredient> self)

Parameters

self PapyrusScript<Ingredient>

Returns

Task<int>

GetEffectAreas(PapyrusScript<Ingredient>)

Returns all the areas of this object in order

public static Task<int[]> GetEffectAreas(this PapyrusScript<Ingredient> self)

Parameters

self PapyrusScript<Ingredient>

Returns

Task<int[]>

GetEffectDurations(PapyrusScript<Ingredient>)

Returns all the durations of this object in order

public static Task<int[]> GetEffectDurations(this PapyrusScript<Ingredient> self)

Parameters

self PapyrusScript<Ingredient>

Returns

Task<int[]>

GetEffectMagnitudes(PapyrusScript<Ingredient>)

Returns all the magnitudes of this object in order

public static Task<float[]> GetEffectMagnitudes(this PapyrusScript<Ingredient> self)

Parameters

self PapyrusScript<Ingredient>

Returns

Task<float[]>

GetIsNthEffectKnown(PapyrusScript<Ingredient>, int)

determines whether the player knows this effect

public static Task<bool> GetIsNthEffectKnown(this PapyrusScript<Ingredient> self, int index)

Parameters

self PapyrusScript<Ingredient>

index int

Returns

Task<bool>

GetMagicEffects(PapyrusScript<Ingredient>)

Returns all the magic effects of this object in order

public static Task<MagicEffect[]> GetMagicEffects(this PapyrusScript<Ingredient> self)

Parameters

self PapyrusScript<Ingredient>

Returns

Task<MagicEffect[]>

GetNthEffectArea(PapyrusScript<Ingredient>, int)

return the area of the specified effect

public static Task<int> GetNthEffectArea(this PapyrusScript<Ingredient> self, int index)

Parameters

self PapyrusScript<Ingredient>

index int

Returns

Task<int>

GetNthEffectDuration(PapyrusScript<Ingredient>, int)

return the duration of the specified effect

public static Task<int> GetNthEffectDuration(this PapyrusScript<Ingredient> self, int index)

Parameters

self PapyrusScript<Ingredient>

index int

Returns

Task<int>

GetNthEffectMagicEffect(PapyrusScript<Ingredient>, int)

return the magic effect of the specified effect

public static Task<MagicEffect?> GetNthEffectMagicEffect(this PapyrusScript<Ingredient> self, int index)

Parameters

self PapyrusScript<Ingredient>

index int

Returns

Task<MagicEffect?>

GetNthEffectMagnitude(PapyrusScript<Ingredient>, int)

return the magnitude of the specified effect

public static Task<float> GetNthEffectMagnitude(this PapyrusScript<Ingredient> self, int index)

Parameters

self PapyrusScript<Ingredient>

index int

Returns

Task<float>

GetNumEffects(PapyrusScript<Ingredient>)

SKSE64 additions built 2024-01-17 20:01:40.731000 UTC return the number of the effects

public static Task<int> GetNumEffects(this PapyrusScript<Ingredient> self)

Parameters

self PapyrusScript<Ingredient>

Returns

Task<int>

IsHostile(PapyrusScript<Ingredient>)

Is this ingredient classified as hostile?

public static Task<bool> IsHostile(this PapyrusScript<Ingredient> self)

Parameters

self PapyrusScript<Ingredient>

Returns

Task<bool>

LearnAllEffects(PapyrusScript<Ingredient>)

Flags the all effects as known by the player

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

Parameters

self PapyrusScript<Ingredient>

Returns

Task

LearnEffect(PapyrusScript<Ingredient>, int)

Flags the effect with the given 0 based index as known by the player

public static Task LearnEffect(this PapyrusScript<Ingredient> self, int aiIndex)

Parameters

self PapyrusScript<Ingredient>

aiIndex int

Returns

Task

LearnNextEffect(PapyrusScript<Ingredient>)

Flags the next unknown effect as known by the player, returning index of effect learned

public static Task<int> LearnNextEffect(this PapyrusScript<Ingredient> self)

Parameters

self PapyrusScript<Ingredient>

Returns

Task<int>

SetNthEffectArea(PapyrusScript<Ingredient>, int, int)

sets the area of the specified effect

public static Task SetNthEffectArea(this PapyrusScript<Ingredient> self, int index, int value)

Parameters

self PapyrusScript<Ingredient>

index int

value int

Returns

Task

SetNthEffectDuration(PapyrusScript<Ingredient>, int, int)

sets the duration of the specified effect

public static Task SetNthEffectDuration(this PapyrusScript<Ingredient> self, int index, int value)

Parameters

self PapyrusScript<Ingredient>

index int

value int

Returns

Task

SetNthEffectMagnitude(PapyrusScript<Ingredient>, int, float)

sets the magnitude of the specified effect

public static Task SetNthEffectMagnitude(this PapyrusScript<Ingredient> self, int index, float value)

Parameters

self PapyrusScript<Ingredient>

index int

value float

Returns

Task