Skip to main content

Introduction

This component provides inventory for in world containers

"In World Container"

Fields#

NameDescription
Max ItemsMaximum number of items the container can hold (0 = unlimited)
Max WeightMaximum weight the container can hold (0 = unlimited)
PluginsList of plugins
On ShutdownEvent raised when system shuts down
On InitializedEvent raised when system is initialized
Ignore LimitsIgnore item & category limits
Display NameName of the creature or object attached
ColorColor associated with this object
Broadcast MessagesBroadcast message to 'GDTK_Inventory' channel
On Funds ChangedEvent raised when funds are added or removed
On Item AddedEvent raised when an item is added to inventory
On Item RemovedEvent raised when an item is removed from inventory
On Inventory ChangedEvent raised when any inventory change occurs
On Item Count ChangedEvent raised whenever item count changes
On Weight ChangedEvent raised when total weight changes
On Display Name ChangedEvent raised when Display Name changes
On Color ChangedEvent raised when Color changes

Properties#

NameDescription
busyTrue if the system is currently loading or saving data.
initializedGets if the object has been initialized
totalWeightGets the total weight of all items and funds
actorGets reference to the associated actor
colorColor associated with this object
displayNameName of the creature or object attached
instanceIdGet the id of this instance of the object
itemContainerGets the item container
itemsGets a list of all items in the container
statIdsList of all Stat Ids
totalItemWeightGets the total weight of all items in the container

Methods#

NameDescription
DataLoadLoads data from a specified file
DataLoadJSONFileLoads JSON data from a specified file
DataSaveSaves data to a specified file
DataSaveJSONSaves JSON data to a specified file
GetItemByInstanceIdGet an item by its instance id
GetItemCategoryGet an Item Category
InitializeInitialize the object
ItemTotalCountGet the total count of an item in inventory
ShutdownShutdown object and remove all subscriptions
AddItemAdd an item to the container
AddItemsAdd a list of items item to the container
DataLoadJSONLoads JSON data from a JSON string
GetStatValueGet the value of a stat
RefreshActorAttempt to find actor for component
ReplaceItemReplace an existing item with a new one
RunPluginCommandRun a plugin on an item