Equipment

Group
player
Methods
5
Fields
None

Getting one

player:equipment()

Methods

MethodReturnsDescription
search()ContainerQueryA query over what is worn.
itemIn(WornSlot)ItemHandle?What is worn in one slot.
isTwoHandedWeapon(number)booleanWhether an item occupies both hands, from its equipment stats, so equipping it would unequip the shield.
interact(number, string | { string })booleanInteract with a worn item by id.
interactName(string, string | { string })booleanInteract with a worn item by name.

Returned by

MethodReturnsDescription
PlayerDomain.equipmentEquipmentWorn gear.

Method details

isTwoHandedWeapon

isTwoHandedWeapon: (Equipment, number) -> boolean

Whether an item occupies both hands, from its equipment stats, so equipping it would unequip the shield.

itemId
Exact item id.

interact

interact: (Equipment, number, string | { string }) -> boolean

Interact with a worn item by id.

itemId
Exact item id.
options
An option ("Remove"), or options to try in order.

interactName

interactName: (Equipment, string, string | { string }) -> boolean

Interact with a worn item by name.

name
Name pattern, matched as for ContainerQuery.named.
options
An option ("Remove"), or options to try in order.