Skip to content
This repository has been archived by the owner on Apr 8, 2023. It is now read-only.

Latest commit

 

History

History
33 lines (23 loc) · 3.26 KB

modding.md

File metadata and controls

33 lines (23 loc) · 3.26 KB
Raw

Tools for Modders

Tutorial: Refererencing Other Mods

To use public members of another mod in your own, you must perform ALL of these steps:

  • Add the other mod's DLL as a dependency in your VS project.
  • Add [BepInExDependency("full.mod.id", BepInDependency.DependencyFlags.SoftDependency)] to your main plugin to ensure that it always loads after the other mod, if the other mod is present.
  • Put any code referencing any part of the other mod in a standalone method with the following attribute: [MethodImpl(MethodImplOptions.NoInlining | MethodImplOptions.NoOptimization)] (requres using System.Runtime.CompilerServices;). This will prevent the compiler from trying to access the other mod's code when it might not exist.
  • DO NOT use any of these standalone methods without checking for BepInEx.Bootstrap.Chainloader.PluginInfos.ContainsKey("full.mod.id") first.

See this source file for a partial example.

Documentation

The following public members of ClassicItems are explicitly intended to help increase compatibility with other mods.

Beating Embryo

  • public void ThinkInvisible. ClassicItems.Embryo.RegisterHook(EquipmentDef def, string descAppendToken = null, Func<string> configDisplayNameDelegate = null, Action installHooksDelegate = null, Action uninstallHooksDelegate = null, Action<CharacterBody> addComponentsDelegate = null, Action setupAttributesDelegate = null, Action setupConfigDelegate = null)
    • Registers an equipment with a Beating Embryo enabled config.
    • Optionally applies a description append token + config display name (latter will otherwise use equipment name token). Description append token will appear when a player with Beating Embryo mouses over a supported equipment in inventory.
    • Provides optional delegates for all setup/install methods available to internal Embryo hooks.
  • public bool ThinkInvisible.ClassicItems.Embryo.CheckLastEmbryoProc(CharacterBody body -OR- EquipmentSlot slot, optional EquipmentDef def)
    • At the start of EquipmentSlot.PerformEquipmentAction, a single roll for Beating Embryo procs will be performed and its value stored on the EquipmentSlot. This method returns whatever the value of that roll was.
    • Equal to 0 if no proc, 1+ if a proc occurred and the equipment effect should be doubled. Values above 1 may occur when multi-stacking is enabled in the config; it is recommended to implement linear stacking in this case (activate or increase effects by 2x, 3x, 4x, etc.).
    • If an EquipmentDef is provided, will return 0 if Beating Embryo is disabled globally, disabled for that EquipmentDef, or does not support that EquipmentDef. This argument should be provided whenever possible.
  • public void ThinkInvisible.ClassicItems.Embryo.GetEmbryoEnabled(EquipmentDef def)
    • Returns true if Beating Embryo is enabled and has an enabled hook for a specific EquipmentDef.

Ancient Scepter

  • public bool ThinkInvisible.ClassicItems.Scepter.instance.RegisterScepterSkill(SkillDef replacingDef, string targetBodyName, SkillSlot targetSlot, SkillDef targetVariantDef -or- int targetVariant): Add a SkillDef to the library of skill replacers for when an Ancient Scepter is obtained. Returns true on success. TargetVariant int exists only to support vanilla skills and may be deprecated in future.