Eskin block text - accident12123/eversion GitHub Wiki

Overview:

Text blocks are used to make text appear on the screen.

Design:

When designing your text, anything that doesn't change should not have a hyper level.

To make your skin internationally friendly, any text on the screen in your own language should be turned into a language file option. Just use the variable for your "prompt" instead and users can translate your eskin into their own language.

Format:

`

`

NAME

A unique name identifying this element of your screen. eversion:eskins:ref:elements

Special names for text blocks:

  • clock: Eversion will automatically update the time per user settings inside this block.
  • pagenavfull: when a user is scrolling really fast where the extra data is not updating, this will always get # / # for what page they are on.
  • cursorloc: just like pagenavfull it will always display the current position #.

CONDITION

conditions are if statements to pick when to add this block to the screen. See eversion:eskins:block:if

Display

The text to put on the screen :) Variable friendly.

POSX and POSY

The x,y coordinates of the upper left corner of the text box.

Width and Height

The width and height of the text box.

Wordwrap

true or false, default false.

If your text is more than 1 line on the screen, set this to true to enable multiline wordwrapping. It will slow down single line text so use this correctly for best performance.

HTML

true or false, default false.

Flashlite has a very limited ability to process html. Setting to true enables html processing of the text field. It will process more than text including some css and images. It processes slower so you should use it sparingly but can come in handy for situations like plots where there may be
line breaks.

I do not have a good support reference url to provide, if you find one please let us know so we can add it here. Refer to Flashlite 3.1 support if you find it, it should be very close to Flash 8.0.

If you start to use this option to pull off some things you can't do with Eversion, please let us know what they are so we can add native faster support for them.

Align

left, center or right: Default left.

This is the Alignment of text inside your text box.

Font

The font to use. For the most part, this field does nothing. Font's in flashlite and how they differ on the Player hardware is a very confusing thing to lock down what options we have to reliably use it. If your a skinner that wants to use this field to change the font, please contact me (accident) and I'll work with you on trying to figure this out. Until then, I'm skipping over this to work on more pressing issues.

Size

The font size in points. Default is 20.

Color

The font color represented in three 8-bit RGB components. This field is variable friendly to allow your users to adjust skin colors inside your config files.

Examples:

  • red: FF0000
  • green: 00FF00
  • white: FFFFFF
  • black: 000000

There are many html tools available to help you figure out the color codes.

Color in a variable

If you want to add the RGB color code to your eskin settings file. just use the setting name instead of the RGB color code. Warning, if your setting name is 6 letters long it will not work. anything not 6 letters is assumed a variable name.

ex: titlecolor

BOLD, ITALIC, UNDERLINE

true or false, default false.

Enables bold, italic or underline for your text.

leading

The spacing between lines of text when your text is multiline (wordwrap=true). This should be a number in points.

It's unclear what is supported on what player at this time. You might be able to use negative values to get text lines closer together. We're going to say try to avoid this if possible because we're pretty sure for your eskin to work the same on all devices, that will not be available.

Segments and Tiles

In addition to the above, you have the following additional items when your text blocks will change when used with a segment or tile.

<text> <segname></segname> <hlcolor></hlcolor> <hyper></hyper> </text>

segname

When you have text on the screen that changes as a user moves around in a segment, you need to connect the text block to the segment it is for. This way the text will not be updated when the user is inside another segment where the screen needs to freeze or different text on the screen may change. For this you need a segname AND a hyper setting.

If you have data that does not update but comes from a segment, you use segname without hyper and it will be drawn on the screen immediately after the segment is ready. This is very handy for things like nav buttons, the number of tiles the user can scroll around, etc etc.

This option is only used for text not inside a tile. Tiles have their own control internally.

hlcolor

This field is exactly the same as color. When text is used in a tile, you may want the color of the text to be different when the user scrolls to that selection. This is where you specify the other color to use.

NOTE: you can also use the settings variable here.

HYPER

Hyper has 2 purposes:

  • It tells Eversion to update the text every time the user moves in a segment
  • It has the hyperscroll draw level for when to update the screen based on the users hyperscroll options.

Hyper is only used for text not inside a segment. Make sure you also use the segname option so eversion knows which text fields to update.

For more information on Hyperscroll, draw levels and recommendations see: eversion:eskins:dev

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