Class FormIdExtensions

Namespace

SkyrimForge.Game

Assembly

SkyrimForge.Game.dll

Provides extension members for FormId<TForm> and IForm.

public static class FormIdExtensions

Inheritance

object

FormIdExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

get_FormId<TForm>(TForm)

The form's ID, declared as the form's view type.

public static FormId<TForm> get_FormId<TForm>(TForm form) where TForm : struct, IForm

Parameters

form TForm

Returns

FormId<TForm>

Type Parameters

TForm

get_FormOrNull<TForm>(FormId<TForm>)

The form the ID identifies, which each read looks up. Null means no form has the ID or the form is not a TForm.

public static TForm? get_FormOrNull<TForm>(FormId<TForm> id) where TForm : struct, IForm

Parameters

id FormId<TForm>

Returns

TForm?

Type Parameters

TForm

Exceptions

ArgumentException

SkyrimForge.Game.FormCasts declares no cast to TForm.

get_Form<TForm>(FormId<TForm>)

The form the ID identifies, which each read looks up.

public static TForm get_Form<TForm>(FormId<TForm> id) where TForm : struct, IForm

Parameters

id FormId<TForm>

Returns

TForm

Type Parameters

TForm

Exceptions

InvalidOperationException

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

ArgumentException

SkyrimForge.Game.FormCasts declares no cast to TForm.