https://elmarathstudio.netlify.app/assets/js/2fa508e6.8443cb1a.js

1"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[7280],{7206:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>a,frontMatter:()=>s,metadata:()=>r,toc:()=>l});const r=JSON.parse('{"id":"Nested-Invnetory-Architecture/Helper-Blueprint-Function-Library","title":"Blueprint Function Library Helper","description":"This class will help you to Debug, Edit, Get Information about the given inventory.","source":"@site/docs/Nested-Invnetory-Architecture/Helper-Blueprint-Function-Library.md","sourceDirName":"Nested-Invnetory-Architecture","slug":"/Nested-Invnetory-Architecture/Helper-Blueprint-Function-Library","permalink":"/docs/Nested-Invnetory-Architecture/Helper-Blueprint-Function-Library","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"sidebar_position":4},"sidebar":"tutorialSidebar","previous":{"title":"Object Hierarchy And Their Uses","permalink":"/docs/Nested-Invnetory-Architecture/Data-Structure/ObjectHierarchy"},"next":{"title":"Nested Equipment Module","permalink":"/docs/category/nested-equipment-module"}}');var d=n(74848),i=n(28453);const s={sidebar_position:4},c="Blueprint Function Library Helper",o={},l=[{value:"All of the Functions",id:"all-of-the-functions",level:2}];function h(e){const t={code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(t.header,{children:(0,d.jsx)(t.h1,{id:"blueprint-function-library-helper",children:"Blueprint Function Library Helper"})}),"\n",(0,d.jsxs)(t.p,{children:["This class will help you to ",(0,d.jsx)(t.em,{children:"Debug"}),", ",(0,d.jsx)(t.em,{children:"Edit"}),", ",(0,d.jsx)(t.em,{children:"Get Information about"})," the given inventory."]}),"\n",(0,d.jsx)(t.p,{children:"While you are customizing your inventory system, creating a new UI or equipment system; there are many helpful functions to use in here."}),"\n",(0,d.jsx)(t.h2,{id:"all-of-the-functions",children:"All of the Functions"}),"\n",(0,d.jsxs)(t.table,{children:[(0,d.jsx)(t.thead,{children:(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.th,{children:"Function Name"}),(0,d.jsx)(t.th,{children:"Parameters"}),(0,d.jsx)(t.th,{children:"Return"}),(0,d.jsx)(t.th,{children:"Description"})]})}),(0,d.jsxs)(t.tbody,{children:[(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetDebugStringFromInventory"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"const FString& TitleOfInventory, const FInventory& InputInventory"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"FString"})}),(0,d.jsx)(t.td,{children:"Returns a debug string for the given inventory."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetRandomItemStaticDataFromSettings"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"FGameplayTag ItemTag, bool bUseExactTagMatch, const TArray<UItemStaticData*>& ItemStaticDataArray"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"UItemStaticData*"})}),(0,d.jsx)(t.td,{children:"Returns a random item static data from the settings array that matches the given tag."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetInventoryFromTemplateInventory"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"const FTemplateInventory& TemplateInventory, UInventoryManagerComponent* InvManagerComp"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"FInventory"})}),(0,d.jsx)(t.td,{children:"Creates an inventory from the template inventory."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"CoordsToIndex"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"FIntPoint Point, FIntPoint GridSize"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"int32"})}),(0,d.jsx)(t.td,{children:"Returns the index of the given point in the grid."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"IndexToCoords"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"int Index, FIntPoint GridSize"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"FIntPoint"})}),(0,d.jsx)(t.td,{children:"Returns the coordinates of the given index in the grid."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetIndicesInRect"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"int StartIndex, FIntPoint TargetRectSize, FIntPoint ContainerGridSize"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"TArray<int32>"})}),(0,d.jsx)(t.td,{children:"Returns the indices of the rectangle in the grid."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"CanRectangleFitInContainer"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"int StartIndex, FIntPoint TargetRectToFit, FIntPoint ContainerGridSize"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"bool"})}),(0,d.jsx)(t.td,{children:"Checks if the given rectangle can fit in the container grid."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetInventoryGridSize"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"const FInventory& Inventory"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"FIntPoint"})}),(0,d.jsx)(t.td,{children:"Returns the size of the inventory grid."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetProjectedIndicesFromCoords"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"int32 StartIndex, FIntPoint HoveringItemGridSize, FIntPoint ContainerGridSize"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"TArray<int32>"})}),(0,d.jsx)(t.td,{children:"Returns the projected indices of the hovering item in the container grid."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetNumberOfItemsWillBeLeftAfterDrag"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"const FSlotAddressWithSystem& SourceSlotAddress, ETargetTransactionType TransactionType"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"int32"})}),(0,d.jsx)(t.td,{children:"Returns the number of items that will be left after a drag operation."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetNumberOfItemsWillBeDragged"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"const FSlotAddressWithSystem& SourceSlotAddress, ETargetTransactionType TransactionType"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"int32"})}),(0,d.jsx)(t.td,{children:"Returns the number of items that will be dragged."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetParentGameplayTags"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"FGameplayTag GameplayTag"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"TArray<FGameplayTag>"})}),(0,d.jsx)(t.td,{children:"Returns the parent tags of the given tag."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetSectionsAvailableForItemData"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"const FInventory& Inventory, const FItemStaticInfo& ItemStaticData"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"TArray<int32>"})}),(0,d.jsx)(t.td,{children:"Returns the indexes of the sections that can hold the given item static data."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"DoesHaveAnySlot"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"UInventorySystem* InventorySystem"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"bool"})}),(0,d.jsx)(t.td,{children:"Checks if the inventory has any slots."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetInventorySection"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"const FInventory& Inventory, int32 SectionIndex"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"FInventorySection"})}),(0,d.jsx)(t.td,{children:"Returns the inventory section that matches the given index."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetInventorySlotFromAddress"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"const FSlotAddressWithSystem& SlotAddress"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"FInventorySlot"})}),(0,d.jsx)(t.td,{children:"Returns the inventory slot that matches the given address."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetItemsInSlot"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"const FSlotAddressWithSystem& SlotAddress"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"TArray<UInventoryItem*>"})}),(0,d.jsx)(t.td,{children:"Returns the items in the slot that matches the given address."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetInventoryAddressOfItem"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"const FInventory& Inventory, const UInventoryItem* Item"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"FSlotAddress"})}),(0,d.jsx)(t.td,{children:"Returns the address of the item if the given inventory item is in the inventory system."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"GetAllItemsInInventory"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"const FInventory& Inventory, bool bIncludeNestedItems"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"TArray<UInventoryItem*>"})}),(0,d.jsx)(t.td,{children:"Returns all the items that are in the inventory system."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"CreateInventoryItemFromStaticData"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"UItemStaticData* ItemStaticData, UPayloadTemplate* ItemPayloadTemplateOverride, UInventoryManagerComponent* InvManagerComp"})}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"UInventoryItem*"})}),(0,d.jsx)(t.td,{children:"Creates a new inventory item from the given static data and payload template override."})]})]})]})]})}function a(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(h,{...e})}):h(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(96540);const d={},i=r.createContext(d);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);