Difference between revisions of "Background"

From HSYCO
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 3: Line 3:
  
 
== Parameters ==
 
== Parameters ==
*'''id''': the object's ID, used by UISets
+
{{UI Object Parameter (ID)}}
*'''image''': image file name
+
{{UI Object Parameter (image)}}
  
 
{{Note: IMG Filename}}
 
{{Note: IMG Filename}}
Line 13: Line 13:
  
 
== UI Attributes ==
 
== UI Attributes ==
{{:UI Object Attributes (Image)}}
+
{{UI Object Attributes (Image)}}

Latest revision as of 17:29, 21 January 2014

Note  For a description and a complete list of UI Objects, see UI Objects.

Page's background image.

Parameters

  • id: the object's ID, used by UISets
  • image: image filename
Image files are searched inside the www/<project's name>/img directory first, then inside the www/img directory.
If the filename is set with a UISet, it's possible to load an image from the web by entering the URL, or a path relative to www/<skin's name>/pic by specifying /pic/ followed by the filename

Syntax

(background<!id> <image's filename>)

E.g.

(background!menubackground menubackground.png)

UI Attributes

Image attributes

Name Value Description
img <full url (http://...)> Set the image source
<path relative to the project's img/ path>
<empty string> Empty picture
draw <draw instructions> Draws the image. See the Draw API

e.g.: line(0,100,20,50,blue);line(50,50,70,70,'255,10,150');

legacymode true To use with the draw attribute. Enables a compatibility mode that allows draw instructions on old browsers. It works by sending instructions to the HSYCO server that generates an image. For this reason it's slower.