Struct GameFunction

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

A game function, by its Address Library identifier on each runtime.

public readonly struct GameFunction : IEquatable<GameFunction>

Implements

IEquatable<GameFunction>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

The identifiers live here and nowhere else. The native side resolves what it is given and declares no table of its own, so no second list can drift from this one. The binding generator writes a member for each function CommonLib relocates that this repository names, such as DialogueItem__Ctor for DialogueItem::Ctor. A plugin constructs one for any other function, from that function's identifiers.

An identifier the address library does not name resolves to the next one along instead of reporting it missing, CommonLib comparing what it found against the identifier it was given only on VR. The shim therefore confirms an identifier before resolving it, and an identifier the library lacks resolves to no address.

Constructors

GameFunction(ulong, ulong)

Names a function on Special Edition and Anniversary Edition, using the Special Edition identifier for VR as CommonLib does.

public GameFunction(ulong specialEditionAndVR, ulong anniversaryEdition)

Parameters

specialEditionAndVR ulong

anniversaryEdition ulong

GameFunction(ulong, ulong, ulong)

A game function, by its Address Library identifier on each runtime.

public GameFunction(ulong SpecialEdition, ulong AnniversaryEdition, ulong VR)

Parameters

SpecialEdition ulong

The identifier on Skyrim Special Edition.

AnniversaryEdition ulong

The identifier on Anniversary Edition.

VR ulong

The identifier on Skyrim VR, which is the Special Edition one where nothing states another.

Remarks

The identifiers live here and nowhere else. The native side resolves what it is given and declares no table of its own, so no second list can drift from this one. The binding generator writes a member for each function CommonLib relocates that this repository names, such as DialogueItem__Ctor for DialogueItem::Ctor. A plugin constructs one for any other function, from that function's identifiers.

An identifier the address library does not name resolves to the next one along instead of reporting it missing, CommonLib comparing what it found against the identifier it was given only on VR. The shim therefore confirms an identifier before resolving it, and an identifier the library lacks resolves to no address.

Properties

AnniversaryEdition

The identifier on Anniversary Edition.

public ulong AnniversaryEdition { get; init; }

Property Value

ulong

BGSStoryEventManager__AddEvent_Impl

RE::BGSStoryEventManager::AddEvent_Impl, by the identifiers CommonLib states for it.

public static GameFunction BGSStoryEventManager__AddEvent_Impl { get; }

Property Value

GameFunction

BookMenu__OpenMenu_Impl

RE::BookMenu::OpenMenu_Impl, by the identifiers CommonLib states for it.

public static GameFunction BookMenu__OpenMenu_Impl { get; }

Property Value

GameFunction

DialogueItem__Ctor

RE::DialogueItem::Ctor, by the identifiers CommonLib states for it.

public static GameFunction DialogueItem__Ctor { get; }

Property Value

GameFunction

MainLoop

The game's main loop, which calls Main__Update once a frame.

public static GameFunction MainLoop { get; }

Property Value

GameFunction

Main__Update

The game's own work for one frame, called from MainLoop.

public static GameFunction Main__Update { get; }

Property Value

GameFunction

SpecialEdition

The identifier on Skyrim Special Edition.

public ulong SpecialEdition { get; init; }

Property Value

ulong

TESQuest__GetJournalTextForInstance

RE::TESQuest::GetJournalTextForInstance, by the identifiers CommonLib states for it.

public static GameFunction TESQuest__GetJournalTextForInstance { get; }

Property Value

GameFunction

VR

The identifier on Skyrim VR, which is the Special Edition one where nothing states another.

public ulong VR { get; init; }

Property Value

ulong

Methods

Deconstruct(out ulong, out ulong, out ulong)

public void Deconstruct(out ulong SpecialEdition, out ulong AnniversaryEdition, out ulong VR)

Parameters

SpecialEdition ulong

AnniversaryEdition ulong

VR ulong

Equals(GameFunction)

public bool Equals(GameFunction other)

Parameters

other GameFunction

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(GameFunction, GameFunction)

public static bool operator ==(GameFunction left, GameFunction right)

Parameters

left GameFunction

right GameFunction

Returns

bool

operator !=(GameFunction, GameFunction)

public static bool operator !=(GameFunction left, GameFunction right)

Parameters

left GameFunction

right GameFunction

Returns

bool