Weararmor Settings

Description

Puts on one of your gear sets. It checks what combat gear you're wearing (INV COMBAT), takes off anything that isn't in the set and puts it away, then gets and wears whatever in the set you aren't wearing yet. With no argument it wears your standard set.

Many scripts wear gear sets the same way, so the sets you set up here are used all over dr-scripts (see Gear sets other scripts use).

Settings

YAML Settings

Your gear

gear:
- :adjective: ring
  :name: gloves
  :is_worn: true
- :adjective: quilted
  :name: hood
  :is_worn: true
- :adjective: small
  :name: shield
  :is_worn: true
- :adjective: target
  :name: shield
  :is_worn: true
  :tie_to: harness

Every piece of gear the set mentions must be listed under gear:. Each entry describes one item:

Key	Purpose
:name:	Required. The item's noun.
:adjective:	The item's adjective. It's used with the noun as adjective.name (for example get my ring.gloves), so pick one that tells your items apart. Leave it blank if the noun alone is enough.
:is_worn:	true for things you wear.
:tie_to:	Where the item is tied when you aren't wearing it. It's untied to put it on, and tied back when taken off.
:wield:	true for an item you wield and sheathe rather than get and stow.
:container:	The container the item is kept in when you aren't wearing it.
:transforms_to:, :transform_verb:, :transform_text:	For an item that turns into something else when you take it off, such as armor that becomes an orb.

The other gear keys (:is_leather:, :hinders_lockpicking:, :swappable:, :lodges:, :ranged:, :needs_unloading:, :skip_repair:, :bound:) are read by other scripts, such as combat-trainer, the lockpicking scripts and crossing-repair.

Your gear sets

gear_sets:
  standard:
  - ring gloves
  - quilted hood
  - small shield
  swimming:
  - quilted hood
sort_auto_head: true

Setting	Default	Purpose
gear_sets		Each set is a name and a list of the items to wear. Write each item as its adjective and noun, as in gear:.
sort_auto_head	true	After changing gear, run SORT AUTO HEAD to tidy your inventory.

Each entry in a set is matched against your gear: list by adjective and noun. An entry that doesn't match anything in gear: is skipped without a word. If two gear: entries could match, the first one listed is used.

A set written as [] is allowed: wearing it takes off every piece of combat gear listed in gear:. A set name with nothing after it counts as missing.

Gear sets other scripts use

Set	Worn by
standard	combat-trainer, hunting-buddy (or your combat_trainer_gear_set), pick, appraisal, crossing-repair, mech-lore, steal and bescort, when they put your normal gear back on.
swimming	bescort, for the routes where you swim.
stealing	steal.
regalia	combat-trainer, when cycling regalia.

What it does

There are no settings for these; this is what to expect.

1. Looks up the set. If there's no set by that name, it says "Could not find gear set" and stops.
2. Runs INV COMBAT to see what combat gear you're wearing.
3. Takes off each piece you're wearing that's listed in gear: but isn't in the set. Worn items that aren't in gear: are left alone.
   • If your hands need to be empty to take something off, it lowers what you're holding, takes the item off, and picks your things back up.
   • Armor that can't be taken off yet (it "constricts tighter around you") is left on, and it says so.
   • The removed item is tied to its tie_to, sheathed if it's a wield item, put in its container, or otherwise STOWed. If there's no room to stow it, it's worn again.
4. Gets and wears each piece of the set you aren't wearing yet: unties it, wields it, takes it out of its container, or otherwise GETs it, then WEARs it.
   • A piece of the set that's already in your hands is put away, not worn. Empty your hands first.
5. Runs SORT AUTO HEAD, if sort_auto_head is on.

If a piece can't be found, it beeps and says "MISSING EQUIPMENT - Please verify these items are in a closed container and not lost:" with the item names.

Argument Settings

Argument	Purpose
set	The gear set to wear. Defaults to standard.

Usage

;weararmor

;weararmor swimming

To see what it's matching, turn on the equipment manager's debug messages with ;e UserVars.equipmanager_debug = true, and off again with ;e UserVars.equipmanager_debug = false.