Gswiki:Style guide/Item scripts

This article is a work in progress!

Item script pages are articles displaying information about scripted items within GemStone IV. A series of templates have been created to assist in cataloging this information, and along with this guide and the provided examples, serve to ensure formatting and categorization remain uniform across the various pages.

In order to streamline the process for creating and editing item script pages on the Wiki, an item script form is available with instructions and easy input for parameters.

Article Name

Scripted items will often have a "script name" found in the item's ANALYZE. This can be a proper name or a generic name, and applicable casing should be considered in the article title. The article name is reflected in the introductory paragraph that is automatically populated by the entries noted below.

For items that do not have an analyze or do not have a generic name within the analyze, please set the name to what would closest reflect the general concept of the item script.

Article Creation

Proper Name

The propername parameter of the template is used to handle "generic names" of item scripts and will force the article name to become lowercase in the introductory paragraph. If the article/script name is the proper name of the item, "yes" will need to be entered into the template or selected in the form. If it is not, "no" will need to be entered into the template or selected in the form. This is a mandatory field.

Flourishes

Flourishes are stand-alone scripts that can be applied to items in addition to the script and subscript slots. Each item can have up to 20 Flourishes.

There are two types of Flourishes: combat and fluff.

A combat flourish is a flourish script that has mechanical benefit. Only one combat flourish can be active at a time by default, but which is active can be changed via the FLOURISH verb when not in combat. If multiple mechanical flourishes are applied to one item, the project difficulty will be increased based on the highest difficulty out of all applied flourishes, regardless of which is currently active.

Flourish priority also determines which script's verb traps will fire, if multiple Flourishes trap the same verb.

Itemscript

The itemscript parameter of the template is used to indicate if a script is just a script, a flourish, or both. If utilizing the template directly, this would be entered as "script", "flourish", or if both, "flourish,script", specifically with a comma and no spaces to separate them. In the form, this is a checkbox to check all that apply. This is a mandatory field, and corresponds with the Item script property.

Categories

Categories, in regards to item scripts, are used to determine the overall type of script it is. As it will always be at least one of the below listed categories, it is a mandatory field and corresponds with the item script category property.

Please note: An item will either be mechanical (ie. it provides the user with a mechanical benefit) or fluff (ie. it is meant for roleplay and provides no mechanical benefit). Items that are mechanical in nature may have fluff scripts associated with them, but fluff items do not grant a mechanical benefit at all. If an item provides a mechanical benefit off-the-shell, it will always be categorized as mechanical, not fluff, regardless of the fluff scripts associated with it. In rare cases, an item will fall into both categories, but this may only occur if the item is purely fluff up until a certain unlock in which it provides a mechanical benefit to the user.

• Fluff: These types of scripts do not provide a mechanical benefit to the user, even though they may be added to things that do, such as weapons or armor. Examples include: Fuzzy Warm Parkas, Veola hair accessories, Peretta gowns.
• Mechanical: Formally known as "functional" item scripts. These scripts provide a mechanical benefit to the user. Examples include: Mana-Infused Armor, Sigil Staff, and Sprite Weapon.
• Mount: These types of script apply specifically to mount items. They can be either fluff or mechanical, and sometimes both.
• Private property: These types of scripts apply specifically to private property items. They can be either fluff or mechanical, and sometimes both.

Classification

Classifications refer to what the item script can apply to. As these are meant to be umbrella terms, if the item script is specific to a noun type within the classifications, that should be noted with restrictions.

• Accessory: These scripts apply to accessory items only. Applicable worn locations (based on INVENTORY) are: pin-worn, waist-worn (worn as a belt, not belt-worn), head-worn, wrist-worn, finger-worn, feet-worn*, neck-worn*, arm-worn, leg-worn (attached to), ear(s)-worn, ankle-worn, front-worn*, hands-worn, feet-worn (worn as socks, slipped on), hair-worn, leggings-worn (slipped into)*. Examples include Nexus jewelry, Knee-high stockings, Veola hair accessory.
• Armor: These scripts apply solely to armor.
• Clothing: These scripts apply to clothing items. Applicable worn locations (based on INVENTORY) are: shoulders-worn/draped over shoulders (also known as cloak-worn), shoulder-worn (slung over)*, front-worn*, chest-worn, under-chest-worn (layered), leg-worn (pulled over), leggings-worn (slipped into)*, & feet-worn* (shoes). Examples include: Dramatic Drapery (shoulders-worn/cloak-worn), Yansio clothing, Peretta gowns.
• Container: These scripts apply to containers, such as belt-worn, back-worn, front-worn*, neck-worn*, or shoulder-worn (slung over)* items. For the purpose of this classification, it does not include cloak-worn items.
• Miscellaneous: These scripts apply to items that do not fall within the aforementioned categories. Examples include: gemcutters, lapidary boxes.
• Shield: These scripts apply to shields.
• Weapon: These scripts apply solely to weapons.

*Please note: Certain worn locations may have overlap in categories based on the particular noun they use. For instance, a front-worn corset would fall under the clothing category, a front-worn harness or bandolier would fall under containers, and a front-worn piece of jewelry would fall under accessories.

Class

The class parameter of the template is used to indicate which of the classes listed above the script pertains to. If utilizing the template directly, this would be entered as "accessory", "armor", or if multiple, "accessory,armor...", specifically with a comma and no spaces to separate them. In the form, these are multiple checkboxes to check all that apply. This field corresponds with the Item script classification property.

Type

Type refers to a subcategory of items that does not apply to specifically to classification or has abilities that coincide with classifications but cannot fall directly beneath what is listed.

• Cooking: These scripts are used in the cooking system.
• Crafting: These scripts are used in the various crafting systems.
• Creature: These scripts apply to creature-type items, such as pets, ex. Dhu kittens or Mounts.
• Feature altering: These scripts can alter one's features.
• Glamour: These scripts can apply a glamour in various spots, ex. Illusion props.
• Storage: These scripts apply primarily to containers and allow for stacked storage, often weightlessly, within them, ex. Perfuminator or Bag of Holding.
• Vissi: These scripts apply strictly to vissi within the Vissi system.

If utilizing the template directly, this would be entered as "cooking", "crafting", or if multiple, "cooking,crafting...", specifically with a comma and no spaces to separate them. In the form, these are checkboxes to check all that apply. This field corresponds with the Item script type property.

Tiering

Some item scripts are basic with only have a single tier and minimal interaction. Others require unlocks in order to get full usage from them.

Tiers

The tiers parameter of the template should only be filled in with the amount of tiers an item has if more than one. In the form, this appears as "Max Tier Count". This field corresponds with the Item script tiers property.

Unlocks

The unlocks parameter of the template is used to note how to unlock an item script to the next tier. In the form, this appears as "Unlock Type". This field is corresponds with the Item script unlock property.

• Bundling: Bundling unlocks refers to whether you can BUNDLE or ADD one item to another to unlock it further, such as vissi within the vissi system.
• Certificate: Certificates sold off the shelf can be used to unlock item scripts to the next tier.
• Merchant: This unlock type is if a special merchant can unlock the item script to the next tier.
• Premium Unlocker: As a premium benefit, certain scripts may be able to be unlocked 1x per account per month at the Premium Unlocker on Mist Harbor. Not all tiers are available for this unlock option.
• Quest: Some item scripts can only be unlocked by participating in and completing a quest.

Customization Facets

The customization parameter of the template is used to indicate if there are certain facets customizable with the item, ex. certain verb interactions with Winged wear. In both the form and the template, this would be entered as "facet1", "facet2", or if multiple, "facet1,facet2...", specifically with a comma and no spaces to separate them.

Related Scripts

Formally known as "corresponding scripts," this parameter is used to enter script names that correspond with the item script. This is also known as a "script family". In both the form and the template, this would be entered as "script1", "script2", or if multiple, "script1,script2...", specifically with a comma and no spaces to separate them. Links are not required to be entered as the template handles that itself.

Add or Swap Eligible

The addorswap parameter of the template is used to indicate if a script can either be added or swapped to another item of the same class. If using the template directly, this would be entered as "Add", "Swap", or if both, "Add,Swap". In the form, these are checkboxes to check all that apply. This field corresponds with the Script add or swap eligible property.

Attunement

Attunement for item scripts specifically refers to script attunement on an item. This is typically in reference to an item that attunes upon first use, however certain items, such as those obtained from Event Vaults, are attuned at redemption. This does not refer to items purchased with the ATTUNE option. Valid options are either Permanent or Temporary. This field corresponds with the Item script attunement property.

Attunetype

The attunetype parameter in the template is use to indicate if the script is attuned to Account or Character. In the form, it appears as Attunement Type. This field corresponds with the Item script attunement type property.

Safety Feature

The safety parameter of the template is used to indicate if the script has a safety feature for when it is PUT or PLACEd on the ground for a limited duration, during which other players and the janitor cannot pick it up.

• All Mine: The All Mine safety feature will only work as long as the player remains in the room with the dropped item.
• Stay Put: The Stay Put safety feature allows for an item to be placed in a room and does not require the player to stay with it. Certain Stay Put items may be placed semi-permanently in private properties, lofts, or stalls by the owner.

Verbs Used

The verb parameter of the template is used to list verbs, preferably in alphabetical order, that the script utilizes. In both the form and the template, this would be entered as "verb1", "verb2", or if multiple, "verb1,verb2...", specifically with a comma and no spaces to separate them. This populates a table beneath the main ItemScriptInfo template. Verbs entered should be done in all caps only, and links are not required to be entered as the template handles that itself.

Original Release Information

While completely optional, many users enjoy seeing release information for an item, if it is known. This section creates a sentence within the introductory paragraph that handles that parameter.

Releasevenue

The releasevenue parameter of the template indicates which event or special venue an item script was originally released at, ex. Duskruin. In the form, it appears as "Original Release Venue". Links are not required to be entered as the template handles that itself.

Releasedate

The releasedate parameter of the template indicates when an item script was originally released. For most item scripts, this will be a year only, however certain events run twice a year, such as Duskruin, and entering the month along with the year is acceptable in these situations. In the form, it appears as "Original Release Date".

Origmerch

The origmerch parameter of the template indicates which merchant originally released the item script. This is not always known as some events do not have merchant activity. It is preferred to have a merchant name entered, however in lieu of that, a GM name may be entered instead, if known. In the form, it appears as "Original Release Merchant". Links are not required to be entered as the template handles that itself.

Quest Prize

The quest parameter of the template indicates if an item was released as part of participation in and completion of a quest, ex. Ghezyte quest items. This parameter should indicate the name of the quest, but omit the word "quest" as the template populates that automatically. Links are not required to be enter as the template handles that itself.

Features Altered

The features parameter of the template indicates which features a feature altering script will temporarily alter. This should be used if the type indicates it is a feature altering script. This is not the same as a glamour, and should not be use for that. In both the form and the template, this would be entered as "feature1", "feature2", or if multiple, "feature1,feature2...", specifically with a comma and no spaces to separate them.

• Height: Rarely, a temporary feature altering item may adjust a character's height.
• Body: At this time, body types cannot be temporarily altered, however it is listed for the sake of future use, in case one does.
• Eyes: This is used to indicate if a temporary feature altering item may alter a character's eye characteristic or eye color, ex. Ferocious Eyes mask.
• Complexion: This is used to indicate if a temporary feature altering item may alter a character's complexion (skin) field.
• Hair: This is used to indicate if a temporary feature altering item may alter a character's hair style, hair texture, hair color, or hair quirk.
• Face: This is used to indicate if a temporary feature altering item may alter a character's face field.
• Nose: This is used to indicate if a temporary feature altering item may alter a character's nose field.
• Distinguishing mark: This is used to indicate if a temporary feature altering item may alter a character's distinguishing mark field.
• Unique: This is used to indicate if a temporary feature altering item may alter a character's unique feature field.
• Wings: This is used to indicate if a temporary feature altering item may alter an aelotoi's wing characteristic or wing quirk, ex. Aelotoi Wing Jewels.

Additional Information Summary

The addinfo parameter of the template is used to give a quick summary of information that is not covered by the autogenerated introduction paragraph. There is a character limit of 200, with spaces included. Any more than that should be indicated in the Additional Information section.

Script Restrictions

The restrictions parameter of the template is used to indicate if there are specific restrictions on an item script, such as alteration restrictions, etc. The restrictions themselves should be indicated in the Restrictions section.

Loresong

The loresong parameter of the template is used to indicate if an item script has a loresong associated with it. The loresong itself should be indicated in the Loresong section.