Skip to main content

Introduction

This component provides the ability to spawn or control the activation of objects for an Equip Slot

"Equip Slot Client"

Fields#

NameDescription
SourceDetermine if source is a Direct Reference or in the Tool Registry
InventoryInventory source
KeyKey used to find source
Slot IdEquip Slot Id to associate with
Spawn TypeType of spawning used for object
Activation TargetTarget to activate/deactivate
Start ActivatedStart with object activated
Quick SwapQuick swap interface
Map Skinned MeshBind the skinned mesh of spawned object to main character
Root BoneTransform containing the root bone for the Skinned Mesh
Disable ObjectsList of GameObject (if any) to hide when a Skinned Mesh is active on this Equip Slot
Bone Source NamesList of bones to use when mapping
On Item EquippedEvent raised when item is equipped
On Item UnequippedEvent raised when item is un-equipped

Properties#

NameDescription
canHolsterGets if the equipped item can be holstered
busyGets if the system is busy changing equipped item
equippedItemGets the currently equipped item
equipSlotGets the associated EquipSlot
holsterSlotGets the HolsterSlotClient associated with the current equipped weapon
itemHolsteredGets if the item is currently holstered
previousItemGets the previously equipped item
spawnedItemGets the GameObject spawned for equipped item
waitingItemGets the item waiting to be equipped

Methods#

NameDescription
EquipItemEquips an item to the slot
HasBlockingSlotCheck if other slot blocks "free" equip to here
HolsterItemHolsters equipped item (if able)
HolsterItemToggleHolsters or Unholsters item depending on current state
LoadLoad state from data
QuickSwapSwap current item with previously equipped item (only if there is one)
UnequipItemRemove the currently equipped item
UnequipItemDroppedImmediately unequips a dropped/removed item
UnholsterItemunholsters equipped item (if able)