Introduction and Terms - DeviousDevices/Docs GitHub Wiki

Introduction: This wiki will explain the different features of Integration including how devices work, setting up your scripts and the commands available as well as how to create your own items and effects. There are some things you will need to know before getting started such as setting up scripts and properties and how to do things in the CK.

Device Components Each device is made up of multiple pieces that work together with various scripts. Unlike standard items that everything is contained within a single item, such as an armor curiass or boots or gloves, these are made up of 2 separate items: the Inventory Item and Rendered Item (aka ScriptInstance item). Each of these two parts plays an important role in the device and its function. The Inventory item is what you will see within your inventory and will use to interact with it. It contains the script that controls the lock/unlock interface and defines the parts of the complete device as well as the meshes seen in the inventory and when it is placed in the world. The Rendered item is the part that has the meshes that appear on the wearer as well as a number of important keywords that help control the functions of it. This item does not appear in your inventory and and is added or removed by the script contained in the Inventory item.

Glossary of Terms: Normally this is at the back but you will need to know these terms and what they are if you are going to understand what is to come.

General Terms

• Zadlibs – the base script that houses the bulk of the commands for Integration.
• Inventory Item – One of the two parts to a device. This piece contains the scripts that control the locking and unlocking of the device and the only part to show in your inventory.
• Rendered Item – The second part to a device. This contains the Meshes and Textures that will show on the wearer and contains a number of keywords that controls a number of effects but does not show up in the wearers inventory. It is also referred to the Script Instance item in the Creation Kit.
• Keywords – There are a number of types of keywords used in Integration on the different devices. Some will identify what type of device it is while others link it to various functions and effects.

Function Parameters

• akActor – Actor Property - used in the functions to tell who is getting the device placed on or removed from.
• Device – Armor Property - used in functions to identify the Inventory item being manipulated.
• DeviceRendered – Armor Property - Used in functions to identify the Rendered item being manipulated.
• DeviceKeyword – Keyword Property - used in functions to identify what type of device is being manipulated.
• SkipEvents – bool (true / false) - used in functions to skip the normal start up or shut down of an item. This command can be used when you want to remove an item and replace it with the same type (ie: belt for belt). Using this in other cases can cause items to not work correctly and possibly break them.
• SkipMutex – bool (true / false) - used in functions to skip the logic that ensures that devices are equipped sequentially. This will dramatically speed up the equippall of devices, though introduces a potential race condition; When using this parameter, you must ensure that you are not simultaneously equipping devices which conflict with eachother.
• DestroyDevice – bool (true / false) - used in removal functions to tell if the device is to be added to the wearers inventory or if it is to be removed completely.
• EquiporUnequip – bool (true / false) - used in functions to tell if the device is to be equipped or removed. True will equip the item and false will remove it.