Eskin block segment - accident12123/eversion GitHub Wiki

Overview

A Segment is the heart of a user interacting with the screen. For detailed explanation of segments please read: eversion:eskins:ref:segment and eversion:eskins:dev

Format

<segment> <name></name> <control></control> <datasource></datasource> <startx></startx> <starty></starty> <tilesize></tilesize> <endx></endx> <endy></endy> <scroll></scroll> <first></first> <stat></stat> <offset></offset> <cursor>See cursor below</cursor> <tile>See tile below</tile> </segment>

NAME

The unique name of this segment. Name is optional on everything but extremely important with segments. In order to update other parts of the screen as you scroll around, you add segname with the name of the segment that updates them.

CONTROL

Control is the path and name of the control file used for this segment. If your segment is working from jukebox data, you should NOT have a control option.

See eversion:eskins:ref:control for more information about control files.

DATASOURCE

Data Source is used to pull data from an existing data load into your segment.

See eversion:eskins:ref:segment for datasource list.

startx,y and endx,y

For segments requiring a location on the screen, start is the upper left coordinates on the screen of the segment. end is the bottom right corner of the segment. Keep in mind, this is only for the moving parts of the segment (if any). All artwork, borders, etc to frame the segment should be done before adding the segment.

tilesize

Starting in R0087, you can use startx, starty and set tilesize to true and the segment will automatically figure out the endx,y using your tile settings for what is visible.

default: false.

scroll

Scroll is the direction the user moves through the segment.

  • Horizontal
  • Vertical

stat

True/False. When set to true, the cursor does not move and the segment moves instead. (see aeonhome in evstreamed for a working example). Only available when rows=1

first

Move the cursor to a different starting position. If greater than the number of tiles, the last tile is used

offset

Similar to first, but shifts the segment by x tiles. For example if you have 1,2,3,4,5 visible on the screen. using offset 2 will make it ,,1,2,3 visible. The whole field will beused to scroll, this is just starting point. only available in single row/column designs.

cursor

Cursor is the optional moving graphic to show where on the screen you are. See eversion:eskins:block:cursor for full details.

tile

Tiles are the individual selectable items inside a segment. See eversion:eskins:block:tile for full details.

⚠️ **GitHub.com Fallback** ⚠️