API 4: Breaking Changes

[goaaats]

Changes

This is a continously updated thread of breaking changes for API 4.

• Position3 was replaced in favor of regular System.Numerics.Vector3, with extension methods
• Actor is now GameObject
• Events throughout the API have been made consistent
  => no "On" prefix according to style, e.g. "OnLogout" -> "Logout"
  => "event" keyword where it was missing
• EasyHook has been replaced by Reloaded
• Extensions to objects outside Dalamud have been moved to Dalamud.Utility
• Various namespace changes
• Various fields were made into properties, some slightly renamed.
• Added a CorePlugin that has access to Dalamud internals, for Dalamud feature development.
• LPL's hot-reloading functionality for plugin development has been incorporated into the plugin installer window.
  • Additional scan paths besides the devPlugins folder can be added via /xlsettings
  • If you don't immediately see the "Scan Dev Plugins" button, it can also be accessed via /xldev
• GameObjects (actors), targets, party list, addons, etc. MOST things are now thin wrappers around ClientStruct objects and read from live memory on every property access. DO NOT SAVE THEM OFF, get a fresh copy every game tick.
• JobGauges now read live from memory. These on the other hand ARE safe to cache, as the data is always at the same location.
  • As a result of using ClientStructs, most offset classes are gone. Use ClientStructs if you need them.
• BaseResolver/WorldResolver/ClassJobResolver is now ExcelResolver.
• Linux user? Try using Wine6.

Migration path

• Update your csproj to a SDK-style one. Here's a sample: https://github.com/goatcorp/SamplePlugin/blob/master/SamplePlugin/SamplePlugin.csproj
• Update your plugin init to the new API: API 4: Plugin API redesign #474
• Fix build errors according to the list of breaking changes
• Set your API level to 4 and add the new properties to your manifest: API 4: Plugin manifest changes #457
• PR your plugin to the api4 branch on DalamudPlugins: https://github.com/goatcorp/DalamudPlugins/tree/api4
• Done!