llSetFaceText

From Second Life Wiki
Revision as of 09:49, 15 November 2008 by Darwin Recreant (talk | contribs)
Jump to navigation Jump to search
Emblem-important-yellow.png LSL Feature Request
The described function does not exist. This article is a feature request.

Summary

Function: llSetFaceText( integer face, string text, integer chars_per_line, vector color, integer font );
REQUEST Function ID
0.0 Forced Delay
10.0 Energy

Will display text on face as a regular texture would, using the assigned font, and wrapping lines at the end of chars_per_line.

• integer face the face number of the prim
• string text text to display
• integer chars_per_line number of characters until wrapping lines
• vector color vector showing RGB values
• integer font the font used

Caveats

  • Text is limited to 1024 bytes, if the string is longer it will be truncated to 1024 bytes.
  • Text will stretch across the face of the prim as a texture would, while following the chars_per_line rule only in changing the textual structure.
  • To remove face text from face, use the following:

<lsl>llSetFaceText(face, "", 0, <1.0, 1.0, 1.0>, 0);</lsl>

  • The font type will be based on any font built-in to the release client and available as LSL constants, such as:
    • FACE_FONT_TIMES_NEW_ROMAN
    • FACE_FONT_SANS_SERIF
    • etc
  • Use -1 for chars_per_line to disable word wrapping
All Issues ~ Search JIRA for related Bugs

Examples

Example of using the function on a prim saying "Hello World": <lsl> default {

   state_entry()
   {
       llSetFaceText(0, "Hello World!", -1, <1.0, 1.0, 1.0>, 1);
   }
}</lsl>

Deep Notes

Search JIRA for related Issues

Signature

//function void llSetFaceText( integer face, string text, integer chars_per_line, vector color, integer font );