Difference between revisions of "Item schema"

From Team Fortress Wiki
Jump to: navigation, search
(Redirected page to WebAPI/GetSchema)
 
(create new article as a more generalised topic about 'item schema' - will write more about purpose etc in talk page.)
Line 1: Line 1:
#REDIRECT [[WebAPI/GetSchema]]
+
{{hatnote|For more in-depth technical documentation pertaining to the Steam Web API and GetSchema, see [[WebAPI]].}}
 +
 
 +
The '''item schema''' is a resource in ''Team Fortress 2'' that defines all existing items and the attributes assigned to them. The item schema is accessed by the game client in various menus of the interface, including the [[Mann Co. Store]], [[Mann Co. Catalog|Catalog]] and the player's [[backpack]]. Each item in the schema is maintained as an object with varying key-value pairs denoting its name, its type and slot, [[classes]] that can equip it, and its capabilities (such as, whether it can be used with a [[Paint Can]] or [[Name Tag]]). All values are listed in detail at [[WebAPI/GetSchema]].
 +
 
 +
In addition to the standard item schema, the schema version pulled by the game client is known as the 'client schema'. The client schema is obtained in [[WebAPI/VDF|VDF]] format for parsing by the game engine, and includes other details not in the standard schema, such as [[equip region]]s, attached weapon sounds, and [[bodygroup]]s for each item.
 +
 
 +
The item schema also includes a listing of [[List of item attributes|item attributes]], [[item sets]], [[particle effects]] and item levels and ranks for [[Strange]] weapons and the [[Spirit Of Giving]] [[miscellaneous item]].
 +
 
 +
== Item schema updates ==
 +
 
 +
{{see also|Patches}}
 +
 
 +
All updates to the item schemas for ''Team Fortress 2'' and ''[[Team Fortress 2 Beta]]'' are kept in the [[OPTF2]] [http://git.optf2.com/schema-tracking/ Schema Tracker], a [[w:Git (software)|Git]] repository. Previous versions and changes in updates are viewable as [[w:diff|diffs]].
 +
 
 +
== See also ==
 +
* '''[[WebAPI]]'''
 +
** [[WebAPI/GetSchema]] – technical description of the item schema as accessible via the Steam Web API
 +
* [[Items]]
 +
 
 +
== External links ==
 +
* [http://git.optf2.com/schema-tracking/ OPTF2 Schema Tracker]
 +
** Latest version of [http://git.optf2.com/schema-tracking/plain/Team%20Fortress%202%20Schema Team Fortress 2 Schema]
 +
** Latest version of [http://git.optf2.com/schema-tracking/plain/Team%20Fortress%202%20Client%20Schema Team Fortress 2 Client Schema]
 +
 
 +
[[Category:Items]]
 +
[[Category:WebAPI]]

Revision as of 03:03, 6 January 2012

For more in-depth technical documentation pertaining to the Steam Web API and GetSchema, see WebAPI.

The item schema is a resource in Team Fortress 2 that defines all existing items and the attributes assigned to them. The item schema is accessed by the game client in various menus of the interface, including the Mann Co. Store, Catalog and the player's backpack. Each item in the schema is maintained as an object with varying key-value pairs denoting its name, its type and slot, classes that can equip it, and its capabilities (such as, whether it can be used with a Paint Can or Name Tag). All values are listed in detail at WebAPI/GetSchema.

In addition to the standard item schema, the schema version pulled by the game client is known as the 'client schema'. The client schema is obtained in VDF format for parsing by the game engine, and includes other details not in the standard schema, such as equip regions, attached weapon sounds, and bodygroups for each item.

The item schema also includes a listing of item attributes, item sets, particle effects and item levels and ranks for Strange weapons and the Spirit Of Giving miscellaneous item.

Item schema updates

See also: Patches

All updates to the item schemas for Team Fortress 2 and Team Fortress 2 Beta are kept in the OPTF2 Schema Tracker, a Git repository. Previous versions and changes in updates are viewable as diffs.

See also

External links