Subscribe to download
More Modding Goodies!

This is a mod library. It also includes bug fixes and wishes geared towards modders.

• Deployed turrets had more ammo than they were given.
  
• Turrets could be disarmed or unequipped as if they were an NPC holding a gun. (disabled by default)
  
• In the inventory screen, no gamepad keybinding for 'tooltip' was displayed.

Use lw or lastwish to retrieve any of your prior wishes. Press Esc to traverse backwards in history.

You can wish using C# incantations, if you know the language! Wish cs --help for the in-game help manual.

Use cs or c# and one of the following.

• an expression e.g.
  cs The.Player.DisplayName
• statements e.g.
  cs var newName = "bob"; The.Player.DisplayName = newName; return The.Player.DisplayName;
• a file containing an expression, statements, or full C# source that includes Main(string[] args), placed in either the Wishes directory in Configuration Files[wiki.cavesofqud.com] or the Wishes directory in a mod folder. Then, use -f with its filename to run the wish file. String arguments can be passed to the wish by adding them after the filename e.g.
  cs -f filename arg1 arg2

The following wish files are contained in this mod:

• pick: Picks any GameObject on the screen. You can run code on the picked object by chaining (-c) the wish e.g.
  cs -f pick -c c0.DisplayName = "Jim"
• pickbodypart, removebodypart: Picks or removes a BodyPart.
  
• pickskill, removeskill: Picks or removes a BaseSkill.
  
• pickability, removeability: Picks or removes an ActivatedAbilityEntry.
  
• pickpart, removepart: Picks or removes an IPart.
  
• addpart: Creates and adds the specified IPart to a GameObject e.g.
  cs -f addpart Brain
• nunit: Run NUnit tests. A sample test suite file is provided:
  cs -l nunitsampletest -f nunit
• logcalls: Logs each call of a method or constructor to Player.log, including its parameters, instance, return value, and exceptions.
  cs -f logcalls XRL.World.GameObject:ProcessEnterCell
• dumphistoryspice: Prints the merged history spice json to Player.log.
• dumpblueprints: Prints the merged xml for every blueprint to Player.log.
  
• dumppopulationtables: Prints the merged population tables to Player.log.

These events use IModEventHandler. For usage, see code examples.

• GetIsSkilledWithMissileWeaponEvent: Determines whether a creature is skilled with a MissileWeapon e.g. for adding a new ranged weapon skill tree.
  
• GetCombatMissileEnergyCostEvent: Determines the energy cost of firing a MissileWeapon.
  
• GetMagazineAmmoLoaderReloadEnergyCostEvent: Determines the energy cost of reloading a weapon with the MagazineAmmoLoader part.
  
• AttackerProjectileHitEvent: Raised when an attacker hits a target with a projectile.
  
• ActorShotMissileWeaponCompletingEvent: Raised when an actor is completing an attack with a MissileWeapon.
  
• ActorShotMissileWeaponCompletedEvent: Raised when an actor has completed an attack with a MissileWeapon.

• TurnStartEvent: Raised before the beginning of the turn for each actor. This event occurs before an action is taken.
  
• PlayerTurnStartEvent: Same as above, but only raised for the player.
  
• GetEquipItemEnergyCostEvent: Determines the energy cost of equipping an object.

• FireMissileWeapon: Equivalent to Combat.FireMissileWeapon, except that it accepts 2 additional parameters, WeaponSelection and WeaponSelectionByPart, to select which weapons to fire.
  
• Dismember: Equivalent to Axe_Dismember.Dismember() but has additional parameters and is more amenable to ranged attacks, including appropriate player messaging.
  
• PerformCleave: Similar to Axe_Cleave.PerformCleave() but has additional parameters and bug fixes. The base amount of the cleave is parameterized.

• Popup: Displays a popup to the player.
  
• Message: Adds a message to the player's sidebar.
  
• Notification: Displays a notification to the user that disappears after several seconds.
  
• LoadAndDisplayMessage: Show the animated loading message at the bottom of the screen, with your mod's name ascribed. Useful for long-running tasks such as parsing files.

These logging APIs include fixes for various issues and inconsistencies in vanilla Qud's logging APIs.

• Error: Always provides stack trace. Filename and line numbers are always provided where available. Color code markup is escaped from stack trace output. Provides an optional short message to the player that an error occurred. Copies error to clipboard, and provides user a button to open the mod on the Steam Workshop.
  
• CallerError: This method will assign the error to the mod that called your method. This is useful if other mods, for example, pass invalid parameters to your code.
  
• Warn
  
• CallerWarn
  
• Info
  
• Debug : This log level is disabled by default.
  
• Options to control log verbosity (including popups, player messages, enable/disable debug level) are in Options -> Debug.

• TryParseOption(name, out result, default): Parses string, bool, and int Options.xml options, providing the specified default value if the option is invalid or missing.

• ToDebugString is an extension method for pretty printing any object, including printing its fields and structure recursively.
  
• This is used to pretty print return values from C# Wishes.
  
• Verbosity options in Options -> Debug.

• [RequiredGameSystem]: Attribute for IScribedSystem / IGameSystem to simplify the initialization complexities. It initializes your System whether in a new game, old game, or a savegame that added your mod mid-save. For any custom initialization, OnGameStart(GameObject player) will be called when the game starts.

• ScribedBaseSkill: Similar to BaseSkill, but improved save game compatibility if adding/removing class fields.
  
• ScribedActivePart: Same as above, but for IActivePart.
  
• ScribedPoweredPart: Same as above, but for IPoweredPart.

To use this library in your mod,

1. add it as a Required Item to your mod's steam workshop page, and
2. add it as a Dependency to your mod's manifest.json.

See Documentation for detailed instructions.

See Documentation for more code examples.