Ryzom API/Item icon

From EncyclopAtys

< Ryzom API
Revision as of 08:50, 23 July 2020 by Dorothée (talk | contribs) (Created page with "<noinclude>___TOC__</noinclude> 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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
_

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

URL 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.
icon
Example
c (optional), default is 1
The color of the item. It's a value between 0 and 7
c=1
Example Example Example Example
0 1 2 3
Example Example Example Example
4 5 6 7
q (optional), default is 0
The quality of the item.
Example
q=0
Example Example
0 10
s (optional), default is 0
The size of the stack.
Examples=0
Example Example
0 10
sap (optional) number of sap of the item.
-1 = (default) No sap icon, no number
0 = sap icon, no number
Example
sap=-1
Example Example Example Example Example
-1 0 1 2 3
destroyed (optional) display the item as if it was destroyed (with a red cross)
0 = (default)
Example
destroyed=0
Example Example
0 1
label (optional), draw icon text if present
1 = (default)
Example
label=1
Example Example
0 1
locked (optional) display the item as if it was locked by the owner
0 = (default)
Example
0 = (default)
Example Example
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=\"\">";