Difference between revisions of "User"
Jump to navigation
Jump to search
Line 30: | Line 30: | ||
== Syntax == | == Syntax == | ||
− | (user[!<id>] <name>; <param>; <position>; <color>; < | + | (user[!<id>] <name>; <param>; <position>; <color>; <label>) |
− | (usermini[!<id>] <name>; <param>; <position>; <color>; < | + | (usermini[!<id>] <name>; <param>; <position>; <color>; <label>) |
− | (usermicro[!<id>] <name>; <param>; <position>; <color>; < | + | (usermicro[!<id>] <name>; <param>; <position>; <color>; <label>) |
E.g. | E.g. |
Revision as of 15:20, 28 January 2014
A button used to execute customized Java code or generate events for the EVENTS interpreter. Pressing this button, HSYCO calls the method:
- userCommand(String name, String param)
in the user.class class. HSYCO also executes all actions associated to the event:
- USER name=param
defined in EVENTS. For a tutorial on how to use this object see Working with User objects. A long press will repeat the request every second.
It has several colors (depending on the skin) and three different sizes:
- user (standard size)
- usermini (medium size)
- usermicro (small size)
For a custom image version, see UserImage.
For an object with a list of user commands, see UserList.
Parameters
- id: the object's ID, used by UISets. Required
- name: name passed to the Java callback method and event in EVENTS
- param: parameter passed to the Java callback method and event in EVENTS
- position: the object's position. Use the pixels or rows and columns coordinates format
- color: the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass)
- label: the text label on the button. It can contain HTML tags
- repeat: if true, the command will be repeat every second
Syntax
(user[!<id>] <name>; <param>; <position>; <color>; <label>) (usermini[!<id>] <name>; <param>; <position>; <color>; <label>) (usermicro[!<id>] <name>; <param>; <position>; <color>; <label>)
E.g.
(user!user1 name; param; r3c1; gr; label; enabled) (usermini!user1 name; param; r3c1; b; label;) (usermicro!user1 name; param; x0y10; r; label;)
UI Attributes
Common attributes
Name | Value | Description |
---|---|---|
pos | x<x>y<y> | Position specified as x/y coordinates. E.g. x-5y10 |
visible | true | Default. Show the object |
false | Hide the object | |
blink | true | slow | Blink the object at a slow speed |
fast | Blink the object at a fast speed | |
false | Stop the blinking | |
opacity | 0.0 ... 1.0 | Object opacity from 0 (not visible) to 1 (fully visible) |
rotation | 0 ... 360 | Object rotation in degrees. Images are rotated around the center point, all other objects are rotated around the top left corner |
Button attributes
Name | Value | Description |
---|---|---|
style | red,green,blue... | Set the button's style (color). Styles vary depending on the selected skin |
enabled | true | Default. Enable the button |
false | Disable the button |