Class FormExtensions

Namespace

SkyrimForge.Game

Assembly

SkyrimForge.Game.dll

Provides extension members for Form.

public static class FormExtensions

Inheritance

object

FormExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

GetByEditorId(string)

Gets the form with editorId.

public static Form GetByEditorId(string editorId)

Parameters

editorId string

The editor ID.

Returns

Form

The form.

Remarks

The game retains editor IDs only for keywords and a few other form types.

Exceptions

ArgumentNullException

editorId is null.

InvalidOperationException

No form has editorId.

GetByEditorId<TForm>(string)

Gets the form with editorId as a TForm.

public static TForm GetByEditorId<TForm>(string editorId) where TForm : struct, IForm

Parameters

editorId string

The editor ID.

Returns

TForm

The form.

Type Parameters

TForm

Remarks

The game retains editor IDs only for keywords and a few other form types.

Exceptions

ArgumentNullException

editorId is null.

InvalidOperationException

No form has editorId, or the form is not a TForm.

ArgumentException

SkyrimForge.Game.FormCasts declares no cast to TForm.