Class TimbnFrameworkPlugin

Namespace

Timbn.GraveyardKeeperTwo.Core.Framework

Assembly

Timbn.GraveyardKeeperTwo.Core.dll

Non generic base of every Timbn plugin. Handles config, the Enabled gate, Harmony patching, and teardown. Plugins derive from TimbnFrameworkPlugin<T> instead.

public abstract class TimbnFrameworkPlugin : BaseUnityPlugin

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

BaseUnityPlugin

TimbnFrameworkPlugin

Derived

TimbnFrameworkPlugin<T>

Inherited Members

BaseUnityPlugin.Info

BaseUnityPlugin.Logger

BaseUnityPlugin.Config

MonoBehaviour.m_CancellationTokenSource

MonoBehaviour.RaiseCancellation()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.Internal_CancelInvokeAll(MonoBehaviour)

MonoBehaviour.Internal_IsInvokingAll(MonoBehaviour)

MonoBehaviour.InvokeDelayed(MonoBehaviour, string, float, float)

MonoBehaviour.CancelInvoke(MonoBehaviour, string)

MonoBehaviour.IsInvoking(MonoBehaviour, string)

MonoBehaviour.IsObjectMonoBehaviour(Object)

MonoBehaviour.StartCoroutineManaged(string, object)

MonoBehaviour.StartCoroutineManaged2(IEnumerator)

MonoBehaviour.StopCoroutineManaged(Coroutine)

MonoBehaviour.StopCoroutineFromEnumeratorManaged(IEnumerator)

MonoBehaviour.GetScriptClassName()

MonoBehaviour.OnCancellationTokenCreated()

MonoBehaviour.StopCoroutine_Injected(IntPtr, ref ManagedSpanWrapper)

MonoBehaviour.StopAllCoroutines_Injected(IntPtr)

MonoBehaviour.get_useGUILayout_Injected(IntPtr)

MonoBehaviour.set_useGUILayout_Injected(IntPtr, bool)

MonoBehaviour.get_didStart_Injected(IntPtr)

MonoBehaviour.get_didAwake_Injected(IntPtr)

MonoBehaviour.Internal_CancelInvokeAll_Injected(IntPtr)

MonoBehaviour.Internal_IsInvokingAll_Injected(IntPtr)

MonoBehaviour.InvokeDelayed_Injected(IntPtr, ref ManagedSpanWrapper, float, float)

MonoBehaviour.CancelInvoke_Injected(IntPtr, ref ManagedSpanWrapper)

MonoBehaviour.IsInvoking_Injected(IntPtr, ref ManagedSpanWrapper)

MonoBehaviour.IsObjectMonoBehaviour_Injected(IntPtr)

MonoBehaviour.StartCoroutineManaged_Injected(IntPtr, ref ManagedSpanWrapper, object)

MonoBehaviour.StartCoroutineManaged2_Injected(IntPtr, IEnumerator)

MonoBehaviour.StopCoroutineManaged_Injected(IntPtr, IntPtr)

MonoBehaviour.StopCoroutineFromEnumeratorManaged_Injected(IntPtr, IEnumerator)

MonoBehaviour.GetScriptClassName_Injected(IntPtr, out ManagedSpanWrapper)

MonoBehaviour.OnCancellationTokenCreated_Injected(IntPtr)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

Behaviour.get_enabled_Injected(IntPtr)

Behaviour.set_enabled_Injected(IntPtr, bool)

Behaviour.get_isActiveAndEnabled_Injected(IntPtr)

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponentFastPath(Type, IntPtr)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponentsForListInternal(Type, object)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.get_transform_Injected(IntPtr)

Component.get_transformHandle_Injected(IntPtr, out TransformHandle)

Component.get_gameObject_Injected(IntPtr)

Component.GetComponentFastPath_Injected(IntPtr, Type, IntPtr)

Component.GetComponent_Injected(IntPtr, ref ManagedSpanWrapper)

Component.GetComponentsForListInternal_Injected(IntPtr, Type, object)

Component.GetComponentIndex_Injected(IntPtr)

Component.SendMessageUpwards_Injected(IntPtr, ref ManagedSpanWrapper, object, SendMessageOptions)

Component.SendMessage_Injected(IntPtr, ref ManagedSpanWrapper, object, SendMessageOptions)

Component.BroadcastMessage_Injected(IntPtr, ref ManagedSpanWrapper, object, SendMessageOptions)

Component.transform

Component.transformHandle

Component.gameObject

Component.tag

Object.kInstanceID_None

Object.m_CachedPtr

Object.OffsetOfInstanceIDInCPlusPlusObject

Object.objectIsNullMessage

Object.cloneDestroyedMessage

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.CompareBaseObjects(Object, Object)

Object.EnsureRunningOnMainThread()

Object.IsNativeObjectAlive(Object)

Object.GetCachedPtr()

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.CheckNullArgument(object, string)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.GetOffsetOfInstanceIDInCPlusPlusObject()

Object.CurrentThreadIsMainThread()

Object.Internal_CloneSingle(Object)

Object.Internal_CloneSingleWithScene(Object, Scene)

Object.Internal_CloneSingleWithParams(Object, InstantiateParameters)

Object.Internal_InstantiateSingleWithParams(Object, Vector3, Quaternion, InstantiateParameters)

Object.Internal_CloneSingleWithParent(Object, Transform, bool)

Object.Internal_InstantiateAsyncWithParams(Object, int, InstantiateParameters, IntPtr, int, IntPtr, int)

Object.Internal_InstantiateSingle(Object, Vector3, Quaternion)

Object.Internal_InstantiateSingleWithParent(Object, Transform, Vector3, Quaternion)

Object.ToString(Object)

Object.GetName()

Object.IsPersistent(Object)

Object.SetName(string)

Object.DoesObjectWithInstanceIDExist(EntityId)

Object.FindObjectFromInstanceID(EntityId)

Object.GetPtrFromInstanceID(EntityId, Type, out bool)

Object.ForceLoadFromInstanceID(EntityId)

Object.MarkDirty()

Object.Destroy_Injected(IntPtr, float)

Object.DestroyImmediate_Injected(IntPtr, bool)

Object.DontDestroyOnLoad_Injected(IntPtr)

Object.get_hideFlags_Injected(IntPtr)

Object.set_hideFlags_Injected(IntPtr, HideFlags)

Object.Internal_CloneSingle_Injected(IntPtr)

Object.Internal_CloneSingleWithScene_Injected(IntPtr, ref Scene)

Object.Internal_CloneSingleWithParams_Injected(IntPtr, ref InstantiateParameters)

Object.Internal_InstantiateSingleWithParams_Injected(IntPtr, ref Vector3, ref Quaternion, ref InstantiateParameters)

Object.Internal_CloneSingleWithParent_Injected(IntPtr, IntPtr, bool)

Object.Internal_InstantiateAsyncWithParams_Injected(IntPtr, int, ref InstantiateParameters, IntPtr, int, IntPtr, int)

Object.Internal_InstantiateSingle_Injected(IntPtr, ref Vector3, ref Quaternion)

Object.Internal_InstantiateSingleWithParent_Injected(IntPtr, IntPtr, ref Vector3, ref Quaternion)

Object.ToString_Injected(IntPtr, out ManagedSpanWrapper)

Object.GetName_Injected(IntPtr, out ManagedSpanWrapper)

Object.IsPersistent_Injected(IntPtr)

Object.SetName_Injected(IntPtr, ref ManagedSpanWrapper)

Object.DoesObjectWithInstanceIDExist_Injected(ref EntityId)

Object.FindObjectFromInstanceID_Injected(ref EntityId)

Object.GetPtrFromInstanceID_Injected(ref EntityId, Type, out bool)

Object.ForceLoadFromInstanceID_Injected(ref EntityId)

Object.MarkDirty_Injected(IntPtr)

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

TimbnFrameworkPlugin()

protected TimbnFrameworkPlugin()

Properties

Audio

Plays the game's own music for the plugin, put back the way it was when the plugin is done.

public TimbnPluginAudio Audio { get; }

Property Value

TimbnPluginAudio

Balance

Adds definitions to the game's balance tables that are removed when this plugin unloads.

public TimbnPluginBalance Balance { get; }

Property Value

TimbnPluginBalance

Clock

Changes how fast the game's time runs, undone when this plugin unloads.

public TimbnPluginClock Clock { get; }

Property Value

TimbnPluginClock

Crafts

Adds crafts at the game's stations or the plugin's own that are removed when this plugin unloads.

public TimbnPluginCrafts Crafts { get; }

Property Value

TimbnPluginCrafts

Dialog

Gives NPCs conversations that are removed when this plugin unloads.

public TimbnPluginDialog Dialog { get; }

Property Value

TimbnPluginDialog

Events

Subscribes this plugin to the game's events. Every subscription is removed when the plugin unloads, and events that belong to a save follow every save the player loads.

public TimbnPluginEvents Events { get; }

Property Value

TimbnPluginEvents

MainMenu

Shows lines of text and popups on the main menu, removed again when this plugin unloads.

public TimbnPluginMainMenu MainMenu { get; }

Property Value

TimbnPluginMainMenu

Metadata

The plugin's own BepInPlugin attribute. Use this instead of Info.

protected BepInPlugin Metadata { get; }

Property Value

BepInPlugin

Models

Builds 3D models from the plugin's PNGs and uses them in the world, all freed when this plugin unloads.

public TimbnPluginModels Models { get; }

Property Value

TimbnPluginModels

Npcs

Walks and adds people and gives them a day on the game clock, with every walk, claim and added person undone when this plugin unloads.

public TimbnPluginNpcs Npcs { get; }

Property Value

TimbnPluginNpcs

Player

Acts on the player character, such as holding them still, undone when this plugin unloads.

public TimbnPluginPlayer Player { get; }

Property Value

TimbnPluginPlayer

Potions

Adds potions that are removed when this plugin unloads.

public TimbnPluginPotions Potions { get; }

Property Value

TimbnPluginPotions

Quests

Adds quests that are removed when this plugin unloads.

public TimbnPluginQuests Quests { get; }

Property Value

TimbnPluginQuests

Saves

Keeps the plugin's own data with each save, in a file next to the game's save.

public TimbnPluginSaves Saves { get; }

Property Value

TimbnPluginSaves

Settings

Keeps the plugin's changes to the game in step with its config as settings change.

public TimbnPluginSettings Settings { get; }

Property Value

TimbnPluginSettings

Sprites

Adds custom sprites, such as item and buff icons, that are removed when this plugin unloads.

public TimbnPluginSprites Sprites { get; }

Property Value

TimbnPluginSprites

Stations

Adds buildable workstations and bench extensions, offered at a build desk, that are removed when this plugin unloads.

public TimbnPluginStations Stations { get; }

Property Value

TimbnPluginStations

Techs

Adds technologies to the tech tree, bought with tech points and removed when this plugin unloads.

public TimbnPluginTechs Techs { get; }

Property Value

TimbnPluginTechs

Text

Adds or overrides the game's text, removed again when this plugin unloads.

public TimbnPluginText Text { get; }

Property Value

TimbnPluginText

UI

Puts the plugin's own hints and IMGUI on screen, taken down when this plugin unloads.

public TimbnPluginUI UI { get; }

Property Value

TimbnPluginUI

Methods

BindConfig(ConfigFile)

Binds the plugin's own settings. Runs before OnAwake, whether or not the plugin is enabled.

protected virtual void BindConfig(ConfigFile config)

Parameters

config ConfigFile

IsFeatureBroken(string)

Whether a feature's patches failed to apply, which happens when a game update renamed or removed something they target. The feature is named by the TimbnFeatureAttribute on its patch classes, and its config toggle reads as off through Settings.Toggle and Settings.While while it is broken. Check it by hand for code that reads the toggle directly.

public bool IsFeatureBroken(string feature)

Parameters

feature string

The feature's name, the key of its config entry.

Returns

bool

True when the feature's patches are not applied.

OnAwake()

Runs once at startup if the plugin is enabled, after config is bound and patches are applied.

protected virtual void OnAwake()

OnUnload()

Runs when the plugin unloads, before Core removes everything the plugin registered and its Harmony patches. Put back anything the plugin changed in the game directly, such as a value it set or a GameObject it created. Registrations made through Events, Settings, Potions, Quests, Dialog, Text, Sprites, Balance, MainMenu, Player, Clock, UI, Saves, Npcs, Audio, Models, Stations, Crafts and Techs are cleaned up for you, and cleanup that belongs to a save is better placed in Events.SaveClosed, which also runs on the way to the main menu.

protected virtual void OnUnload()

OnUpdate()

Runs every frame while the plugin is enabled.

protected virtual void OnUpdate()