EquipmentComponent - acrimi/Raven GitHub Wiki

EquipmentComponent holds the state of an entity's currently equipped item and weapon. These names correspond to items intended to be used by the ItemActionComponent.

Configuration

When used inside the components block, the initial state of the component can be configured with the following parameters:

Key Type Description
weapon string Optional name of an item to initially equip as the entity's weapon
item string Optional name of an item to initially equip as the entity's secondary item

Example:

"EquipmentComponent": {
  "weapon": "sword",
  "item": "bomb"
}

Properties

The following properties are readable by property accessors (eg render state and persistence definitions):

Key Type Description
weapon string The name of the entity's currently equipped weapon
item string The name of the entity's currently equipped secondary item