Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Equipment Slot

Note

Not to be confused with Inventory Slots.

An Equipment Slot is a data structure used by Alter Ego. It represents a part of a Player’s body that they can equip Inventory Items to.

Equipment Slots do not have a dedicated sheet on the spreadsheet. Rather, they are derived from data on the Inventory Items sheet. If an Inventory Item has no container name, then an Equipment Slot will be created for it to be equipped to.

Equipment Slots are almost fully customizable. A single Player can have as many or as few Equipment Slots as desired, and each Player can have a unique set of Equipment Slots. If the startgame or addplayer commands are used, then all Players will have the default inventory, but this can be edited after the data is saved to the spreadsheet.

Crafting, as well as many interactions involving equipping and stashing, are currently hard-coded to expect up to two “hand” slots: a RIGHT HAND and a LEFT HAND. There is currently no other way to define hands for use in interactions involving hands. Players can be missing their LEFT HAND, but this will forbid them from engaging in hand-crafting. RIGHT HANDs are expected to come before LEFT HANDs on the Inventory Items sheet. Moderators may encounter erroneous behavior if they fail to conform to this expectation.

Equipment Slots can contain 0 or 1 Inventory Items. To define an Equipment Slot without an Inventory Item, then the Prefab for this Equipment Slot should be NULL.

Attributes

Equipment Slots have very few attributes.

ID

  • Class attribute: String this.id

This is the ID of the Equipment Slot, which is inherited from the Equipment Slot attribute of the Inventory Item equipped to it. All letters should be capitalized, and spaces are allowed.

Name

Warning

This attribute is deprecated and will be removed in a future release.

Use this.id instead.

  • Class attribute: String this.name

This is a copy of the Equipment Slot’s ID. It was how Equipment Slots were identified prior to Alter Ego version 2.0. This attribute will be removed in the future.

Equipped Item

This is the Inventory Item currently equipped to this Equipment Slot. If the Inventory Item has a NULL Prefab — indicating that nothing is currently equipped, then this is null.

Items

This is a list of Inventory Items that currently occupy this Equipment Slot. This includes the Inventory Item currently equipped to it, any Inventory Items contained within it, any Inventory Items contained within those, and so on.

Row

  • Class attribute: Number this.row

This is the row number of the Inventory Item equipped to this Equipment Slot.

Methods

Equipment Slots have a number of functions that can be useful to moderators. This is not an exhaustive list of publicly accessible methods; only ones that are likely to be useful when writing Flag value scripts, or if and var tags in descriptions.

containsNoItems

this.containsNoItems();
  • Purpose: Returns true if the equipment slot contains no items.
  • Returns: Boolean
  • Parameters: None