Items - Revision history

Mercury: /* Item Tags */

2021-07-24T05:29:16Z

Item Tags

Mercury at 23:32, 27 June 2021

2021-06-27T23:32:48Z

Mercury at 21:01, 27 June 2021

2021-06-27T21:01:12Z

Mercury: Protected "Items": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2021-06-27T20:58:53Z

Protected "Items": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

Mercury at 20:58, 27 June 2021

2021-06-27T20:58:31Z

Mercury at 20:53, 27 June 2021

2021-06-27T20:53:37Z

Show changes

Corowne: Created page with "Items can be owned by users and may be used in various ways. They can be edited in the admin panel by users with the '''Edit World Data''' power. {| class="wikitable" |Fold T..."

2020-11-16T20:18:59Z

Created page with "Items can be owned by users and may be used in various ways. They can be edited in the admin panel by users with the '''Edit World Data''' power. {| class="wikitable" |Fold T..."

New page

Items can be owned by users and may be used in various ways. They can be edited in the admin panel by users with the '''Edit World Data''' power.
{| class="wikitable"
|Fold

Table of Contents

Usage

Editing

Categories

Items

Item Tags

Inventory

See Also
|}

= Usage =
Items can be created in the admin panel. Once created, they can be distributed to users through a variety of ways. Item categories are optional, but provide categorisation in the user's inventory and shop pages.

Items are primarily used as turn-ins for character design updates. Depending on their item tags, they may also have additional functionality.

= Editing =

== Categories ==
Editing item categories and items requires the '''Edit World Data''' power.

Item categories can be created in the admin panel, with the usual category properties:

* Name
* World Page Image
* Description (accepts HTML)

The image and description are displayed only on the world page. Categories are optional, but useful for sorting items. Items without a category will be placed in a "Miscellaneous" category in the inventory.

Additionally, categories can be sorted from the Item Categories index page. This order reflects the sorting order of categories in user inventories.

== Items ==
Items themselves have the following properties:

* Name
* World Page Image
* Item Category
* Description (accepts HTML)
* Allow User → User Transfer

'''Name''' is the item name which is displayed on the item index and shown in user inventories.

The '''World Page Image''' is shown in the encyclopedia, and also functions as the item's thumbnail image in inventories. As with all encyclopedia images, the recommended size is 200 x 200 pixels, but can be any size.

'''Item Category''' is the category to which the item falls under, and used for organisation. It is otherwise optional.

'''Description''' is a description of the item for the encyclopedia page.

'''Allow User → User Transfer''' is a setting for whether the item can be transferred to another user. This can be used to create account-bound items - items with this turned off cannot be sent to another user or added to a trade. Note that individual items can also be account-bound at the time of granting, so this setting does not have to be used if you want to create only selectively account-bound items.

== Item Tags ==
This is a section under the item editing form that becomes accessible after the item has been created. Item tags are special settings that affect how the item can be used from a user's inventory - what they do has to be written in the site code itself, but once coded, can be attached to any item to give them the special behaviour.

The Add a Tag button can be used to select an item tag. Duplicate item tags cannot be added to the same item. Attached item tags can be toggled on or off to allow or remove functionality without completely removing the item tag.

By default, the Box type item tag is available - this allows you to choose a particular set of rewards from items, currencies and loot tables. When a user chooses to use the item in the inventory, they will receive these rewards. The process of creating this item tag can be seen in this tutorial.

= Inventory =
Each user has an inventory, which is sorted by item category and further sorted by alphabetical order of item names. Clicking on an item brings up a menu that lists the item's source (if any), accompanying notes (if any), and actions that can be performed on it.

The '''Source''' field notes down the source of the item. This field is automatically filled out when the user receives an item through site activity e.g. through prompts/claims and functions as a record of how/why an item was received. In the case of shop purchases, this also notes who purchased the item, the shop it was purchased from, and the price.

The '''Notes''' field contains additional information about the item. This is sometimes automatically filled out - for example, purchasing an item from a shop will fill the Notes section with the date of purchase. When granting an item from the admin panel, staff can fill in this section with a custom message.

Below this section, actions that can be used are listed. Special actions from item tags are listed first, then general actions.

'''Transfer Item''' (if the item can be transferred) allows the user to transfer the item to another user.

'''Delete Item''' allows the users to trash the item entirely.

= See Also =

* User Accounts
* Shops
* Tutorial: Creating Item Types

@@ Line 65: / Line 65: @@
 The Add a Tag button can be used to select an item tag. Duplicate item tags cannot be added to the same item. Attached item tags can be toggled on or off to allow or remove functionality without completely removing the item tag.
-By default, the Box type item tag is available - this allows you to choose a particular set of rewards from items, currencies, loot tables, and tickets for any active raffles ([[Updating: to 2.0.0|2.0.0]]). When a user chooses to use the item in the inventory, they will receive these rewards. The process of creating this item tag can be seen in [[Tutorial: Creating Item Types|this tutorial]].
+By default, two item tags are available:
 ==Inventory==

@@ Line 25: / Line 25: @@
 **If set/non-0, this limits the number of items of the category a character can own at one time.
 *'''Can be Named'''
-**Whether or not items in this category can be "named" when in character inventories, i.e. in the case of pets. This does not override the name of the item itself.
+**Whether or not items in this category can be "named" when in character inventories, e.g. in the case of pets. This does not override the name of the item itself.
 Additionally, categories can be sorted from the Item Categories index page. This order reflects the sorting order of categories in user inventories.
@@ Line 87: / Line 87: @@
 *'''Name Item''' (if the item can be "named")
-**Allows the user to assign a nametag to a stack, i.e. in the case of a pet.
+**Allows the user to assign a nametag to a stack, e.g. in the case of a pet.
 *'''Transfer Item''' (if the item can be transferred)
 **Allows the user to transfer all or part of stack(s) to the inventory of the character's owner.

@@ Line 58: / Line 58: @@
 **Prompts from which the item may be awarded. Provides a list of (active) prompts to select from.
-When these fields are enabled, items' world entries will also automatically display any shops that the item is currently stocked in.
+When these fields are enabled, items' world entries will also automatically display any shops that the item is currently stocked in. For more information, see [[Extensions:Item Entry Expansion|Item Entry Expansion]].
 ====Item Tags====
@@ Line 92: / Line 92: @@
 *'''Delete Item'''
 **Allows the users to trash all or part of stack(s) entirely.
-***
 ==See Also==

@@ Line 20: / Line 20: @@
 Item categories also have the following properties pertaining to character ownership of the items in them ([[Updating: to 2.0.0|2.0.0]]):
-* '''Can be Owned by Characters'''
+*'''Can be Owned by Characters'''
-** Whether or not items in the category can be owned by characters/users can transfer items in this category from their inventory to their characters' inventories.
+**Whether or not items in the category can be owned by characters/users can transfer items in this category from their inventory to their characters' inventories.
-* '''Character Hold Limit'''
+*'''Character Hold Limit'''
-** If set/non-0, this limits the number of items of the category a character can own at one time.
+**If set/non-0, this limits the number of items of the category a character can own at one time.
-* '''Can be Named'''
+*'''Can be Named'''
-** Whether or not items in this category can be "named" when in character inventories, i.e. in the case of pets. This does not override the name of the item itself.
+**Whether or not items in this category can be "named" when in character inventories, i.e. in the case of pets. This does not override the name of the item itself.
 Additionally, categories can be sorted from the Item Categories index page. This order reflects the sorting order of categories in user inventories.
@@ Line 41: / Line 41: @@
 **A description of the item for the encyclopedia page.
 *'''Allow User → User Transfer'''
-**A setting for whether the item can be transferred to another user. This can be used to create account-bound items - items with this turned off cannot be sent to another user or added to a trade. Note that individual items can also be account-bound at the time of granting, so this setting does not have to be used if you want to create only selectively account-bound items. Note also that account-bound items created through either method cannot be transferred to characters.
+**A setting for whether the item can be transferred to another user. This can be used to create account-bound items - items with this turned off cannot be sent to another user or added to a trade. Note that individual items can also be account-bound at the time of granting, so this setting does not have to be used if you want to create only selectively account-bound items. Note also that account-bound items created through either method cannot be transferred to characters. Likewise, if an account-bound item is granted directly to a character, it may not be transferred to its owner's inventory.
 Additionally, if the extra fields from [[Extensions:Item Entry Expansion|Item Entry Expansion]] are enabled in the extensions [[Config Files|config file]], several additional properties are added, all of which are optional:
-* '''Item Rarity'''
+*'''Item Rarity'''
-** A numeric value representing the item's rarity. Rarities can be any number relative to each other, but it is recommended (especially if using the optional rarity conditions with [[Loot Tables|loot tables]]) to have a consistent, unidirectional scale.
+**A numeric value representing the item's rarity. Rarities can be any number relative to each other, but it is recommended (especially if using the optional rarity conditions with [[Loot Tables|loot tables]]) to have a consistent, unidirectional scale.
-* '''Reference Link'''
+*'''Reference Link'''
-** The URL of an extended reference on the item and/or it's function.
+**The URL of an extended reference on the item and/or it's function.
-* '''Item Artist'''
+*'''Item Artist'''
-** Either an on-site user or URL.
+**Either an on-site user or URL.
-* '''Uses'''
+*'''Uses'''
-** A brief summary of the item's use(s). Accepts HTML.
+**A brief summary of the item's use(s). Accepts HTML.
-* '''Original Source'''
+*'''Original Source'''
-** A brief summary of the item's origin.
+**A brief summary of the item's origin.
-* '''Drop Location(s)'''
+*'''Drop Location(s)'''
-** Prompts from which the item may be awarded. Provides a list of (active) prompts to select from.
+**Prompts from which the item may be awarded. Provides a list of (active) prompts to select from.
 When these fields are enabled, items' world entries will also automatically display any shops that the item is currently stocked in.
@@ Line 68: / Line 68: @@
 ==Inventory==
-Each user has an inventory, which is sorted by item category and further sorted by alphabetical order of item names. Items within this inventory are "stacked", meaning that all copies of an item, or stacks, are collapsed down to one entry in the user's inventory. Clicking on an item brings up a menu that lists all stacks' source information (if any), accompanying notes (if any), and actions that can be performed on the item.
+Each user has an inventory, which is sorted by item category and further sorted by alphabetical order of item names. Items within this inventory are "stacked" ([[Updating: to 2.0.0|2.0.0]]), meaning that all copies of an item, or stacks, are collapsed down to one entry in the user's inventory. Clicking on an item brings up a menu that lists all stacks' source information (if any), accompanying notes (if any), and actions that can be performed on the item.
 The '''Source''' field notes down the source of the item. This field is automatically filled out when the user receives an item through site activity e.g. through prompts/claims and functions as a record of how/why an item was received. In the case of shop purchases, this also notes who purchased the item, the shop it was purchased from, and the price.
@@ Line 76: / Line 76: @@
 Below this section, actions that can be used are listed. Special actions from item tags are listed first, then general actions.
-* '''Transfer Item to Character''' (if the item can be transferred) ([[Updating: to 2.0.0|2.0.0]])
+*'''Transfer Item to Character''' (if the item can be transferred) ([[Updating: to 2.0.0|2.0.0]])
-** Allows the user to transfer the item to one of their characters. Only available if the item can be owned by characters.
+**Allows the user to transfer all or part of stack(s) to one of their characters. Only available if the item can be owned by characters.
-* '''Transfer Item''' (if the item can be transferred)
+*'''Transfer Item''' (if the item can be transferred)
-** Allows the user to transfer the item to another user.
+**Allows the user to transfer all or part of stack(s) to another user.
-* '''Delete Item''' allows the users to trash the item entirely.
+*'''Delete Item'''
-=== Character Inventories ===
+===Character Inventories ([[Updating: to 2.0.0|2.0.0]])===
-Character inventories are largely similar to user inventories. The notable difference is that different actions may be used on items:
+Character inventories are largely similar to user inventories. The notable difference is that different actions may be used on items compared to user inventories:
-* '''Name Item''' (if the item can be "named")
+*'''Name Item''' (if the item can be "named")
-**
+**Allows the user to assign a nametag to a stack, i.e. in the case of a pet.
 ==See Also==
@@ Line 93: / Line 99: @@
 *[[Shops]]
 *[[Tutorial: Creating Item Types]]

← Older revision	Revision as of 20:58, 27 June 2021
(No difference)