Equipment Display Generator

API Documentation

EquipmentObject

This class represents an equipment object. It contains the following properties:

• folderToProcess: The folder that the script will parse and build objects from for the folder processing. This property is of type UnityEngine.Object.
• folderToSaveVariant: Your project specific folder for the items that are generated to be saved too. This property is of type UnityEngine.Object.
• equipDisplayType: This property is of type EquipDisplayType and represents the type of the equipment display.
• gearType: This property is of type GearType and represents the type of the gear.
• socket: This property is a string that represents the socket of the equipment.
• processThis: This property is a boolean that determines if the process should be performed.

EquipmentDisplayGenerator

This class is a MonoBehaviour that generates equipment displays. It contains the following properties:

• equipmentObject: The list of equipment objects.
• femalefolderToProcess: The folder that the script will parse and build objects from for the folder processing. The Prefabs must be named the same thing in the folders. This property is of type UnityEngine.Object and is hidden in the inspector.
• equipmentfolderToProcess: The folder that the script will parse and build objects from for the folder processing. The Prefabs must be named the same thing in the folders. This property is of type UnityEngine.Object and is hidden in the inspector.
• socket: This property is a string that represents the socket of the equipment.

Methods

• ProcessFolder: This method processes the folder. It takes an optional parents parameter, which is a boolean that determines if the process should be performed on the parents. If the parents parameter is not specified, it defaults to false.
• saveEquipmentDisplay: This method saves the equipment display. It takes two parameters: objectToBuild and objectToAdd, both of type GameObject.
• BuildDisplay: This method builds a display. It takes four parameters: prefab, nameSuffixString, folderName, and folderToSaveTo, all of type string. It returns a GameObject.
• CreateEquipmentDisplay: This method creates an equipment display. It takes five parameters: objectToBuild, folderName, folderSaverPath, equipDisplayType, and gearType. It also has an optional saveit parameter, which is a boolean that determines if the object should be saved. If the saveit parameter is not specified, it defaults to true. This method returns a GameObject.