Difference between revisions of "Ryzom API/Item icon"

From EncyclopAtys

Jump to: navigation, search
(URL Parameters)
(Usage)
Line 11: Line 11:
 
! Parameter !! Description !! Default !! Example icon
 
! Parameter !! Description !! Default !! Example icon
 
|-
 
|-
| sheetid || It's the id of an item that you can find in the Character xml file.<br />For example, '''iczahp_3.sitem''' is a valid '''sheetid'''. <br /> sheetids can me found in [https://github.com/nimetu/ryzom_extra Nimetu's ryzom_extra repository] ||  ||  
+
| sheetid || It's the id of an item that you can find in the Character xml file.<br />For example, '''iczahp_3.sitem''' is a valid '''sheetid'''. <br /> [[#Third party libraries|sheetids]] can me found in [https://github.com/nimetu/ryzom_extra Nimetu's ryzom_extra repository] ||  ||  
 
{|
 
{|
 
|-
 
|-

Revision as of 17:09, 15 September 2020

Retrieves Item icons

Usage

<base URL>/item_icon.php?sheetid=iczahp_3.sitem&c=1&q=0&s=0&sap=-1&destroyed=0&label=1&locked=0

URL Parameters

Parameter Description Default Example icon
sheetid It's the id of an item that you can find in the Character xml file.
For example, iczahp_3.sitem is a valid sheetid.
sheetids can me found in Nimetu's ryzom_extra repository
iczahp_3.sitem
c (optional), default is 1
The color of the item. It's a value between 0 and 7
c=1
0 1 2 3
4 5 6 7
q (optional), default is 0
The quality of the item.
q=0
0 120
s (optional), default is 0
The size of the stack.
s=0
0 53
sap (optional) number of sap plus 1 of the item.
-1 = (default) No sap icon, no number
0 = sap icon, no number
sap=-1
-1 0 1 2 8
destroyed (optional) displays the item as if it was destroyed (with a red cross)
0 = (default)
destroyed=0
0 1
label (optional), draws icon text if present
1 = (default)
label=1
0 1
locked (optional) display the item as if it was locked by the owner
0 = (default)
locked=0
0 1

Cache Duration

It's cached for ever. Since the icon is unique and never change. For a specific icon, it'll always return the same image.

PHP interface

ryzom_item_icon_url($sheetid, $c=-1, $q=0, $s=0, $sap=-1, $destroyed=false, $label=true, $locked=false)

Returns a string that contains the url to display a item icon.

<?php
require_once "ryzomapi_lite.php";

$url = ryzom_item_icon_url('iczahp_3.sitem', 2);

echo "<img src=\"{$url}\" alt=\"\">";