Edit History

GuildIcon

Version 3 (vl, 04/24/2009 03:06 pm)

1 1 vl 
h1. GuildIcon
2 1 vl 





3
1
vl

h2. Base URL





4
1
vl






5
3
vl

* http://atys.ryzom.com/api/guild_icon.php





6
1
vl






7
2
vl

h2. URL Parameters





8
1
vl






9
2
vl

h3. @icon@





10
1
vl






11
2
vl

It's a raw 64 bits number that contains all information to render a guild icon. It's the number that is in the [[Character]] xml file under @guild->icon@ ("example":http://atys.ryzom.com/api/guild_icon.php?icon=4505559206513107).





12
1
vl






13
2
vl

h3. @size@ (optional)





14
1
vl






15
2
vl

Default @size@ is @s@.





16
1
vl






17
2
vl

* @s@: Small guild icon (32x32 pixels) ("example":http://atys.ryzom.com/api/guild_icon.php?icon=4505559206513107&size=s).





18
2
vl

* @b@: Big guild icon (64x64 pixels) ("example":http://atys.ryzom.com/api/guild_icon.php?icon=4505559206513107&size=b).





19
1
vl






20
2
vl

h2. Cache Duration





21
2
vl






22
2
vl

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





23
2
vl






24
2
vl

h2. PHP Interface





25
2
vl






26
2
vl

h3. @ryzom_guild_icon_image($icon, $size)@





27
2
vl






28
2
vl

Returns a string that contains the html code to display a guild icon.





29
2
vl






30
2
vl

h3. @ryzom_guild_icon_url($icon, $size)@





31
2
vl






32
2
vl

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





33
2
vl






34
2
vl

h3. @ryzom_guild_icon($icon, $size)@





35
2
vl






36
2
vl

Returns the image *data* of the guild icon. You should never use it except if you want to use the image to combine with another image for example.





37
2
vl






38
1
vl

h2. Real Examples





39
2
vl






40
2
vl

If you have a website that use this Ryzom API, tell it in the forum and we'll add it.