Difference between revisions of "User:Ath/WebAPI Examples"

From Team Fortress Wiki
Jump to: navigation, search
m (Preliminary cleanup)
m (comment out category on user page)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
This page is intended as a quick reference for working with the [[WebAPI]]. As such, it is intended to provide basic examples of how to make use of certain fields, not act as a tutorial.
+
This page is intended as a quick reference for working with the [[WebAPI]]. As such, it is intended to provide a basic explanation of how to understand and work with certain fields, not act as a tutorial.
  
 
==[[WebAPI/GetPlayerItems|GetPlayerItems]]==
 
==[[WebAPI/GetPlayerItems|GetPlayerItems]]==
  
 
===inventory===
 
===inventory===
−
The inventory field contains a binary token encoded in denary form. The first 16 least significant bits denote an item's position within the backpack, the following 16 bits indicate which classes an item is currently equipped to. The first two most significant bits are unused.
+
Contains a binary token encoded in denary form. The first 16 least significant bits denote an item's position within the backpack, the following 16 bits indicate which classes an item is currently equipped to. The first two most significant bits are currently unused.
  
−
function is_equipped($inventory_token)
+
===contained_item===
−
{
+
Contains a sub-array with the id, defindex and quality of a giftwrapped item.
−
  return ($inventory_token & 0x0FFF0000) ? true : false;
+
 
−
}
+
===attributes===
−
function is_equipped_for_class($class, $inventory_token)
+
Has a variable number of sub-arrays containing an attribute definition index and values. See the [[List_of_Item_Attributes|list]] for a complete overview of all attributes.
−
{
 
−
  return ($inventory_token & 0x80000000) && ($inventory_token & (0x00010000 << $class));
 
−
}
 
−
function extract_backpack_position($inventory_token)
 
−
{
 
−
  return $inventory_token & 0x0000FFFF;
 
−
}
 
  
 
==[[WebAPI/GetSchema|GetSchema]]==
 
==[[WebAPI/GetSchema|GetSchema]]==
−
TODO
 
  
−
[[Category:WebAPI|Examples]]
+
===proper_name===
 +
If true, indicates the presence of a language-specific prefix, ignored when non-Unique quality is set.
 +
 
 +
==Misc==
 +
{| class="wikitable grid"
 +
! class="header" | №
 +
! class="header" | Color
 +
! class="header" | Quality Name
 +
|-
 +
! 0
 +
| style="background:#B2B2B2" | #B2B2B2
 +
| [[#Normal Items|Normal]]
 +
|-
 +
! 1
 +
| style="background:#4D7455" | #4D7455
 +
| [[#Genuine Items|Genuine]]
 +
|-
 +
! 2
 +
| style="background:#8D834B" | #8D834B
 +
| Rarity2
 +
|-
 +
! 3
 +
| style="background:#476291" | #476291
 +
| [[#Vintage Items|Vintage]]
 +
|-
 +
! 4
 +
| style="background:#CF6A32" | #CF6A32
 +
| Rarity3
 +
|-
 +
! 5
 +
| style="background:#8650AC" | #8650AC
 +
| [[#Unusual Items|Unusual]]
 +
|-
 +
! 6
 +
| style="background:#FFD700" | #FFD700
 +
| [[#Unique Items|Unique]]
 +
|-
 +
! 7
 +
| style="background:#70B04A" | #70B04A
 +
| [[#Community Items|Community]]
 +
|-
 +
! 8
 +
| style="background:#A50F79" | #A50F79
 +
| [[#Valve Weapons|Developer]]
 +
|-
 +
! 9
 +
| style="background:#70B04A" | #70B04A
 +
| [[#Self-made Items|Self-Made]]
 +
|-
 +
! 10
 +
| style="background:#476291" | #476291
 +
| Customized
 +
|-
 +
|}
 +
<!-- [[Category:WebAPI|Examples]] -->

Latest revision as of 03:50, 30 November 2011

This page is intended as a quick reference for working with the WebAPI. As such, it is intended to provide a basic explanation of how to understand and work with certain fields, not act as a tutorial.

GetPlayerItems

inventory

Contains a binary token encoded in denary form. The first 16 least significant bits denote an item's position within the backpack, the following 16 bits indicate which classes an item is currently equipped to. The first two most significant bits are currently unused.

contained_item

Contains a sub-array with the id, defindex and quality of a giftwrapped item.

attributes

Has a variable number of sub-arrays containing an attribute definition index and values. See the list for a complete overview of all attributes.

GetSchema

proper_name

If true, indicates the presence of a language-specific prefix, ignored when non-Unique quality is set.

Misc

№ Color Quality Name
0 #B2B2B2 Normal
1 #4D7455 Genuine
2 #8D834B Rarity2
3 #476291 Vintage
4 #CF6A32 Rarity3
5 #8650AC Unusual
6 #FFD700 Unique
7 #70B04A Community
8 #A50F79 Developer
9 #70B04A Self-Made
10 #476291 Customized
Retrieved from "https://wiki.teamfortress.com/w/index.php?title=User:Ath/WebAPI_Examples&oldid=840809"