Skip to content

Creating a new device

Jump to bottom
Veladarius edited this page Aug 18, 2014 · 3 revisions

(More text here, pictures, etc). This section will tell you how to set up the different parts of the devices so you can create your own custom items. It will cover the Inventory Device, Rendered Device and the various keywords used with them and how they work together. You should have the Armor Addon and World Models for your device set up beforehand and have a clear idea of what types of items you are making.

Each device is made up of two armor items, the Inventory Device and the Rendered Device. Each plays an important part in the operation of the device and improper set up will cause issues for the user. The easiest way to create a custom device is to use a standard device as a template, just duplicate the two parts and modify them to suit your needs. You can create your own item from scratch but you will still use most all of the same keywords and scripts as the original.

To eliminate going back and forth between the two devices I recommend creating and naming the two parts of the device or start with the Rendered Device first.

###Inventory Device### The Inventory Device is the part that you interact with in the inventory menu and controls the locking, unlocking and other interactive features of the device. The interface is controlled by a script attached to it which contains the various functions that allow it to communicate with the main controlling scripts, without it the device would not function.

To set up the Inventory Device you need to modify or fill in the following information:

  • The Name, Value, Weight and Description for the device
  • The World Model so you can see it in your inventory or if you drop it
  • The different Keywords needed for this part of the device including any custom keywords you intend to use (Keywords and their functions are described below)
  • The Script that controls the device
  • The Inventory Device will not include an Armor Rating, Armor Type or Slot the item uses as it does not use one.

The Script included with the Inventory Device will need to have a few of its Properties changed for the device to function properly and you do NOT have to make changes to the script itself. Not having the Properties set up properly will cause problems. You will have to change both the deviceInventory and deviceRendered in the properties to the items that you have created. Not setting the deviceRendered Property to the correct item will cause the incorrect item to be shown on the wearer instead of yours since the script uses this to equip the Rendered Device. If you want the item to use a different key than the standard key that all the items from Integration uses you will need to create a Key and change the deviceKey Property to the key you created.

This is everything you need to set up on the Inventory Device.

###Rendered Devices### The Rendered Device is the part that you will see on the wearer and contains a number of keywords that tells the scripts what sorts of things it does. This part will not show up in your inventory or be directly used outside of the console as it is controlled entirely by scripts.

To set up the Rendered Device you need to modify or fill in the following information:

  • The Armor Rating and Armor Type (if any)
  • The slot the item uses (Biped Object)
  • The World Models and the Armor Addon (filled in under Model under the World Model entries)
  • The Name should be blank, the weight should be 0 and it does not need a description as these are taken from the Inventory Device
  • The different Keywords needed for this part of the device including any custom keywords you intend to use

All the functionality of this part it provided by the Armor Addon listed under Model and the various Keywords that tell the Integration scripts what it does when equipped. There are a number of keywords included on the Rendered Device that are not on the Inventory Device. If you want to use custom keywords and detect them when it is worn this is the best place to list them.

This is everything you need to set up on the Rendered Device.

###Device Keywords### Description of term, list of available keywords.

Clone this wiki locally