| FFXIVClientStructs

Updated to commit 826c9de4d409b0539a5f600193d7f8ff5c834210

Breaking Changes

ActionManager
- Removed GetDutyActionId as it has been moved to DutyActionManager
AgentInventoryContext
- Changed UseItem method's inventoryType parameter from uint to InventoryType and set its default value to InventoryType.Invalid
AgentModule
- Removed UIModuleAgentModulePtr field and replaced it with AgentHelpers field
AgentId
- Renamed Request value to NpcTrade
AgentRequest
- Renamed to AgentNpcTrade
AgentSalvage
- Updated ItemListRefresh method to include a bool parameter isSalvageResultAddonOpen
AgentContext
- Updated AddContextMenuItem2 method:
  - Removed copyText parameter
AgentCharaCard
- Added a 2nd param to OpenCharaCardForPacket of type bool
AgentMap
- Changed 3 fields from byte to bool
  - IsFlagMarkerSet
  - IsPlayerMoving
  - IsControlKeyPressed
BannerModule
- Updated GetNextId method to return an int instead of a byte
BlackMageGauge
- Removed ElementTimeRemaining field
BgPartsLayoutInstance
- Changed type of GraphicsObject field from void* to BgObject*
Camera
- Changed return type of ScreenPointToRay method from void to Ray*
CharaView
- Removed IsAnimationPaused and ToggleAnimationPlayback methods, as they belong to CharaViewPortrait
CharaViewPortrait
- Removed ICreatable interface implementation
- Removed Create method
- Changed Ctor method to return a CharaViewPortrait* instead of void
- Added IsAnimationPaused and ToggleAnimationPlayback methods, which were previously in CharaView
Device
- Changed type of ImmediateContext field from void* to ImmediateContext*
- Changed type of textureFormat parameter in CreateTexture2D method from uint to TextureFormat
EventId
- Changed ContentId field from EventHandlerType to EventHandlerContent
EventHandlerType
- Renamed to EventHandlerContent
ExdModule
- Updated GetBannerConditionUnlockState method to return an int instead of a byte
ExcelSheet
- Removed the Name property, which was using Marshal.PtrToStringUTF8 to convert the byte* SheetName field to a string
FateContext
- Changed 2 fields
  - Music type changed from int to ushort
  - FateRuleEx type changed from byte to ushort
GameMain
- Changed type of CurrentTerritoryIntendedUseId field from uint to byte
HousingManager
- Renamed GetCurrentHouseId to GetCurrentIndoorHouseId
- Changed return type of GetCurrentIndoorHouseId and GetOwnedHouseId from long to HouseId
HousingSignboardPacket
- Renamed OwnerType to EstateType and updated its summary to reference Game.EstateType
IndoorTerritory
- Changed type of HouseId field from long to HouseId
InventoryItem
- Renamed Spiritbond field to SpiritbondOrCollectability
- Changed return type of EqualTo from void to bool
Inspect
- Changed type of GearVisibilityFlag field from byte to InspectGearVisibilityFlag
LootItem
- Changed type of RollValue field from uint to byte
Map
- Changed field name ActiveLevequestMarkers to ActiveLevequestMarker
- Changed type of ActiveLevequestMarker field from StdVector<MapMarkerData> to MarkerInfo
MaterialResourceHandle
- Changed parameters of ReadStainingTemplate method from (byte stainId, Half* colorTable) to (Half* colorTable, byte stainId, byte* a4)
MaterialResourceHandle
- Removed 6 properties that were used to convert the byte* to a ReadOnlySpan<byte> and then to a string using Encoding.UTF8.GetString
  - ShpkNameSpan
  - ShpkNameString
  - TexturePathSpan(int index)
  - TexturePathString(int index)
  - AttributeNameSpan(int index)
  - AttributeNameString(int index)
MaterialResourceHandle
- Removed 2 properties that were used to convert the byte* to a ReadOnlySpan<byte> and then to a string using Encoding.UTF8.GetString
  - GetMaterialFileNameBySlotAsSpan(uint slot)
  - GetMaterialFileNameBySlotAsString(uint slot)
OutdoorTerritory
- Changed type of HouseId field from long to HouseId
PartyMember
- Replaced _extraProperties field with _contentKeyValueData of type FixedSizeArray3<StdPair<uint, uint>>
QuestManager
- Changed 2 properties to getters instead of direct fields:
  - NumAcceptedQuests
  - NumAcceptedLeveQuests
RollState
- Changed underlying type from implicit int to explicit byte
RaptureTextModule
- Removed FormatName method and related enums NameFormatterPlaceholder and NameFormatterIdConverter
RaptureAtkModule
- Changed type of _inventoryItemCache field from FixedSizeArray<InventoryCache> to FixedSizeArray<ItemCache>
Status
- Removed StackCount field, use Param instead
SubView
- Changed type of Camera field from void* to Camera*
SchedulerResourceManagement
- Removed Unknown field
- Removed NumResources field
- Added Resources field of type StdMap<int, SchedulerResource>
SteamApi
- Updated Ctor method to return a SteamApi* instead of void
StringPointer
- Changed the constructor to take a byte* parameter and initialize the Value field with it
- Moved to InteropGenerator.Runtime
- Renamed to CStringPointer
ScreenShot
- Renamed CallbackFirstArg to CallbackParam
- Changed ScreenShotCallbackFunc delegate field from byte return to void
- Changed ScheduleScreenShot(delegate* unmanaged<void*, int, byte> callback, void* initialArg) to ScheduleScreenShot(delegate* unmanaged<void*, int, void> callback, void* callbackParam)
- Removed ScheduleScreenShot()
UIState
- Changed type of TerritoryTypeTransientOffsetZ field from float to int
WorkshopTerritory
- Changed type of HouseId field from long to HouseId
Texture
- CreateTexture2D
  - Changed type of textureFormat parameter from uint to TextureFormat
  - changed type of flags parameter from uint to TextureFlags
- Flags field has been changed from uint to TextureFlags
TerrainManager
- Changed type of GfxTerrain field from void* to Terrain*
PacketDispatcher
- Changed HandleSocialPacket method to be static and added uint targetId parameter
- Changed HandleMarketBoardItemRequestStartPacket method to be static and added uint targetId parameter
- Changed HandleMarketBoardPurchasePacket method to be static and added uint targetId parameter
UIModuleAgentModulePtrStruct
- Removed
UIModuleInterface
- Removed GetUIModuleAgentModulePtr method, replaced with GetAgentHelpers method
The following classes have updated Dtor methods to return a pointer to the class instance instead of void
- CharacterData
- NpcTrade
- InstanceData
- InstanceList
- ILayoutInstance
- IManagerBase
- RecipeSearchContext
- Object
- SceneManager
- AtkEventListener
- Resource
Multiple structs have been updated to use CStringPointer instead of byte* for string fields, virtual functions, member functions
- AtkAddonControl
  - Unk0
- AtkComponentList
  - GetItemLabel
  - SetItemLabel
- AtkComponentList.ListItem
  - Label
- AtkComponentTextInput
  - SetText
  - InsertText
- AtkComponentTextNineGrid
  - SetText
- AtkComponentButton
  - SetText
- AtkComponentTreeList
  - StringValues
- AtkCounterNode
  - SetText
- AtkImageNode
  - LoadTexture
- AtkMessageBoxManager
  - OkText
  - CancelText
  - YesText
  - NoText
- AtkTextNode
  - OriginalTextPointer
  - GetText
  - SetText
- AtkTooltipManager
  - Text
  - ShowTooltip
- AtkTexture
  - LoadTexture
- AtkValue
  - String
  - SetManagedString
  - SetVectorString
- AtkUnitBase
  - CachedAtkValueStrings
  - LoadUldByName
- AtkUnitManager
  - GetAddonByName
- ActionTimelineManager
  - Key
- AddonAOZNotebook
  - Name
- ActiveAction
  - Name
- AddonActionBarBase
  - PopUpHelpTextPtr
- AddonActionMenu
  - ActionText
  - TooltipText
- AddonFieldMarker
  - TooltipString
- AddonJobHudBRD
  - SongTitle
- AddonNeedGreed
  - ItemName
- AddonSalvageItemSelector
  - NamePtr
  - JobNamePtr
- AgentChatLog
  - ChangeChannelName
- AgentContext
  - ContextTitleString
  - OpenYesNo
  - SetMenuTitle
  - AddMenuItem
  - AddContextMenuItem
- AgentHUD
  - GetMainCommandString
- AgentMap
  - Subtext
- AgentPartyMember
  - Promote
  - Kick
- AgentMutelist
  - Add
- AgentShop
  - ShopName
- AgentTermFilter
  - OpenNewFilterWindow
- AozNoteModule
  - GetActiveSetCustomNamePtr
  - SetActiveSetCustomName
- CharacterBase
  - ResolveRootPath
  - ResolveSklbPath
  - ResolveMdlPath
  - ResolveSkpPath
  - ResolvePhybPath
  - ResolvePapPath
  - ResolveTmbPath
  - ResolveMaterialPapPath
  - ResolveImcPath
  - ResolveMtrlPath
  - ResolveDecalPath
  - ResolveVfxPath
  - ResolveEidPath
- ConfigBase
  - Name
- CharacterManager
  - LookupBattleCharaByName
- Cursor
  - _cursorNames
- Device
  - CreateTexture2D
- ExcelSheet
  - SheetName
- Common.Component.Excel.ExcelModuleInterface
  - GetSheetByName
  - LoadSheet
- Component.Excel.ExcelModuleInterface
  - GetSheetByName
- ExdModule
  - GetRowCountBySheetName
  - GetSheetByName
- FileSceneGeneral
  - PathTerrain
  - PathSkyVisibility
  - PathLCB
- FileLayerGroupHeader
  - LayerGroupName
- FileLayerGroupLayer
  - LayerName
- FileLayerGroupInstance
  - Name
- FileLayerGroupInstanceBgPart
  - PathMdl
  - PathPcb
- FileLayerGroupInstanceSharedGroup
  - Path
- FileLayerGroupInstanceCollisionBox
  - Path
- GoldSaucerModule
  - SetDeckName
- HudPartyMember
  - Name
- hkClassNameRegistry
  - GetClassByName
- hkIstream
  - Ctor2
  - getline
- hkOstream
  - Ctor
- hkResource
  - GetContentsPointer
- hkRootLevelContainer
  - findObjectByType
  - findObjectByName
- ILayoutInstance
  - GetPrimaryPath
  - GetSecondaryPath
- InfoModule
  - GetLocalCharacterName
- InfoProxyBlacklist
  - Name
- InfoProxyChat
  - GetLinkShellName
- InfoProxyCrossRealm
  - NameOverride
- InfoProxyLinkShell
  - GetLinkshellName
- InfoProxyCommonList
  - GetEntryByName
- InfoProxyDetail
  - SetUpdateSearchComment
- InfoProxyNoviceNetwork
  - InviteToNoviceNetwork
- InfoProxyPartyInvite
  - InviteToParty
- LayoutWorld
  - RsvMap
  - RsfMap
  - LoadPrefetchLayout
  - ResolveRsvString
  - ResolveRsfEntry
- lua_State
  - lua_tolstring
  - lua_tostring
  - lua_setfield
  - lua_getfield
  - luaL_loadbuffer
  - luaL_loadfile
- MaterialResourceHandle
  - ShpkName
  - TexturePath
  - AttributeSetName
- ModelResourceHandle
  - Attributes
  - Shapes
  - GetMaterialFileNameBySlot
- MacroEncoder
  - EncodeMacro
  - EncodeString
- NameCache
  - SetNameForContentId
- PopupMenu
  - EntryNames
- PronounModule
  - ResolvePlaceholder
- RaptureHotbarModule
  - GetDisplayNameForSlot
- RaptureLogModule
  - Name
  - PrintString
- RaptureAtkModule
  - OpenAddonByAgent
  - ShowTextGimmickHint
  - OpenMapWithMapLink
- RaptureAtkUnitManager
  - InitializeAddon
- RaptureTextModule
  - GetAddonText
  - FormatAddonText1IntIntUInt
  - FormatAddonText2IntInt
  - FormatTimeSpan
- RetainerCommentModule
  - GetComment
  - SetComment
- Resource
  - GetPath
- ResourceManager
  - GetResourceSync
  - GetResourceAsync
- RaptureUiDataModule
  - Add
  - UpdateComment
- SchedulerTimeline
  - ActionTimelineKey
  - FaceLibraryPath
- StringThing
  - FullSealsText
  - OneOrMoreLinesText
  - SecondChancePointsText
  - ReceiveSealCompleteText
  - ReceiveSealIncompleteText
  - SecondChanceRetryText
- StringArrayData
  - SetValue
- TextParameter
  - StringValue
- TextModule
  - FormatString
- TextModuleInterface
  - EncodeMacro
  - ProcessMacroCode
- Utf8String
  - StringPtr
  - SetString
  - EqualToString
  - ConcatCStr
- UIGlobals
  - IsValidPlayerCharacterName
- UIModule
  - IsPlayerCharacterName
- UIModuleInterface
  - ShowText
  - ShowWideText
  - ShowPoisonText
  - ShowErrorText
  - ShowBattleTalk
  - ShowBattleTalkImage
  - ShowBattleTalkSound

Changes

AddonChatLogPanel
- Added 3 new fields
  - ResizeButton
  - PanelCollisionNode
  - IsResizing
AgentHUD
- Added 2 new field:
  - _targetInfoBuffTimeRemainingCache
  - Status
  - ExpFlags
- Added 3 new methods
  - UpdateExp
  - UpdateTargetInfo
  - UpdateStatusDisplay
AgentMiragePrismPrismSetConvert
- Added field Data
AddonMiragePrismPrismBox
- Added field EditGlamourPlatesButton
AgentSalvage
- Added method SalvageItem
AgentItemDetail
- Added 2 fields
  - BuyQuantity
  - MaxStackSize
  - String2
AtkEventType
- Added new event types
  - Resize (21)
  - ValueUpdate (27)
  - SliderReleased (30)
  - ListItemClick (35)
  - ListItemDoubleClick (36)
  - ListItemSelect (38)
  - DragDropEnd (51)
  - DialogueClose (62)
  - DialogueSubmit (63)
- Renamed some event types for clarity:
  - NumericInputUpdate to ValueUpdate
  - ListItemToggle to ListItemClick
  - UnkAtkDialogue59 to DialogueClose
  - UnkAtkDialogue60 to DialogueSubmit
AtkUldManager
- Added Nodes field
AtkUnitBase
- Added Param field
ActionManager
- Added 3 new fields
  - QueuedExtraParam
  - AreaTargetingVfx1
  - AreaTargetingVfx2
BattleChara
- Added VirtualTable attribute
CharacterManager
- Added inheritance from CharacterManagerInterface
CharacterBase
- Added field Attach
Companion
- Added VirtualTable attribute
Collider
- Added GetBoundingBox virtual function
Camera
- Added field FoV_2
CStringPointer
- Added 4 new implicit operators
  - byte* to CStringPointer
  - CStringPointer to ReadOnlySpan<byte>
  - CStringPointer to string (calls the ToString() method)
Control
- Added 2 new methods
  - GetFlightAllowedStatus
  - CanFly
DutyActionManager
- Added GetDutyActionId method
ExcelSheet
- Added 2 new fields
  - Language of type ExcelModuleInterface.ExcelLanguage at offset 0x8
  - Variant of type ExcelVariant at offset 0xC8
EventFramework
- Added 2 new methods:
  - MaterializeItem(EventId eventID, InventoryType inventoryType, short inventorySlot, int extraParam = 0)
  - MaterializeItem(InventoryItem* itemSlot, MaterializeEntryId entryId)
FateContext
- Added 7 new fields
  - _objectives
  - FateModeUnknown0
  - FateModeMotivationIcon
  - FateModeMotivationMapMarker
  - FateModeObjectiveIcon
  - FateModeObjectiveMapMarker
  - _mapMarkers
GroupManager
- Added inheritance from CharacterManagerInterface
GameObject
- Added 3 new virtual functions
  - Terminate
  - Dtor (destructor)
  - OnInitialize
- Added 1 new member function
  - GetObjStrId
HousingTerritory
- Added 3 new virtual functions
  - Dtor (destructor)
  - Update
  - IsLoaded
HousingManager
- Added 2 new member functions
  - IsOutside
  - IsInWorkshop
HousingSignboardPacket
- Added field _FCTag
IndoorTerritory
- Added 2 field
  - SSAOEnable
  - CurrentFloor
InventoryManager
- Added several new fields
  - _tradeItemsLocal
  - _tradeItemsRemote
  - TradeUnk2178
  - TradeUnk217C
  - TradeUnk2180
  - _tradePartnerName
  - TradePartnerEntityId
  - TradeUnk21A8
  - TradeWarnIfMovedTooFar
  - TradeIsSyncPending
  - GearsetPortraitData
  - GearsetReplaceItemSelectYesNoAddonId
  - GearsetId
  - UnkInventoryItem0
  - UnkInventoryItem1
InputData
- Added 3 new fields
  - ButtonsPressed
  - ButtonsReleased
  - ButtonsRepeat
ItemDetailKind
- Added ShopItem enum
LayoutWorld
- Changed size of _streamingRadiusPerType array from FixedSizeArray90 to FixedSizeArray92
LogViewer
- Added 2 new fields
  - IsMaximized
  - IsSelectingText
Map
- Added AddHousingMarker method
ModelRenderer
- Added SkiningConnectionVertexCS field
ModelResourceHandle
- Added 2 fields
  - ModelData
  - MaterialResourceHandles
NumberArrayType
- Added new type
  - OrchestrionPlayListSelect
PartyMember
- Added GetContentValue method to retrieve content value by key
PadDeviceInterface
- Added virtual function Poll
RecipeNote.RecipeData
- Added RecipeCount field
StringArrayType
- Added new type
  - OrchestrionPlayListSelect
Skeleton
- Added 5 new fields
  - AttachBones
  - AttachBoneCount
  - AttachBoneMasks
  - AttachBonesSpan
  - BoneMasksSpan
TextureResourceHandle
- Added 3 new fields
  - Header
  - TextureWhileLoading
  - DataWhileLoading

New Structs and Enums

ActionBarNumberArray
AddonCabinetWithdraw
AddonCurrency
AddonMJICraftMaterialConfirmation
AddonMJICraftScheduleSetting
AddonPvPCharacter
AddonRecipeMaterialList
AddonTeleportTown
AgentHousingPortal
AgentHousingSignboard
AgentHudExpFlag
AgentMateriaAttach.FilterCategory
AgentMateriaAttach.MateriaAttachData
AgentMateriaAttach.MateriaAttachEntry
AgentMateriaAttach
AgentMaterialize.MaterializeEntry
AgentMaterialize
AgentMiragePrismPrismSetConvert.AgentData.ItemSet
AgentMiragePrismPrismSetConvert.AgentData.ItemSetItem
AgentMiragePrismPrismSetConvert.AgentData
AreaMapNumberArray
Attach
Attach.Attachment
BgObject
CastBarNumberArray
CastBarStringArray
CharacterManagerInterface
Control.FlightAllowedStatus
FateContext.FateObjective
FateContext.FateMapMarker
HouseId
- New struct to represent a house ID, with properties for apartment flag, apartment division, plot index, ward index, room number, and territory type ID
HousingPortalPacket
HousingSignboardPacket
HudStatus.DisplayStatus
HudStatus.Status
HudStatus
Hud2NumberArray
InventoryNumberArray
LetterNumberArray
MaterializeEntryId
NamePlateNumberArray
PartyListNumberArray
RenderCommandBufferGroup
RenderCommandClearDepth
RenderCommandScissorsRect
RenderCommandSetTarget
RenderCommandViewport
SharedGroupResourceHandle
Skeleton.Bone
Skeleton.BoneIndexMask
Terrain
TextureFlags
TextureResourceHandle.TexFileHeader

Obsolete slated for removal in 7.21

These have been marked with error on compile

Conditions
- All static bool properties
InventoryContainer
- Loaded
RetainerManager
- Ready
EventHandler
- Salvage
EventSceneTaskInterface
- HairMake
FateContext
- IsExpBonus
- ObjectiveIcons
GameObject
- LayoutInstance
Framework
- SavedAppearanceData
Utf8String
- SanitizeString(ushort, Utf8String*)
AddonSalvageDialog
- CheckBox
AgentBannerEditor
- GearsetId
AgentCaraCard
- Index
AgentInspect
- PsnName
AgentModule
- AquariumSetting
AgentSatisfactionSupply
- Bonus
InfoModule
- IsOnlineStatusSet(uint)
CharaView
- VisorHidden
ItemFinderModule
- Retainer
- RetainerCount
- RetainerInventory
- RetainerInventoryCount
RaptureUiDataModule
- PartyListTankOrder
- PartyListHealerOrder
- PartyListDpsOrder
WorldHelper
- IsPublic
AtkEvent
- ListItemToggle
AtkValue
- Texture
ValueType
- Texture
StdDeque
- Get(ulong)

Other notes

As usual any Unk field is ignored with this changelog as these are volatile until their properly named and as such should not be used without further research done to them.

Any use of byte* changed to CStringPointer where manually called NullTerminated is used can be converted to .ToString()