Class FTK2API

Static entry point for version information, diagnostics, lifecycle state, and owner registration.

public static class FTK2API

Inherited Members: object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

Register and use runtime services on Unity's main thread. Declare a BepInEx dependency on PluginId so the host is initialized first.

public const string PluginId = "org.ftk2.modapi"

public const string VersionString = "0.5.9"

public static ApiDiagnostics Diagnostics { get; }

public static string GameVersion { get; }

public static IReadOnlyList<ModMetadata> Mods { get; }

public static LifecycleState State { get; }

public static ApiVersion Version { get; }

Registers one mod owner and returns its isolated service context.

public static bool TryRegister(ModMetadata metadata, out IModContext? context, out string? error)

metadata ModMetadata: Stable identity, display metadata, API requirement, and mod dependencies.
context IModContext: The owner-scoped context when registration succeeds.
error string: A diagnostic error code and explanation when registration fails.

Call on Unity's main thread. Re-registering the same owner is rejected.