Skip to content

Simple inventory system for collecting and organizing objects

License

Notifications You must be signed in to change notification settings

Mecanes/Doc-SimpleInventorySystem

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 

Repository files navigation

Doc-SimpleInventorySystem

Plugin

Plan

Description

The Simple Inventory System plugin provides a simple and effective solution for managing items in your games. It lets players collect, store and organize items, so you can easily interact with their inventory. Ideal for projects requiring item tracking, this plugin makes it easy to collect, use and manage resources in your games, while providing a solid foundation for more advanced functionality.

Objective

The aim of the Simple Inventory System is to provide a lightweight, easy-to-integrate solution for managing the collection, organization and use of items in a game, enabling developers to quickly create functional inventory systems without the problems of excessive complexity.

Requirement

Target version : UE5.2 ~ 5.x

Target platform : Windows, Mac

Warning

The plugin may not work properly, so feel free to join the Discord for more information. We're working hard on this plugin and will be updating it regularly to make it more effective.

Installation

Install the plugin via the marketplace .

If the functionality isn’t available after installing the plugin, it’s possible that the plugin hasn’t been activated. Please make sure the plugin is enabled by going to Edit > Plugins.

Contents

There are 2 actor components:

  • AC ItemsBag
  • AC Item

AC Item is used in your Actor ( Item )

AC ItemsBag is used in your Character

AC Shop is used in your Actor ( Shop ) [ new ]

Actor Component

Advantages and uses

Advantage :

  • Simple Inventory System facilitates integration and customization, offering developers a fast way to set up an efficient and intuitive inventory system, without the need for complex coding.

Here are a few use cases for your Simple Inventory System plugin: :

  • Role-playing games (RPG): Manage items, potions and equipment collected by players
  • Survival games: Track collected resources (food, materials, tools) and manage players' limited inventories, adding a strategic dimension to survival.
  • Rapid game prototyping: Offer developers a ready-to-use solution for rapidly testing game concepts based on the collection and use of objects.
  • and other...

Function

  • AC ItemsBag

AC ItemsBag

  • Remove Item and Remove Item by Index : Return true , if the item have being remove

  • Set Item Quantity and Set Item Quantity by Index : Modify the quantity of item

  • AC Item

AC Item

  • Has Space For : Returns TRUE IF THERE IS ROOM, OTHERWISE FALSE

  • Add To Bag : Stores an object in the bag. Returns true if the object is stored, otherwise false if the actor has no bag

check Delete actor if you want the actor to be deleted if it no longer exists.

  • AC Shop
  • AddItemToShop : Returns true if the item has been added
  • MoveFromShopToBagByName : Returns true if the object has been added to the bag
  • RemoveItemFromShop : Returns true if the item has been removed
  • RemoveItemFromShopByName : Returns true if the item has been removed
  • RemoveItemFromShopByIndex : Returns true if the item has been removed

Features & applications

Code Example : AC Item

AC Item Example

Licence

MIT License

Author

Mecanes

History

  • [04/11/2024] Add a shop
  • [29/08/2024] Creation of official documentation

About

Simple inventory system for collecting and organizing objects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published