Class FormListScript

Namespace

SkyrimForge.Papyrus

Assembly

SkyrimForge.Game.dll

Functions and comments from FormList.psc.

public static class FormListScript

Inheritance

object

FormListScript

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

AddForm(PapyrusScript<FormList>, IForm)

Adds the given form to this form list

[Obsolete("Uses the Papyrus virtual machine. Prefer FormList.AddForm(Form).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task AddForm(this PapyrusScript<FormList> self, IForm apForm)

Parameters

self PapyrusScript<FormList>

apForm IForm

Returns

Task

AddForms<TForm>(PapyrusScript<FormList>, IReadOnlyCollection<TForm>)

Adds an Array of Forms to this list

public static Task AddForms<TForm>(this PapyrusScript<FormList> self, IReadOnlyCollection<TForm> forms) where TForm : notnull, IForm

Parameters

self PapyrusScript<FormList>

forms IReadOnlyCollection<TForm>

Returns

Task

Type Parameters

TForm

Find(PapyrusScript<FormList>, IForm)

Finds the specified form in the form list and returns its index. If not found, returns a negative number

public static Task<int> Find(this PapyrusScript<FormList> self, IForm apForm)

Parameters

self PapyrusScript<FormList>

apForm IForm

Returns

Task<int>

GetAt(PapyrusScript<FormList>, int)

Returns the form at index 'aiIndex' in the list

public static Task<Form?> GetAt(this PapyrusScript<FormList> self, int aiIndex)

Parameters

self PapyrusScript<FormList>

aiIndex int

Returns

Task<Form?>

GetSize(PapyrusScript<FormList>)

Returns the number of forms in the list

public static Task<int> GetSize(this PapyrusScript<FormList> self)

Parameters

self PapyrusScript<FormList>

Returns

Task<int>

HasForm(PapyrusScript<FormList>, IForm)

Queries the form list to see if it contains the passed in form

[Obsolete("Uses the Papyrus virtual machine. Prefer FormList.HasForm(Form).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> HasForm(this PapyrusScript<FormList> self, IForm akForm)

Parameters

self PapyrusScript<FormList>

akForm IForm

Returns

Task<bool>

RemoveAddedForm(PapyrusScript<FormList>, IForm)

Removes the given added form from this form list

public static Task RemoveAddedForm(this PapyrusScript<FormList> self, IForm apForm)

Parameters

self PapyrusScript<FormList>

apForm IForm

Returns

Task

Revert(PapyrusScript<FormList>)

Removes all script added forms from this form list

public static Task Revert(this PapyrusScript<FormList> self)

Parameters

self PapyrusScript<FormList>

Returns

Task

ToArray(PapyrusScript<FormList>)

SKSE64 additions built 2024-01-17 20:01:40.731000 UTC Returns a Form array of this list (Invalid entries will be None)

public static Task<Form?[]> ToArray(this PapyrusScript<FormList> self)

Parameters

self PapyrusScript<FormList>

Returns

Task<Form?[]>