Second Life Wiki - User contributions [en]

CatLibraries

2015-10-25T09:31:23Z

Ochi Wolfe: Added LibObj

{{LSL Header|ml=*}}{{RightToc}}
==Libraries==

{| class="sortable" {{Prettytable}}
|- {{Hl2}}
! '''Name'''
! '''Creator'''
! '''Description'''
|-
||[[Associative Array Emulator|Associative Array (Dictionary) Emulator]]
||[[User:Alynna Vixen|Alynna Vixen]]
||This library provides a set of functions for using a list as an associative array where string based keys can refer to one or more variant elements.
|-
||[[BigNum|BigNum Library (RSA Encryption)]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||A BigNum Library for dealing with big numbers! Specialized for modular multiplication, and RSA encryption.
|-
||[[Library Combined Library|Combined Library]]
||[[User:Strife Onizuka|Strife Onizuka]]
||Library of mostly encoding and decoding functions, some more useful then others.
* String functions: Replace / Trim right / Trim left / Trim both
* Unicode conversion: UTF8 to Unicode / Unicode to UTF8
* List functions: Replace / Compare
|-
||[[Geometric|Geometric Library]]
||Community Project
||A substantial amount of various geometric functions for intersection and other purposes of 3D maths.
|-
||[[Interpolation|Interpolation Library]]
||[[User:Nexii_Malthus|Nexii Malthus]]
||A small set of interpolation functions.
|-
|[[LibObj]]
|{{User|Ochi Wolfe}}
|A library to manage state in LSL using an object-oriented approach.
|-
||[[LibraryDisplayLandScreenshot]]
||[[User:Jon Desmoulins|Jon Desmoulins]]
||A modified version of LibraryDisplayProfilePic using the new [[PARCEL_DETAILS_ID]] Implemented in Server v1.36
|-
||[[LinksetIndexing|Linkset Indexing]]
||[[User:Nexii_Malthus|Nexii Malthus]]
||Functions for indexing a linkset by patterns or names down to their linkset numbers.
|-
||[[Wiki3DBuilder]] [[Wiki3DBuilder1.0]]
||[[User:Salahzar Stenvaag|Salahzar Stenvaag]]
||Allows a group of people to collectively build up complex 3D mindmaps with connected concepts. Uses particles for connections and low prim usage. Nodes can be textured, colored, changed form size moved collectively by everybody and can distribute notecards, landmarks, URL, objects, textures. I provide two version 0.1 and 1.0 and probably next version will communicate with moodle and sloodle external websites.
|-
||[[SL Mail V1.2]]
||[[User:Flennan Roffo|Flennan Roffo]]
||Second Life mail client V1.2 (released sept'07). Send and receive mail from within Second Life from and to any address. With Address Book function and many chat commands. V1.3 is upcoming soon!
|}

{{LSLC|}}

Category:LSL Library

2015-10-24T14:45:30Z

Ochi Wolfe: Added LibObj

{{LSL Header|ml=*}}{{RightToc}}
==Script Library==

<div id="box">
<div style="padding: 0.5em 0.5em 1.5em">
NOTE: Please add your scripts to this page and then add them to a category on the [[:Category:LSL Categorized Library|Categorized Library]] page.

Come to this page to see complex examples that show how to combine parts of LSL.

Go to the [[:Category:LSL Examples|LSL Examples]] page to see brief examples of how to use parts of LSL.

Why collect complex examples here? Well, ...

There is a treasure trove of user developed scripts that have become hard to find over time throughout Second Life's web server revisions and redesigns. The [http://community.secondlife.com/t5/Community-General/Upgrading-the-Forums/bc-p/77385 Huge Leap] to the new [http://www.jivesoftware.com/ Jive software], while traumatic and disruptive, has failed to dispose of what's come before at the moment of your reading. These valuable community generated resources do indeed still remain and can be browsed/retrieved from several disjointed and disparate locations. While some links may point to duplicated, revised, or downright ancient wisdom, you may derive some enlightened perspective researching their hard won, timely solutions we encounter day to day.

# [[Old forum Scripting Library index| Old Forums -Scripting Library index (wiki)]],
# [http://community.secondlife.com/t5/Scripting/bd-p/2108 Old Forums -Scripting Forum Archive],
# [http://forums-archive.secondlife.com/15/1.html Old Forums -Scripting Library],
# [http://community.secondlife.com/t5/Scripting-Library/bd-p/2122 new Forums -Archives > Scripting Library],
# [http://community.secondlife.com/t5/LSL-Scripting-Library/bd-p/LSLScriptingLibrary new Forums -LSL Library].

The wiki medium is well-suited for a script library due to its revision based historical foundation. If you feel inclined to release your scripts to the entire community, there's no better place to preserve your work/love/energy/gift as a unified and cohesive repository. Feel free to add your script page links here as well as adding it to the [[:Category:LSL Categorized Library|Categorized Library]].
</div>
</div>

<div id="box">

== Rules for posting: ==
<div style="padding: 0.5em">
#Your script must be tested and working. If it's not, stick it in your user-space until it is. This is a list of working, usable scripts.
#Add a link to your script's page here. Link back to this page from your script's page. Start your page with <code><nowiki>{{LSL Header}}</nowiki></code>.
#Do not add scripts that duplicate the same functionality as an existing script or built in {{LSLGC|Functions|function}}. If yours does, explain why.
#Do not list simple scripts here. Include those among the [[:Category:LSL Examples|LSL Examples]] instead.
</div></div>

<div id="box">

==LSL Script Library==

{| class="sortable" {{Prettytable}}
|- {{Hl2}}
! '''Name'''
! '''Creator'''
! '''Description'''
|-
|[[Notecard_Configuration_Reader_by_Maddox_Deluxe]]
|{{User2|Maddox Deluxe}}
|Notecard Multi-line Entries Configuration Reader v1.6.
|-
|[[User:Yumi Murakami/Addiction Moderator|Addiction Moderator and World Clock]]
|{{User|Yumi Murakami}}
|Keep tabs on usage of SL and easily share local times with other users.
|-
|[[User:Yumi Murakami/Bijocam And Other Camera Scripts|Bijocam and Other Camera Scripts]]
|{{User|Yumi Murakami}}
|Various camera control systems for machinima, security, and other effects.
|-
|[[Target Crosshair HUD]]
|[[User:Ackley Bing|Ackley]]
|A 2 prim HUD with crosshair targets nearby players names, profiles and user key
|-
|[[User:Ackley Bing/Basic Sim Status Button Indicator HUD|Basic Sim Status Button Indicator HUD]]
|[[User:Ackley Bing|Ackley]]
|A single prim HUD. Color indicates sim status changes.
|-
|[[Basic Target Scanner HUD]]
|[[User:Ackley Bing|Ackley]]
|A single prim HUD. Scrolls through nearby players names, photos and user key.
|-

|[[StringIsNum|(Function) StringIsNum]]
|{{User|Zion Tristan}}
|A User Made Function to return TRUE if a string based input consists entirely of a whole number, and return FALSE otherwise.
|-
|[[Remove all scripts from a linkset]]
|{{User2|Dahlia Orfan}}
|Remove all scripts from a linkset.
|-
|[[RLV Viewer Titler]]
|{{User2|Jenna Felton}}
|Titler displaying viewer and it's version, revealed via RLV interface.
|-
|[[Sim Restart Notifyer]]
|{{User2|Jenna Felton}}
|On region restart, notifyes registered residents about the sim is online and the current sim version
|-
|[[Script Vitality plug-in]]
|{{User2|Jenna Felton}}
|Uses vehicle technology to allow scripts (in same prim) to run in 'dead', i.e. no-script areas.
|-
|[[1st necessity of SL]]
|{{User|Beer Dailey}}
|Monitors for avatars and (de)activates scripts states to control script performance/lag.
|-
|[[3D Radar]]
|{{User|Jesse Barnett}}
|Rezzes a ball for each avatar in range. Each ball tracks its own AV and displays distance.
|-
|[[RegionSitTeleport]]
|{{User|Vincent Nacon}}
|A very simple and clean sit/unsit teleporter.
|-
|[[Avatar Position Adjustement to Avatar Height When Sitting]]
|{{User|Cay Trudeau}}
|Animation Adjustement According to Avatar Height. A simple snippet to calculate avatar position upwards.
|-
|[[AbcText]]
|{{User|Ange Capalini}}
|EXPERIMENTAL Hyper low prim Display. only 2 prims for 25char.
|-
|[[Access (NewAge)]]
|{{User|Asia Snowfall}}
|An easy to use script for permissions on who can use the script, Public/Group/Owner
|-
|[[User:Daemonika_Nightfire/Scripts/Access_Tutorial_EN|Access Tutorial (EN)]]
|{{User|Daemonika Nightfire}}
|Short examples about permission to executable commands.
|-
|[[Aim Detection]]
|{{User2|Han Shuffle|Dugley Reanimator}}
|Monitors for avatars and reports back to owner about who is aiming at them.
|-
|[[User:Daemonika_Nightfire/Scripts/Anti_copy_trans|Anti (copy & transfer)]]
|{{User|Daemonika Nightfire}}
|This funktion allows you to give away scripts with copy & transfer permissions and force the reseller to change the permission.
|-
|[[User:Daemonika_Nightfire/Scripts/Anti_Rezz|Anti Rezz]]
|{{User|Daemonika Nightfire}}
|This script delete the complete object by rezzing on ground and detach it after 5 minutes from avatar.
|-
|[[AnkleLock]]
|[[Wizardry and Steamworks]]
|An ankle lock script and attached animation to fix your displaced shoes. This will help if your shoes look displaced when you sit in certain poses or when your animation overrider is active.
|-
|[[AntiDelay Node]]
|{{User|Xaviar Czervik}}
|Uses [[llMessageLinked]] to stop those pesky delays.
|-
|[[Artillery]]
|[[Wizardry and Steamworks]]
|An artillery gun script, performing the necessary calculations based on a user-chosen velocity, in order to hit a designated target avatar.
|-
|[[AO Overriding Pose Ball]]
|{{User|Jesse Barnett}}
|No more turning your AO off and on when you sit down
|-
|[[ARCFOUR Strong Encryption Implementation]]
|{{User2|Nekow42 Zarf}}
|An LSL implementation of ARCFOUR, the most popular stream cipher still in use.
|-
|[[Assembly Programming Language|Assembly-Like Programming Language]]
|{{User|Xaviar Czervik}}
|A compiler that runs assembly-like programs.
|-
|[[Associative Array Emulator|Associative Array (Dictionary) Emulator]]
|{{User2|Alynna Vixen}}
|This library provides a set of functions for using a list as an associative array where string based keys can refer to one or more variant elements.
|-
|[[AvatarFollower]]
|{{User|Dale Innis}}
|Allows one avatar to automatically follow another.
|-
|[[Avatar Radar (NewAge)]]
|{{User|Asia Snowfall}}
|Version 1.2; A nice new avatar radar script i just finish that you can place in your hud, Also features avatar locator
|-
|[[Base2Dec]]
|{{User|Siann Beck}}
|Convert a number to decimal from any base.
|-
|[[BaseN]]
|{{User|Nexii Malthus}}
|Variable base compression, dynamically maps to usable UTF code points.
|-
|[[Basic Encryption Modules]]
|{{User|Beverly Larkin}}
|Basic encryption scripts, allows you to encrypt a float and shout it to another prim on a randomly chosen channel.
|-
|[[Be happy]]
|{{User|Emmas Seetan}}
|Basic smile attachment script, makes your avatar smile.
|-
|[[Beat The Average Vendor]]
|{{User2|Kristen Giano}}
|A vendor script based on humblebundle.com
|-
|[[Best Neighbor Ad Hiding Script|Best Neighbor]]
|{{User2|Doran Zemlja}}
|Reduce ad clutter by hiding ads when users are on their own land nearby.
|-
|[[BigNum|BigNum Library (RSA Encryption)]]
|{{User|Xaviar Czervik}}
|A BigNum Library for dealing with big numbers! Specialized for modular multiplication, and RSA encryption.
|-
|[[Binary Clock v1.1|Binary Clock]]
|{{User|Fox Diller}}
|A Binary Clock.
|-
|[[BinaryDecimalConverter]]
|{{User2|Soundless Smalls}}
|Converts a binary value to a decimal value and vice versa.
|-
|[[Blacklist and Remote Kill|Blacklist and Remote Kill]]
|{{User|Chase Quinnell}}
|Blacklist(denial of use) or a creator kill script(can delete someone's item by command on private channel)
|-
|[[User_talk:Rolig_Loon/Bookmark_URLs|Bookmark URLs]]
|{{User|Rolig Loon}}
|Dialog driven HUD reads bookmarked URLs from notecards and navigates directly to them with user's in-world browser.
|-
|[[Bubble Gum]]
|[[Wizardry and Steamworks]]
|A script to create a bubble gum effect with sounds and animations.
|-
|[[Bubble Trapper]]
|[[Wizardry and Steamworks]]
|A script that rezzes a bubble and surrounds a dialog-chosen avatar, exploding 2 seconds after it has reached the avatar. The article also explains how to hash a name to a number or a key to a number and thereby avoiding to block the rezzer's [[timer]] [[event]] or using [[llRegionSay]].
|-
|[[Builders Buddy|Builder's Buddy Tool]]
|{{User|Newfie Pendragon}}
|Script to easily move/rotate large builds that exceed the linkable size [[limits]].
|-
|[[Button Click Detector]]
|{{User2|Sendao Goodman}}
|Use [[llDetectedTouchUV]] to determine which button was pressed on a texture.
|-
|[[Camera following prim]]
|{{User|Dale Innis}}
|Pair of scripts to make a prim follow your camera position around (for lights etc).
|-
|[[Camera Sync]]
|{{User|Meyermagic Salome}} and {{User2|Nomad Padar}}
|A system to synchronize the cameras of two avatars.
|-
|[[Chatbot]]
|Anonymous
|Compile and run the LSL you type on a channel, faster than you can thru the 2007-08 SL GUI.
|-
|[[Chat Logger (GPL)]]
|{{User|Nobody Fugazi}}
|Chat logger which requests permission from participants before recording them.
|-
|[[Chat_Relay|Chat Relay]]
|{{User|grumble Loudon}}
|A Chat relay which can be routed using a path header and won't echo.
|-
|[[ClickAndDrag]]
|{{User|Nexii Malthus}}
| Click and Drag user interface elements using dynamic feedback
|-
|[[TimeAPI Clock Script]]
|[[User:Elite Runner|Ryan R. Elite (Elite Runner)]]
|Gets time via HTTP function from TimeAPI.org
|-
|[[Code Racer]]
|Anonymous
|Race two versions of code forever, to see which runs faster.
|-
|[[Code Sizer]]
|Anonymous
|Count the bytes compiled from source code, to measure how to write small code.
|-
|[[Collision message sender]]
|{{User2|Taff Nouvelle}}
|Give a message to an avatar on collision if the message has not been sent in the last 10 minutes.
|-
|[[User:Void_Singer/Programs#v7-D_Enh._Color_Picker|Color Changer]]
|{{User|Void Singer}}
|Dialog driven color changer. Supports 16million+ colors, web color codes, multiple targeted prims, with save and recall.
|-
|[[Color Changer|Color Changer Plus]]
|{{User2|Neo Calcutt}}
|A color changer with 14 colors, a random function, and a custom vector function.
|-
|[[Color conversion scripts|Color Conversion]]
|{{User|Sally LaSalle}}
|Convert between Red Green Blue (RGB) and Hue Saturation Value (HSV).
|-
|[[ColorConvert]]
|{{User|Siann Beck}}
|Convert color values to vector from RGB, hex or HTML color name.
|-
|[[Color script]]
|{{User2|Masakazu Kojima}}
|Script for changing colors trough a listener with pre-defined colors.
|-
|[[Library Combined Library|Combined Library]]
|{{User|Strife Onizuka}}
|Library of mostly encoding and decoding functions, some more useful then others.
* String functions: Replace / Trim right / Trim left / Trim both
* Unicode conversion: UTF8 to Unicode / Unicode to UTF8
* List functions: Replace / Compare
|-
|[[Computer:jaycoonlanguage]]
|{{User|jayco121 Bing}}
| A language written in LSL that is meant for my computer (available at the shop).
|-
|[[Read Note Card Configuration|Configuration Notecard Reader]]
|{{User|Dedric Mauriac}}
|A script to read configuration information from a notecard. Parses notecard to extract key words and their assigned values. Allows for comment lines and many more useful features.
|-
|[[AdvancedNotecardReader|Configuration Notecard Reader (advanced)]]
|[[Lear Cale|Lear Cale]]
|Robust configuration notecard reader; supports multiple notecards with same suffix, handles reconfig on inventory change, and does not usurp the default state.
|-
|[[Library_Chat_Relay|Conversation Relay]]
|{{User|Jippen Faddoul}}
|Chat relay which requests permission from participants before relaying their messages. Also includes their attachments. (ToS compliant).
|-
|[[Curtain script]]
|{{User|Zilla Larsson}}
|A simple script to retract/stretch curtains, blinds, bedcovers and more
|-
|[[Library_Cycle_Dialog_Items|Cycle Dialog Items w/ Callback]]
|{{User|Hawkster Westmoreland}}
|A customizable way to cycle dialog items with pagination
|-
|[[Dataserver API]]
|{{User|Revolution Perenti}}
|Dataserver Framework for Notecards.
|-
|[[Date Library]]
|{{User|Corto Maltese}}
| Date library, based on number of day since march 3rd 1600, can be used to calculate weekday, date differences, and date offset, and date formating.
|-
|[[Day of the Week]]
|{{User|DoteDote Edison}}
|Function to get day of the week from [[llGetUnixTime]].
|-
|[[Days in Month]]
|{{User|IntLibber Brautigan}}
|Clicking on it returns the number of days in the present month. Useful for scripting calendars and tier systems that need to know the number of days in the month at hand or to calculate for any month. Even adjusts for leap years.
|-
|[[Deed Tools]]
|{{User|Falados Kapuskas}}
|Tools that allow the creator to modify Group-Owned (Deeded) Objects via chat.
|-
|[[User:Daemonika_Nightfire/Scripts/DEMO_Shield|DEMO_Shield]]
|{{User|Daemonika Nightfire}}
|With this script, it is impossible to use these scripts in copied (Copybot) object.
|-
|[[Describe Chatter]]
|Anonymous
|Chat to see yourself as others do.
|-
|[[Dialog Control]]
|{{User|Nargus Asturias}}
| A (not-so) simple dialog & menu control script. Call dialog and receive selected value via [[link_message]], with built-in timer and [[link_message]] notification on time out. Supports multi-pages dialog and numeric property dialog. Button text and dialog's returned value can differ.
Latest version also has [[Dialog Menus Control]] built-in; which allow multi-level menus through SL dialog system.
|-
|[[Dispenser Vendor]]
|[[Wizardry and Steamworks]]
| A twist on [[Vendor]] that dispenses one object and then removes it from the list of objects.
|-
|[[MultiUser_Dialog_Handler|Dialog Menus (multiuser)]]
|{{User|SimonT Quinnell}}
| Menu dialog handler that supports multiple menus open at once from the single script. Displays multi-page menus if necessary as well as allowing for fixed header and footer buttons. Timeouts as well as Text and button size limits are handled.
|-
|[[Dialog NumberPad|Dialog Number Pad]]
|{{User|DoteDote Edison}}
|Use a dialog to accept positive integer input from users.
|-
|[[Display Names Radar]]
|{{User|Cerise Sorbet}}
|Simple HUD type avatar radar that can show [[display names]] and script memory usage
|-
|[[Display Names to Key]]
|{{User|Joran Yoshikawa}}
|Simple way to get UUIDs from displaynames
|-
|[[User:Daemonika_Nightfire/Scripts/DS_Display-Username_Online_Indicator|Display-Username_Online_Indicator]]
|{{User|Daemonika Nightfire}}
|This simple hover text-based script is used to shop owners in Second Life, customers at the current display name and user name to display publicly. Additionally shows the status of the Userkey and online. Furthermore, there are click of a chat link that opens the profile owner.
|-
|[[Displayer Script]]
|{{User|Akinori Kimagawa}}
|Display Words On Top Of An Object
|-
|[[Distributed Primitive Database]]
|[[Wizardry and Steamworks]]
|The distributed primitive database (DPD) is a database which is meant to survive entirely in SL by using redundancy, replication and time synchronisation to maintain the consistency of the dataset contained in the DPD node/primitives spread out between regions and even grids. Similarly to the [[Intercom]], the robustness of the theory would allow users to maintain a cross-grid database; as of 30 of August 2011 I have managed to couple and replicate data between the two grids by using the methodology described in the script article.
|-
|[[Drink script]]
|{{User|Emmas Seetan}}
|Used mainly for food and drink in Second Life.
|-
|[[Donut Dance]]
|[[Wizardry and Steamworks]]
|Err, a script that makes you dance and say something on the local chat once you attach an object (good example for conditional re-entry flipping).
|-
|[[User:Daemonika_Nightfire/Scripts/DS_Single_AO-Sit|Single_AO-Sit]]
|{{User|Daemonika Nightfire}}
|Posescript for use with or without AO and with or without Animation. With the menu it is possible the seated Avatar to move.
|-
|[[TOXDropBox|DropBox]]
|{{User|Dimentox Travanti}}
| This is a Drop box which allows people to drop certain items in a object & has many config options.
|-
|[[Efficiency Tester]]
|{{User|Xaviar Czervik}}
|Tests the speed of a function.
|-
|[[Email-to-IM|Email2IM]]
|{{User|DoteDote Edison}}
|Send IMs to SL friends via [[email]].
|-
|-
|[[User:Kireji_Haiku/SIMchat_headset|Encrypted Region-wide chat]]
|{{User|Kireji Haiku}}
|Encrypted Region-wide chat
|-
|[[ExplodingObjects]]
|{{User|Dale Innis}}
|Causes an object (of the appropriate type) to explode on command.
|-
|[[FadeEasy]]
|{{User2|Nika Rugani}}
|The easy way of fading objects in or out (Using llSetLinkAlpha)
|-
|[[FastConeSpread]]
|{{User|Nexii Malthus}}
| Fast Algorithmn to achieve cone spread, main use in weaponry systems.
|-
|[[User:PixelProphet Lane/Scripts#Fast List Prim Contents|Fast List Prim Contents]]
|{{User|PixelProphet Lane}}
|Fast and efficient method to print Object Inventory (Name, Type and next Owner permissions)
|-
|[[User:PixelProphet_Lane/Scripts#Grid_Status_Feed|Grid Status Feed]]
|{{User|PixelProphet Lane}}
|Receive important Grid information in-world
|-
|[[Find Avatar Key|Find Avatar Key]]
|{{User2|Huney Jewell}}
|Explores [[UUID]] of avatar whose name is said in local chat or who touches the prim.
|-
|[[First Name Letter Prize]]
|{{User|RaithSphere Whybrow}}
|Gives a prize if the person who sits on it's first letter of first name matches the random letter!
|-
|[[Fix Small Prims|Fix_Small_Prims]]
|{{User|Emma Nowhere}}
|Finds and adjusts the smallest prims in a linkset so that it can be scaled down further.
|-
|[[Flight Assist]]
|[[Wizardry and Steamworks]]
|Flight feather / flight band implementation supporting various commands and allowing you to fly above the clouds.
|-
|[[Float2Hex]]
|{{User|Strife Onizuka}}
|Very useful for transporting [[float|floats]].
|-
|[[Float Box Contents]]
|{{User|Rolig Loon}}
|Displays object inventory in hover text, identified by type and updated marquee-style.
|-
|[[Follower (script)|Follower]]
|Unknown, uploaded by {{User|Slik Swindlehurst}}
|Makes an object follow the nearest person. Do not use for [[grief|griefing]].
|-
|[[FURWARE_text]]
|{{User|Ochi Wolfe}}
|Versatile text-on-prim script, open source under the MIT license
|-
|[[GA Event Notifier]]
|{{User|Victor Hua}}
|Gathers seven days event data from a Google calendar and display it through a simple interface. The lsl script can access several calendars at once through seperate php files. One file per calendar. Host the included php on your own web server.
|-
|[[Geometric|Geometric Library]]
|Community Project
|A substantial amount of various geometric functions for intersection and other purposes of 3D maths.
|-
|[[Get Profile Picture]]
|{{User2|Valentine Foxdale}}
|Sets the texture of the object to profile picture of the person that touches ot
|-
|[[GetTimestampOffset]]
|[[User:Siann_Beck|Siann Beck]]
|Returns [[llGetTimestamp]] with an hour offset.
|-
|[[Give InvItem every n hours]]
|{{User|Criz Collins}}
|Will give an inventory item on touch only every n hours, even if somebody touches the object more than once.
|-
|[[Give random object]]
|{{User|Emmas Seetan}}
|Touch to receive a random object in the prim's inventory
|-
|[[Giver]]
|[[Wizardry and Steamworks]]
|A menu-driven script that will hand out the objects in a prim. Supports multiple pages.
|-
|[[User:Yumi Murakami/Golden Vendor|Golden Vendor]]
|{{User|Yumi Murakami}}
|A cross between a vendor and a game.
|-
|[[Google Charts]]
|{{User|Dedric Mauriac}}
|Create links to display raw data as a chart image.
|-
|[[Google_Translator]]
|{{User|Ugleh Ulrik}}
|Translates spanish to english, and its simple to make it any other way.
|-
|[[Go transparent when walking]]
|{{User|Emmas Seetan}}
|An attachment that goes invisible when you walk and visible when you don't walk.
|-
|[[Great Wanderer]]
|[[Wizardry and Steamworks]]
|A movement system based on [[Wizardry and Steamworks|State Machines]] which provides free roaming.
|-
|[[Greeter]]
|[[Wizardry and Steamworks]]
|A multi-purpose greeter with multiple options (IM, landmark, notecard, URL, visitor statistics, shared access and compatible with the [[Mail]] system) that could work for shops, clubs, galleries and any other public place.
|-
|[[Group Authorization]]
|{{User|Chase Quinnell}}
|Checks to see if object is set to appropriate group (checks by [[Group key finder|group key]])
|-
|[[Group key finder]]
|{{User|Emmas Seetan}}
|Touch to find the key of the group
|-
|[[Group Privacy]]
|{{User|Chance Unknown}}
|Security device to insure members of a group can have a private area. Deactivates when nobody present.
|-
|[[Hello Avatar]]
|Linden Lab
|SL's default script.
|-
|[[Hello Avatar Companion]]
|[[Chase Quinnell]]
|Companion to the original [[Hello Avatar]] script
|-
|[[Hierarchics]]
|{{User|Nexii Malthus}}
| Advanced script to create an efficient self-aware hierarchic structure.
|-
|[[Hierarchics2]]
|{{User|Nexii Malthus}}
| Second generation, one script per object. Only two functions, can be embedded in others. Uses the new [[llSetLinkPrimitiveParamsFast]]/[[llGetLinkPrimitiveParams]] functions.
|-
|[[User:Rolig_Loon/High-Capacity_Greeter-Counter|High-Capacity Greeter-Counter]]
|{{User|Rolig Loon}}
|Uses a memory compression algorithm to store hashed visitor UUID's in a string instead of using a list.
|-
|[[Holodeck]]
|{{User|Revolution Perenti}}
|Home Rezzing System.
|-
|[[HUD Dots Radar]]
|[[User:Cerise Sorbet|Cerise]]
|HUD target example, draws dots on the HUD over avatars in view.
|-
|[[I Got It]]
|[[Wizardry and Steamworks]]
|Educational tool to provide feedback from students.
|-
|[[Intercom|Intercom]]
|[[Wizardry and Steamworks]]
|A system allowing region-wide and grid-wide (as of 30 of August 2011, it also works grid-wide, a test was performed by linking up the chat between the OSGrid and SecondLife) mass chat relay. By using this you can relay a main chat across multiple regions or grids. The script was initially meant as a mid-way project in order to test and gather information for the [[Distributed Primitive Database]].
|-
|[[Interpolation|Interpolation Library]]
|{{User|Nexii Malthus}}
|A small set of interpolation functions.
|-
|[[Intra-Region Update Server]]
|[[User:Emma_Nowhere|Emma Nowhere]]
|Centrally update objects such as Freeview screens or teleport pads within a region that are configured by notecards or contain modifiable objects or media assets.
|-
|[[Inventory_Based_Menu]]
|{{User|Revolution Perenti}}
|Inventory Based Menu System.
|-
|[[iTunes RPC Email|iTunes RPC]]
|{{User|Fox Diller}}
|iTunes RPC via LSL [[llEmail]] and [[llRemoteDataReply]].
|-
|[[Jingle]]
|[[Wizardry and Steamworks]]
|A script that will make a primitive emit a sound when you wear it and walk around. Ideal for bells, footsteps and so on...
|-
|[[Key Frame Animator|Keyframe Animator]]
|{{User|Jasper Flossberg}}
| This is a KeyFrame Animator Script to simplify construction of keyframed animations.
|-
|[[Key Pad Door|Keypad Door]]
|{{User|Tdub Dowler}}
| Door and keypad with changeable code. Follow instructions carefully!
|-
|[[Key2Name]]
|{{User2|Nika Rugani}}
| Key2Name service where a user no longer needs to be in the same region to get users name
|-
|[[Kilt Editor|Kilt / Skirt Editor]]
|{{User|Brangus Weir}}
| This changes all the parameters of all the flexis in the link set in one swell foop!
|-
|[[Kira Warp Core Drive]]
|[[Wizardry and Steamworks]]
|Scripts and instructions on how to create a vehicle that teleports an avatar and a vehicle to any region on the grid. You can [http://www.youtube.com/watch?v=xQkBRD7HBvw watch the YouTube video showing the prototype] I created to demonstrate how it works.
|-
|[[Last Sound System]]
|Babbage Linden
|An LSL [http://Last.fm Last.fm] client.
|-
|[[LibObj]]
|{{User|Ochi Wolfe}}
|A library to manage state in LSL using an object-oriented approach.
|-
|[[LibraryDisplayLandScreenshot]]
|{{User|Jon Desmoulins}}
|A modified version of LibraryDisplayProfilePic using the new [[PARCEL_DETAILS_ID]] Implemented in Server v1.36
|-
|[[User:Daemonika_Nightfire/Scripts/LinkNumber-List_in_llSetLinkPrimitiveParamsFast|LinkNumber-List_in_llSetLinkPrimitiveParamsFast]]
|{{User|Daemonika Nightfire}}
|Changed several prims in linkset with the same parameters, with a list. Without separate llSetLinkPrimitiveParams for each prim. (ideal for show/hide effects)
|-
|[[Limit Vendor]]
|[[Wizardry and Steamworks]]
|This is a vendor supporting any number of items with different prices which will only dispense a certain number of individual items by setting limits for each item based on a notecard configuration.
|-
|[[Linkset resizer]]
|Maestro Linden
|Systematically rescales a linkset by moving and resizing each prim (by using [[llGetLinkPrimitiveParams]] and [[llSetLinkPrimitiveParamsFast]])
|-
|[[Linkset resizer with menu]]
|{{User|Brilliant Scientist}}
|A menu-driven script that rescales a linkset by moving and resizing the prims using [[llGetLinkPrimitiveParams]] and [[llSetLinkPrimitiveParamsFast]] functions. Based on [[Linkset resizer]].
|-
|[[User:Daemonika_Nightfire/Scripts/*DS*_Resize_Script|Resize Script (m/c/t) v2.0.01]]
|{{User|Daemonika Nightfire}}
|Single resize script for a complete linkset with save and restore option.
|-
|[[Pointing Stick]]
|{{User|rhonin Nissondorf}}
|A device that takes controls of your arrow keys and directs the device in the relative direction its pointing, forward and back of course.
|-
|[[Gun Script]]
|[[User:rhonin Nissondorf| rhonin Nissondorf]]
|Shoots out "ammo" from the root prim of your "gun".
|-
|[[Grenade Script]]
|[[User:rhonin Nissondorf| rhonin Nissondorf]]
|Uses a timed factor to add influence to the velocity of a throw object.
|-
|[[Linkset Resizer 2]]
|{{User|Emma Nowhere}}
|A more user-friendly resizer script designed for either drop-in use by the end-user or builder or for use in products. Based on [[Fix Small Prims]].
|-
|[[List2CSV]]
|{{User|Kunnis Basiat}}
|Similar to [[llList2CSV]] & [[llCSV2List]] which includes preserving type and escaping characters.
|-
|[[list_cast]]
|{{User2|Fractured Crystal}}
|Casts a list of strings into the type they appear to be. Designed for preprocessing user input for feeding into [[llSetPrimitiveParams]]
|-
|[[Listener Script]]
|{{User|Emmas Seetan}}
|Use to [[listen]] to other people's conversations (Like spying)
|-
|[[User:Void_Singer/Functions#List:_Find_Last_Index|List: Find Last Index]]
|{{User|Void Singer}}
|Returns the last index of searched item in a source list. (backwards version of [[llListFindList]])
|-
|[[User:Void_Singer/Functions#List:_Multi-Find_Index_.28First_or_Last.29|List: Multi Find]]
|{{User|Void Singer}}
|Returns the first found index of multiple search items in a list. (Multi-item version of [[llListFindList]]. Fwd and Rev versions included)
|-
|[[User:Void_Singer/Functions#List:_Get_Reverse_Order|List: Reverse]]
|{{User|Void Singer}}
|Returns an input List in reverse order
|-
|[[LinksetIndexing]]
|{{User|Nexii Malthus}}
|Functions for indexing a linkset by patterns or names down to their linkset numbers.
|-
|[[llGetAgentList Sim-Wide Radar]]
|{{User|Tiaeld Tolsen}}
|Simple radar implementation using the new [[llGetAgentList]] LSL Function.
|-
|[[Live Event Timeout]]
|[[Wizardry and Steamworks]]
|A script which will set the the music URL back to a radio station of your liking when a DJ leaves or forgets to switch back the URL after a live event. It takes multiple DJs, using a notecard and several configuration parameters.
|-
|[[LOGO Turtle]]
|[[Wizardry and Steamworks]]
|A script that interprets basic LOGO commands, extending the directions to 3D.
|-
|[[User:Kephra_Nurmi/lsDancemachine|lsDancemachine]]
|[[User:Kephra_Nurmi|Kephra Nurmi]]
| Low lag client server dancemachine.
|-
|[[User:Kephra_Nurmi/lsDeejay|lsDeejay Home Edition]]
|[[User:Kephra_Nurmi|Kephra Nurmi]]
| Client server media control for music, video, youtube, pictures, and texture animations.
|-
|[[User:Kephra_Nurmi/lsDialog|lsDialog]]
|[[User:Kephra_Nurmi|Kephra Nurmi]]
| Universal notecard driven menu dialog system.
|-
|[[User:Kephra_Nurmi/lsDisplay|lsDisplay]]
|[[User:Kephra_Nurmi|Kephra Nurmi]]
| Picture cycler with preloader.
|-
|[[User:Kephra_Nurmi/lsDistributor|lsDistributor]]
|[[User:Kephra_Nurmi|Kephra Nurmi]]
| Simple 'try' and 'buy' vendor system.
|-
|[[Wizardry_and_Steamworks/LSL|LSL FUSS]]
|[[Wizardry and Steamworks]]
|FUSS (Frequently Used Short Snippets) is an collection of short snippets provided by [[Wizardry and Steamworks]]. They range from functions to one-liners and are provided for LSL developers.
|-
|[[LSL_languageAPI]]
|{{User|Gypsy Paz}}
|Multi-lingual API from notecard based language files
|-
|[[Mail]]
|[[Wizardry and Steamworks]]
|An system for sending objects to multiple recipients automatically supporting shared access and [[Greeter]] compatible auto-subscriptions.
|-
|[[Mandelbrot Explorer]]
|Babbage Linden
|An interactive fractal explorer.
|-
|[[Materialization Effects]]
|{{User|Overbrain Unplugged}}
| Special effects to add to rezzing events to simulate a teleportation or materialization.
|-
|[[Materialization Effects 2]]
|{{User2|Nika Rugani}}
| More efficient and faster version of Materialization Effects by Overbrain Unplugged.
|-
|[[Memory Module]]
|[[Wizardry and Steamworks]]
|An example of pseudo-persistent variable in-world storage.
|-
|[[Merge Sort]]
|{{User|Xaviar Czervik}}
|Implements a Merge Sort in LSL, however this code is 300(ish) times slower than [[llListSort]]. Don't use this in a script!
|-
|[[Minesweeper]]
|{{User|Xaviar Czervik}}
|A simple minesweeper game.
|-
|[[Mood Color Changer]]
|[[Wizardry and Steamworks]]
|A script that changes the color of all primitives in a linkset depending on the smileys the owner types on the main chat.
|-
|[[Morse Code]]
|{{User|Bobbyb30 Swashbuckler}}
|A script that allows for the conversion to and from morse code and can "play" morse code.
|-
|[[Multi-displays Texture Cycler]]
|{{User|Nargus Asturias}}
|A simple texture rotator designed for multiple display screens. With delay between each screen AND delay between each loop.
|-
|[[Multi Item Rezzer|Multi Item Rezzer]]
|{{User|Jesse Barnett}}
|A rework of my old High Altitude Rezzer. Place the objects that you wish to choose from to be rezzed inside. Sit on the rezzer and pick the item and the height. It will go to target height and rez the object.
|-
|[[Multirezzer|Multirezzer (on collision)]]
|{{User2|Beet Streeter}}
|Spawns up to 10 objects when the object containing the script collides with a user.
|-
|[[User:Allen_Kerensky/Myriad_Lite_Preview_5|Myriad Lite Preview 5 RPG System]]
|[[User:Allen_Kerensky|Allen Kerensky]]
|Working preview of the Myriad Universal RPG System by Ashok Desai, converted to LSL as a roleplay meter with quest NPC and goals, hand-to-hand and melee close combat, ranged combat, armor, healing, bullet, firearm, holster, practice target, and much more
|-
|[[N2K]]
|[[Wizardry and Steamworks]]
|A Name To Key (Name2Key) implementation that does not use third-party databases, nor relies on the uptime of not well known websites but rather uses the World Wide Web Consortium to fetch the key of avatars while trying to alert the developers of the consequences of using Name2Key third-party providers as well as trying to refrain from sales pitch terminology such as "best", "newest" and "fastest".
|-
|[[Name2Key in LSL]]
|{{User|Maeva Anatine}}
|Get the Name2Key feature inside your scripts. Works even on lastly subscribed avatars.
|-
|[[Name2Key]]
|{{User2|Nika Rugani}}
|Newest and fastest Name2Key search, While the database is small it is also connected to Second Life's search.
|-
|[[NexiiText]]
|{{User|Nexii Malthus}}
| Text Renderer, specialised in features, performance and a compact nature. It features unique per character control, such as Colour, Bold, Italics, Underline, Stroke, Icons. The high performance means it comes in at a 5 char / prim ratio, but it is perfect where highly dynamic and rich text is required.
|-
|[[NexiiText2]]
|{{User|Nexii Malthus}}
| Second Gen Text Renderer. Same as above but features use of [[PRIM_LINK_TARGET]] and an awesome dynamic prim allocation architecture.
|-
|[[No Auto-Return]]
|{{User|Bellla Clarity}}
|To stop your long and hard builds from getting returned in sandboxes (''only single prims, though!'').
|-
|[[No Auto-Return NR]]
|{{User|Jor3l Boa}}
|This really works (29-05-09), needs a nearby region to do the trick and avoid auto return. (Tested on Blue and Rausch)
|-
|[[No Auto-Return (Multi)]]
|{{User|Xaviar Czervik}}
|A revision of Bella's that works for multi-prim objects.
|-
|[[No Limit Teleporter]]
|{{User|Morgam Biedermann}}
|Teleport to infinite altitudes (up to 4096m)
|-
|[[Object Size]]
|{{User|Chase Quinnell}}
|Gets the dimensions and footprint of a linkset
|-
|[[Object to Data v1.4|Object to Data]]
|{{User|Xaviar Czervik}}
|Turns an object into text (and back). Allows people to transfer objects through notecards (or otherwise).
|-
|[[Online Indicator|Online Indicator]]
|{{User|Kristy Fanshaw}}
|Will show if the user is online or not. Displays users profile picture and allows to send IM's to user. Also gives a link to open the users profile
|-
|[[Open Group Join]]
|{{User|Alicia Stella}}
|User Touches Object to Join Group from Group Info window, (no bot.)
|-
|[[Open Prim Animator]]
|{{User|Todd Borst}}
|Single script prim animation tool. Menu driven, easy to use.
|-
|[[Open Zyngo Skin Installer]]
|{{User2|Tmzasz Luminos}}
|A Simple Script designed to install skins on the popular Skill machines.
|-
|[[Orbitor]]
|[[Wizardry and Steamworks]]
|Based on [[Wanderer]], we create [[Orbitor]] which allows a primitive to orbit around an origin point.
|-
|[[One Script, many doors]]
|{{User|Kyrah Abattoir}}
|Door script able to manage more than 50 linked doors from a single script instance.
|-
|[[ParseString2List]]
|{{User|Strife Onizuka}}
|Same as [[llParseString2List]] and [[llParseStringKeepNulls]], but not limited to 8 spacers or separators. Thus substitute a call to the [[llParseString2List]] and [[llParseStringKeepNulls]] functions by a call to [[Parse_String_To_List|ParseString2List]] whenever you have more than 8 separators or more than 8 spacers.
|-
|[[Password Generator]]
|{{User2|Syntrax Canucci}}
|This is an over-complicated, semi-complex password generator, which goes through multiple steps.
|-
|[[Pathfinder]]
|Babbage Linden
|A potential field based pathfinding library.
|-
|[[Pay to Strip]]
|[[Wizardry and Steamworks]]
|This script is mainly meant for dancers and uses RLV to allow people to strip an avatar by making every clothes and attachment piece removable, respectively detachable for a settable price.
|-
|[[Permanent Primitive URL]]
|[[Wizardry and Steamworks]]
|A script that uses [http://tiny.cc http://tiny.cc] REST API to update a SIM URL and make it permanent. Full description on how to register and set up a "nice" URL, like: http://tiny.cc/Kira. Should work with most URL shortening services (I'm not affiliated with tiny.cc except for having a pass at them for not allowing OpenSIM-style generated URLs).
|-
|[[Personal ATM Machine]]
|{{User|Jessikiti Nikitin}}
|Allows deposits and withdrawals into another of your accounts, without the account being logged in.
|-
|[[Phantom Child]]
|{{User|Aeron Kohime}}
|Causes a child in a link set to become phantom without the entire object becoming phantom.
|-
|[[PHP_RegionFunctions]]
|{{User|Gypsy Paz}} and {{User2|Zayne Exonar}}
|Three useful PHP functions to get region info
|-
|[[PhysicsLib]]
|{{User|Nexii Malthus}}
| Interesting set of fun physics functions.
|-
|[[Planar Tile Generator]]
|[[Wizardry and Steamworks]]
|A script to generate perfectly aligned tiles.
|-
|[[Play and Loop Sound]]
|{{User|Bellla Clarity}}
|Very short and simple script; plays and loops a sound in an object.
|-
|[[Posing stand|Posing Stand]]
|{{User|Bellla Clarity}}
|Just a pose script to edit [[attachments]] more easily.
|-
|[[PosJump]]
|{{User|Uchi Desmoulins}}
|A much more efficient alternative to the popular [[warpPos]] function for bypassing 10m distance-moved limitations.
|-
|[[Puppeteer]]
|[[Wizardry and Steamworks]]
|A simple puppeteer script that will allow you to record and animate prim movements and rotations.
|-
|[[Primitive Name Changer]]
|[[Wizardry and Steamworks]]
| A script that changes the primitive's name based on an user-configurable interval and a notecard list containing possible names.
|-
|[[Prefix Calculator]]
|{{User|Xaviar Czervik}}
| A calculator that evaluates expressions in prefix notation.
<code>+ 3 4 = 5. * + 1 2 + 3 4 = 14.</code>
|-
|[[Profile Generator]]
|[[Wizardry and Steamworks]]
|A cynical script for generating boilerplate profiles by based on cliches and profile memes.
|-
|[[Profile Picture]]
|[[User: Jor3l Boa|Jor3l Boa]]
|A working profile picture script with the new SecondLife API (1/11/2011)
|-
|[[Progress Bar]]
|{{User|Nexii Malthus}}
| Flexible and powerful little function for creating progress bars useful in hovertext.
|-
|[[Pseudo-random Number Generator]]
|{{User|Xaviar Czervik}}
|Generates a Pseudo-random number between -0x7FFFFFFF and 0x7FFFFFFF
|-
|[[Quick Collar]]
|[[Wizardry and Steamworks]]
|A simple, no-bulk, no external database and essential feature-packed RLV collar script for your pleasures.
|-
|[[Quicksort]]
|[[Wizardry and Steamworks]]
|LSL implementation of the Quicksort algorithm.
|-
|[[User:Rolig_Loon/Quiz_From_Notecard|Quiz From Notecard]]
|{{User|Rolig Loon}}
|A multiple-choice testing script that reads questions and answer choices from a notecard and presents them in dialog boxes.
|-
|[[Racter]]
|[[Wizardry and Steamworks]]
|In-world, multi-purpose chatterbot (Eliza/A.L.I.C.E. inspired) supporting multiple configurable hot-swappable brain-files with a wide range of applications.
|-
|[[Rainbow_palette]]
|{{User|Rui Clary}}
|Build a color picker, using only one prim, and a few lines of code.
|-
|[[Random Gaussian Number Generator]]
|{{User2|Vlad Davidson}}
|Generates a random number drawn from a normal (Gaussian; bell-curve) distribution, based on a specified mean/stdev
|-
|[[Random AV Profile Projector]]
|{{User|Debbie Trilling}}
|Randomly selects an AV from a crowd & then projects their profile picture as a 'holographic' image
|-
|[[Random Object Vendor]]
|{{User|CodeBastard Redgrave}}
|Simple vendor that gives out random objects when paid the right amount
|-
|[[Random Password Generator]]
|{{User|Jor3l Boa}}
|Generate Random passwords based on String Length.
|-
|[[RandomPrimParams]]
|{{User|Xintar Citron}}
|Simple script which randoms Prim Parameteres, in this example i used color, but you can use everything.
|-
|[[RavText]]
|{{User|Ravenous Dingo}}
|An alternate to XyText. This is a lightweight, multiple font 10 character text display system. It only supports uppercase alphanumeric text and a few special characters, but it is very fast, renders quickly and supports multiple fonts. It is meant for specialized use when all that is desired is basic, fast text display and the extra "bells and whistles" are not needed.
|-
|[[User:PixelProphet Lane/Scripts#Real Object Inventory To Dialog|Real Object Inventory To Dialog]]
|{{User|PixelProphet Lane}}
|Display any amount of items contained in an Object in a Dialog, regardless of item name length.
|-
|[[RentalBoxv1|Rental Box, Simply]]
|{{User2|Sendao Goodman}}
|Simple explanation of how to make rental boxes.
|-
|[[Rental Cube]]
|{{User|Hank Ramos}}
|Simple cube for renting out a space.
|-
|[[User:Daemonika_Nightfire/Scripts/*DS*_Rental-Cube|Rental-Cube]]
|{{User|Daemonika Nightfire}}
|This is an Open-Source version of a Rental-Cube from Daemonika Nightfire. Just copy/paste this script into a inworld lsl-script and add one notecard called Info/Rules to the content of your cube.
|-
|[[User:Ackley Bing/Textbox2Hovertext|Textbox2Hovertext]]
|[[User:Ackley Bing|Ackley]]
|A simple script to allow hovertext to be set with a dialog text box.
|-
|[[Remote Texture Loader]]
|{{User|Bobbyb30 Swashbuckler}}
|A set of scripts for remotely loading textures within a sim. This means that a single "texture server" can manage multiple changing billboards within a sim.
|-
|[[Say Region Frames Per Second|Region Frames Per Second]]
|{{User2|Heymeriou Mystakidou}}
| Says the region name and frames per second out loud on command.
|-
|[[Security Orb|Security Orb]]
|[[Wizardry and Steamworks]]
|A regular security orb that ejects people from a land parcel supporting a menu configuration and a notecard based access list.
|-
|[[Resizer multi-prims|Resizer multi-prims]]
|{{User2|Christy Mansbridge}}
|1 Mono script to resize object (1 to 256 prims) by blue menu. Avoid risk to break the build by increasing link distance.
|-
|[[RLV Collision Grabber]]
|[[User:Vala_Vella|Vala Vella]]
|Grab people colliding with the object and sit them on a set target using RLV
|-
|[[sbDialog]]
|[[User:Siann_Beck|Siann Beck]]
|A simple replacement function for [[llDialog]]. It re-orders the button list so that the button values, as passed to it, display left-to-right, top-to-bottom. It also opens a [[llListen|listen]] on the specified channel, and returns the handle.
|-
|[[Scheduled Payments]]
|[[Wizardry and Steamworks]]
|A script that will allow you to make scheduled (and reoccurring) payments to multiple avatars via a notecard.
|-
|[[Scheduler]]
|{{User|Haravikk Mistral}}
|Schedule multiple events using a single script timer
|-
|[[Scheme_Interpreter|Scheme Interpreter]]
|{{User|Xaviar Czervik}}
|A scheme interpreter capable of handling most scheme expressions, including lambda and lists.
|-
|[[Script Override Functions]]
|{{User|Revolution Perenti}}
|bypass default strings, integer etc in chat channel.
|-
|[[User:Toady_Nakamura/Scrubber_Script|Script Scrubber]]
|{{User|Toady Nakamura}}
|Script scrubs memory resident script functions from prim and self-deletes the script. Does not damage the prim, or remove other scripts. Use this to kill bling or other particle effects!
|-
|[[Scripted Attachment Detector.lsl|Scripted Attachment Detector]]
|{{User|Bobbyb30 Swashbuckler}}
|A script that will display avatars wearing scripted attatchments in hovertext. This may be worn as an hud or rezzed.
|-
|[[Self Upgrading Script Enhanced]]
|{{User|Cron Stardust}}
|Keeps only latest version of the script on prim (even with multiple adds of the same script!)
|-
|[[Sensor Visualizer]]
|{{User|Cerise Sorbet}}
|Shows the size and shape you get with [[llSensor]] range and arc parameters
|-
|[[Serverless Key Exchange]]
|{{User2|Sendao Goodman}}
|Maintains a network of object keys without using an external server.
|-
|[[SetLinkText]]
|{{User2|Tacusin Memo}}
|Custom function like [[llSetText]] only applying to linked sets.
|-
|[[SHA-1|SHA-1 Hash]]
|{{User|Strife Onizuka}}
|Performs a SHA-1 Hash on an input text. Similar to MD5 only (slightly) more secure.
|-
|[[SHA-2|SHA-2 Hash]]
|{{User|Strife Onizuka}}
|Performs a SHA-2 Hash on an input text. Similar to SHA-1 only (slightly) more secure.
|-
|[[Shoutcast - radio controller v0.3 (remake of similar scripts)]]
|{{User|Flennan Roffo}}
|Control your shoutcast radio stations with this shoutcast controller. Uses notecard for info about genres and stations and menu to select the station. Sends info to Xytext display.
|-
|[[User:PixelProphet Lane/Scripts#Show Agent Script Count and memory|Show Agent Script Count and memory]]
|{{User|PixelProphet Lane}}
|Fast and efficient method to display the amount of scripts and memory usage for an agent
|-
|[[Sim Map Particle Projector]]
|{{User|Jesse Barnett}}
|Displays a floating map of the sim the script is in.
|-
|[[Sim Performance Collector (Web-based]]
|{{User2|DeniseHoorn Slade}}
|Makes some graphs for your website on the sim-performance (DIL,FPS, PING). PHP and Round Robin Database on Server needed!
|-
|[[Sim Restart Logger]]
|{{User|Kyrah Abattoir}}
|Counts region restarts and displays log of last 9 restarts together with region FPS and dilation.
|-
|[[SIM status]]
|[[Wizardry and Steamworks]]
|A script that will scan and display the status of SIMs (up, down, starting, stopping, unknown, crashed) from a notecard in the same prim as the script.
|-
|[[Simple Elevator in a Box]]
|{{User|Hank Ramos}}
|Simple elevator example.
|-
|[[Simple Pay Door]]
|{{User|Giygas Static}}
|Simple door you pay to get access.
|-
|[[Skillingo AntiHack Script]]
|{{User2|Tmzasz Luminos}}
|A simple Protection script for skillingo thats modifyable to work with other machines.
|-
|[[Skunk Money]]
|{{User|Hank Ramos}}
|Fun gambling machine of yesteryear, which only supports freeplay now due to SL regulations against gambling.
|-
|[[SLateIt]]
|Babbage Linden
|An augmented virtual reality HUD.
|-
|[[SLetanque]]
|Babbage Linden
|An LSL petanque game.
|-
|[[SLURL HUD]]
|{{User|CodeBastard Redgrave}}
|Touch this HUD to get a SLURL through IM, email and floating text.
|-
|[[BuildSlurl (NewAge)]]
|{{User2|Archile Azalee}}
|A way to create a SLurl in a single function BuildSlurl
|-
|[[SL Mail V1.2]]
|{{User|Flennan Roffo}}
|Second Life mail client V1.2 (released sept'07). Send and receive mail from within Second Life from and to any address. With Address Book function and many chat commands. V1.3 is upcoming soon!
|-
|[[SL_NTPoHTTP_v1.1_client|SL NTPoHTTP client]]
|{{User|SignpostMarv Martin}}
|Second Life Needs Time Parsing over Hyper Text Transfer Protocol
Emulates the function of [[llGetWallclock]] for any timezone by using SLOpenID's SLNTPoHTTP service. Also supports ISO 8601 and RFC 2822 timestamps. Script is dependent upon an external service operated by the author!
|-
|[[Slide Display]]
|[[Wizardry and Steamworks]]
|A display for presentations or talks supporting multiple slides as well as zooming-in on the slides.
|-
|[[Smile]]
|[[Wizardry and Steamworks]]
|An extended smile script supporting two smiles (extendable via a list) and a time delay triggering them at random.
|-
|[[Smooth Rotating Door]]
|{{User|Toy Wylie}}
|A script for doors that open and close smoothly using llTargetOmega
|-
|[[Smooth Rotating Linked Door With Hinge]]
|{{User2|Lyn Mimistrobell}}
|A script for linked uncut (mesh) doors that smoothly rotates around a virtual hinge without the use of timers
|-
|[[Smooth Sliding Door]]
|{{User|SimonT Quinnell}}
|A script for sliding doors that open and close smoothly using [[llMoveToTarget]]. Asjusts for prim orientation.
|-
|[[Snake Game]]
|[[Wizardry and Steamworks]]
|The game of snake in Second Life.
|-
|[[Song Requests]]
|[[Wizardry and Steamworks]]
|Helper script for DJs, allowing listeners to request songs and make dedications.
|-
||[[Sound Preloader]]
|[[User:Trinity Dejavu|Trinity Dejavu]]
||A tripwire that preloads a selection of sound files when avatar collides with prim.
|-
|[[Speed Tester]]
|{{User|Bobbyb30 Swashbuckler}}
|Similar to the [[Efficiency Tester]], this script allows you to test the speed of a particular function or snippet with multiple trials giving min/max/avg/median and the standard deviation.
|-
|[[Spiral Staircase Generator]]
|{{User|Meyermagic Salome}}
|Generates nice looking spiral staircases without much hassle.
|-
|[[Static URL's for HTTP-In Service|Static_URLs]]
|{{User|Jor3l Boa}}
|How to generate a static url for HTTP-In temporal limitations.
|-
|[[String Compare]]
|{{User|Xaviar Czervik}}
|Compares two strings and reliably returns either 1, -1, or 0 if they are the same.
|-
|[[Synchronize]]
|{{User|Cay Trudeau}}
|Makes synchronized start to a task on even/odd seconds
|-
|[[User:Void_Singer/Functions#String:_Find_Last_Index|String: Reverse]]
|{{User|Void Singer}}
|Returns an input string in reverse order
|-
|[[User:Void_Singer/Functions#String:_Get_Reverse_Order|String: Last Index]]
|{{User|Void Singer}}
|Returns the last index of search found in string (the backward equivalent of [[llSubStringIndex]])
|-
|[[Tail Messages (NewAge)]]
|{{User|Asia Snowfall}}
|A super nice easy to use script for those non-scripters out there! NewAge coding has done it again where you no longer need to scroll up and down adding buttons and adding messages, Features a tag system (you'll see what i mean :P)
|-
|[[Taper Door (minimalistic)]]
|{{User2|Kopilo Hallard}}
|A basic script for doors which open and close using taper.
|-
|[[Teleport HUD]]
|{{User|Jesse Barnett}}
|WORKS TO 4096 METERS!! Very user friendly teleport HUD. Add destinations by touching "Add" & naming destination in chat. Automatically gets sim name and coordinates. Will only display the destinations in the sim you are currently in. Demonstrates more advanced list manipulation and stride functions.
|-
|[[User:Void_Singer/Programs#v7-D_Enh._Landmark-2-Map|Teleporter (landmark based)]]
|{{User|Void Singer}}
|Uses Landmarks to offer map teleports. Works as Hud or inworld objects, just drop in landmarks and go.
|-
|[[Text_Scroller|Text Scroller]]
|[[User:Fred_Gandt|Fred Gandt]]
|A simple text display object that scrolls text (applied as a texture) from right to left (like ''those'' LED signs) in a continuous loop.
|-
|[[Bobbyb's texture changer|Texture Changers]]
|{{User|Bobbyb30 Swashbuckler}}
|A collection of texture changing scripts.
|-
|[[Texture Menu Management|Texture Management]]
|{{User|Revolution Perenti}}
|Dialog Menu based Texture Selection.
|-
|[[Texture Particle Poofer|Texture Particle Poofer]]
|[[Wizardry and Steamworks]]
|This is a generic dialog-based particle poofer, emitting textures towards an avatar for a configurable amount of time.
|-
|[[User:Xen_Lisle/Texture_Slide|Texture Slide]]
|{{User|Xen Lisle}}
|Slides a texture on mouse movement
|-
|[[Tic Tac Toe]]
|CG Linden
|Step by step demo on how to implement a larger scripting project
|-
|[[TightList]]
|{{User|Strife Onizuka}}
|Tight List is a family of functions for encoding lists as strings and then decoding them back into lists.
There are two flavors: TightList and TightListType. TightListType preserves types and uses a 6 char header, while TightList uses a 1 char header that doesn't preserve type.
|-
|[[Timer Module]]
|{{User|Isabelle Aquitaine}}
|Manage multiple timers via linked messages.
|-
|[[Two Avatars on single prim]]
|{{User2|Pale Janus|Cay Trudeau}}
|Allow two (or more) avatars to sit on same prim
|-
|[[User:Void_Singer/Functions#Unix_time_code_to_list_format|Timestamp:<br>Unix time code to list format]]
|{{User|Void Singer}}
|converts Unix timestamps to their [Y, M, D, h, m, s] equivalents (ex: 1234567890 to [2009, 2, 13, 3, 31, 30])
|-
|[[User:Void_Singer/Functions#List_format_to_Unix_time_code.|Timestamp:<br>List format to Unix time code]]
|{{User|Void Singer}}
|converts [Y, M, D, h, m, s] timestamps to their Unix equivalents (ex: [2009, 2, 13, 3, 31, 30] to 1234567890)
|-
|[[User:Void_Singer/Functions#Weekday_from_Unix_timestamp|Timestamp:<br>Weekday from Unix timestamp]]
|{{User|Void Singer}}
|Gets weekday from Unix timestamps (ex: "Friday" from 1234567890)
|-
|[[Texture Repeater]]
|{{User2|Jenna Felton}}
|Observes textures and texture parameters on the prim. If changed, bulk-updates other prims in linkset.
|-
|[[The Stash (Bank)]]
|[[Wizardry and Steamworks]]
|This is a depositing system to link your secondary account (alt) to a prim in-world so you can retrieve money without switching back and forth between accounts. It supports setting an upper limit, sharing the stash if you wish, logging everybody who deposited money and retrieved money, sending money to a list of bookmarked avatars and getting a status of your current holdings. It also explains some tricks for developers, for example, how to get another timer() if your current timer() is used up already.
|-
|[[Tipjar]]
|[[Wizardry and Steamworks]]
|This is a fully fledged tipjar supporting shared access, split profits, inviting to group, handing over gifts, maintaining statistics of who tipped most and who tipped in general, eliminating deed to group and comes with an innovative feature: it periodically moves around from avatar to avatar in the room and returns back to its initial position after a sweep. This way your tijpar will not be static, but participate in the party!
|-
|[[User:Void_Singer/Functions#Weekday_from_.28_Y.2C_M.2C_D_.29_format|Timestamp:<br>Weekday from (Y, M, D) format]]
|{{User|Void Singer}}
|Gets weekday from (Y, M, D) timestamps (ex: "Friday" from (2009, 2, 13))
|-
|[[Touch A Quote]]
|{{User|CodeBastard Redgrave}}
|Touch an object to read quotes sequentially from a notecard
|-
|[[Touring Balloon]]
|{{User|Hank Ramos}}
|Automated touring balloon with many options from long ago. Always seems to work on one SL release, and not the other.
|-
|[[Towncrier]]
|[[Wizardry and Steamworks]]
|A simple towncrier to be used in role-play SIMs or wherever there is a need to broadcast news in random intervals.
|-
|[[Trivia]]
|[[Wizardry and Steamworks]]
|A trivia game engine with provided ready-made notecards.
|-
|[[Under Age Boot]]
|{{User|Chance Unknown}}
|Security device example to teleport home accounts below a minimum age limit; can be useful in combating free griefer accounts.
|-
|[[User:Rolig_Loon/UNDO_PosRot|UNDO_PosRot]]
|{{User|Rolig Loon}}
|Allows user to undo position and rotation changes that have been made "manually" to any or all prims in a linkset.
|-
|[[Universal Translator]]
|{{User|Hank Ramos}}
|Chat listener that handles seamless translation of public chat between 50+ written languages without the need for configuration. Handles numerous avatars, auto-detects languages, and works together with multiple copies of translators to spread-workload using a sophisticated back-end communications sub-system.
|-
|[[Unix2DateTime]]
|{{User|Flennan Roffo}}
|Conversion from Unix time ([[llGetUnixTime]]()) to date and time string and vice versa.
|-
|[[Unmutable Descript Nagger]]
|{{User|Bobbyb30 Zohari}}
|To nag avatars to take off their scripted attatchments.
|-
|[[Unpacker On Rez (NewAge)]]
|{{User|Asia Snowfall}}
|A very simple to use script for all you creators out there, This script will enable you to send out boxed items and make it easier for users to unpack, Also features auto die on completion. Very simple to configure!
|-
|[[Unpacker On Touch (NewAge)]]
|{{User|Asia Snowfall}}
|Exactly like Unpacker On Rez, But changed some things about to make it Unpack On Touch
|-
|[[Update distributor]]
|{{User|Dale Innis}}
|Distribute an object (like a project update) to a list of people named in a notecard.
|-
|[[UUID2Channel]]
|{{User|Project Neox}}
|Optimised version of the original key2channel generators.
|-
|[[UUID Song Generator]]
|{{User2|Sendao Goodman}}
|Translates a UUID into a simple song and plays it.
|-
|[[User:Void_Singer/Programs#v7-D_Advanced_Visitor_Greeter|Visitor Greeter]]
|{{User|Void Singer}}
|Reduced spam visitor greeter, highly configurable, easy to modify.
|-
|[[VariText]]
|[[User:Geneko Nemeth|Geneko Nemeth (Kakurady)]]
|Display text on a prim, without looking like from a typewriter
|-
|[[Visitor Logger (Web/Basic) ]]
|{{User|Buddy Sprocket}}
|A very basic visitor logger - log visitors in SL to a text file on your web-site.
|-
|[[Visitors]]
|[[Wizardry and Steamworks]]
|A series of scripts to hold lists of visitors taking into account display names and supporting tracking multiple visits.
|-
|[[Volleyball Game (Kira's Artillery Variations)]]
|[[Wizardry and Steamworks]]
|The game of Volleyball in SecondLife, based on the [[Artillery]] script and freefall theory. Full build instructions, scripts, import archive and marketplace freebie product. All full permission.
|-
|[[Vote Simple]]
|{{User|JB Kraft}}
|Simple vote collector. One avi, one vote.
|-
|[[Walking Sound (NewAge)]]
|{{User|Asia Snowfall}}
|Very powerful walking sound script, Featuring customer ability to add their own sounds with the API Sound Feature!
|-
|[[Wanderer]]
|[[Wizardry and Steamworks]]
|A script that can be used to randomly move a prim around relative to its origin point. Can be used for breeders, robots, birds and other applications where a primitive has to move around by itself.
|-
|[[WarpPos]]
|{{User2|Keknehv Psaltery}}
|Non-physical movement without the 10m limit.
|-
|[[Watchdog]]
|{{User|Tika Oberueng}}
|LSL Watchdog scripts to monitor other scripts in the prim and restart them if they crash or stop running.
|-
|[[Wiki3DBuilder]] [[Wiki3DBuilder1.0]]
|{{User|Salahzar Stenvaag}}
|Allows a group of people to collectively build up complex 3D mindmaps with connected concepts. Uses particles for connections and low prim usage. Nodes can be textured, colored, changed form size moved collectively by everybody and can distribute notecards, landmarks, URL, objects, textures. I provide two version 0.1 and 1.0 and probably next version will communicate with moodle and sloodle external websites.
|-
|[[Window Control]]
|{{User|Emmas Seetan}}
|For window opacity, helpful for buildings.
|-
|[[XTEA Strong Encryption Implementation]]
|{{User|Morse Dillon}}
|An LSL implementation of XTEA (eXtended Tiny Encryption Algorithm). This is the first known public release of a 'real' strong encryption implementation in LSL and is released under the GNU General Public License (GPL).
|-
|[[XyText 1.5|XyText]]
|{{User2|Xylor Baysklef}}
| Display text (up to 10 characters) on a prim. Use as many prims as desired.
|-
|[[XyyyyzText|XyyyyzText]]
|{{User|Criz Collins}}
| Display text (up to 10 characters) on a prim. Displays different text for each line instead of one single text, that will be broken into the next lines. Watch here for what that means: http://screencast.com/t/1wMLujLcEO
|-
|[[XyzzyText|XyzzyText]]
|{{User|Thraxis Epsilon}} and {{User|Gigs Taggart}}
| Display text (up to 10 characters) on a prim. Way more efficient than XyText.
|-
|[[Youtube TV]]
|{{User|Morgam Biedermann}}
|Watch your favorite Youtube videos / auto set the texture to the parcel media texture.
|-
|[[Input number of seconds, get a string back that shows days, hours, minutes, seconds]]
|{{User|Fire Centaur}}
|Returns a string that displays days, hours, seconds
|-
|[[Presenter with Timer]]
|[[User:Fire Centaur]]
|Yet another texture presenter with a timer, lock, next/prev etc
|-
|[[Random Giver Prim]]
|{{User|Damian Darkwyr}}
|A randomized item giver with a game-like twist
|-
|[[Client Specific Contents Giver]]
|{{User|Damian Darkwyr}}
|Give Contents only to users of a specific Client. Such as Phoenix, CoolVL or 2.0
|-
|[[User:Void_Singer/v7-D_Zen_Resizer|Zen Resizer]]
|{{User|Void Singer}}
|Single script object resizer w/ multi-language & multi-menu support, + many other features for simple or advanced use.
|-
|[[User:Yumi Murakami/Weaver Spell Grid|Weaver Spell Grid]]
|{{User|Yumi Murakami}}
|Designs simple objects and creates them with magic words.
|-
|[[Zero Lag Poseball]]
|{{User|Jippen Faddoul}} and {{User|Daemonika Nightfire}}
|A simple poseball with no lag
|-
|[[User:Dora_Gustafson/bezier_toy|Bézier Toy]]
|{{User|Dora Gustafson}}
|Strictly for fun! The toy is made by one prim and a script. The prim will move along a smooth closed Bézier curve in space until it is stopped.
|}

==Support Script Library==
These are scripts in other languages, intended to be run on other systems that support scripts written in LSL

{| class="sortable" {{Prettytable}}
|- {{Hl2}}
! '''Name'''
! '''Creator'''
! '''Description'''
|-
|[https://github.com/Nexii-Malthus/phpPathfinding phpPathfinding]
|{{User|Nexii Malthus}}
|PHP script for offloading complex pathfinding operations away from heavy use simulators onto external servers. Primarily A* Algorithm. Flexible -- works with any type of node graph. Public Domain. Clean and minimalistic code.
|-
|[[User:Ina Centaur/UUID/calimg.api|Calendar Image UUID API]]
|{{User|Ina Centaur}}
|API that gives the UUID of an image of a calendar image give month and year arguments.
|-
|[[HTTP Post request to a PHP server]]
|{{User|Corto Maltese}}
|This small library allows you to make simple POST requests to your website. The libraries allow you to get your request through the variable $_POST on the server. It also include a basic security mechanism aimed to stop hacking. Comprises of LSL client script and PHP server script.
|-
|[[User:Ina Centaur/PHP/k2n.php|Key2Name.php]]
|{{User|Ina Centaur}}
|Get Avatar's Name using Second Life search service. (like in LSL Key2Name)
|-
|[[User:Darien_Caldwell/HTTP-DNS|HTTP-IN DNS]]
|{{User|Darien Caldwell}}
|Public Domain DNS and HTTP-IN URL Distribution system running on GAE (the original). Deploy your own for maximum utility and security.
|-
|[[Lame_Object_DNS_and_Cross_Sim_Messaging|Lame Object DNS and Cross Sim Messaging]]
|{{User2|Liandra Ceawlin}}
|Simple, cheeseball method of doing cross-sim communications with http-in and an external object DNS service.
|-
|[[Minify|LSL Minify]]
|[[Wizardry and Steamworks]]
|LSL Minification and obfuscation tool written in JavaScript. Contains a form on the wiki using a widget where you can post LSL scripts to be minified as well as the source-code. For another full-screen demo you may [http://eva.comaroski.me/lslclean.html check it on my website]. To use, paste any LSL code and press ctrl+alt+enter to get the minified version.
|-
|[[User:SignpostMarv Martin/PHP/llXorBase64StringsCorrect|llXorBase64StringsCorrect]]
|{{User|SignpostMarv Martin}}
|An implementation of [[llXorBase64StringsCorrect]] in PHP- should be useful if you're using llXorBase64StringsCorrect to do cryptography work in LSL2 and posting it out to the web via [[llHTTPRequest]].
|-
|[[User:SignpostMarv Martin/PHP/lsl fu.php|lsl_fu.php]]
|{{User|SignpostMarv Martin}}
|A basic OOP'd PHP Class containing VeloxSeverine's $_POST fixer and Marv's own eccentric ideas for "fixing" things.
|-
|[[User:Jor3l Boa/PHP/n2k.php|Name2Key.php]]
|{{User|Jor3l Boa}}
|Get Avatar's UUID using Second Life search service. (like in LSL Name2Key)
|-
|[[Public_Object_DNS|Public Object DNS]]
|{{User2|Liandra Ceawlin}}
|Public object DNS-like system running on GAE, for http-in. Hopefully scalable enough for wide-spread usage.
|-
|[[Rake|Rake]]
|[[Wizardry and Steamworks]]
|A C# utility meant to create full inventory backups to your local hard-drive including Textures/Sculpts, Animations, Notecards and Scripts.
|-
|Silo
|{{User2|Zero Linden}}
|General purpose data store in PHP. Use this to persist arbitrary data from LSL via [[llHTTPRequest]]. See:
* [http://www.notabene-sl.com/misc/silo-README.txt README] file
* [http://www.notabene-sl.com/misc/silo.tgz silo.tgz] tarball
* forum post [http://forums-archive.secondlife.com/54/69/119570/1.html Announcement].
|-
|[[Silverday ObjectDNS]]
|{{User|Till Stirling}}
|Dynamic Object-DNS-System to provide dynamic mapping of LSL-URLs to persistent domains. Features include redirect service, password protected domains, write protected domains, LSL-API for all necessary functions, optional web-interface.
|-
|[https://github.com/jgpippin/sldb SLDB]
|{{User2|Luc Aubret}}
|Flexible web database storage using PHP/MySQL. Used to store per-user field/value pairs from in-world objects using [[llHTTPRequest]].
|-
|[https://tlabsfoundry.atlassian.net/wiki/display/SLAD/SL+Asset+Data SL Asset Data]
|{{User|Trimda Hedges}}
|A set of Java classes to retrieve information about Groups, Parcels and Agents/Avatars based on their key (UUID). Includes caching of requests and results and example application. Copyright under Eclipse Public License v1
* [https://tlabsfoundry.atlassian.net/wiki/display/SLAD/Downloads Downloads]
* [http://trimda.com/javadocs/slassetdata/1.1.0/ JavaDocs]
* [https://tlabsfoundry.atlassian.net/wiki/display/TF/TLabs+Foundry Other Projects]
|}

== See Also ==
<div style="padding: 0.5em">
'''Articles'''
*[[:Category:LSL Examples| Examples]]

</div></div>

{{LSLC|}}

LibObj/Reference

2015-10-24T14:34:39Z

Ochi Wolfe: Small fixes

== LibObj Base - Object Handles ==

'''Interface'''

<source lang="lsl2">
integer objNew()
objDelete(integer id)
</source>

'''Guarantees'''

* The handle returned by <code>objNew</code> is positive (> 0).
* The handle returned by <code>objNew</code> is unique among all handles existing at the moment the function is called.
* <code>objDelete</code> does nothing if the given handle id does not exist.

'''Assumptions'''

* The implementation of <code>objDelete</code> should include calls to suitable functions of any used extensions to delete data associated with the given object.

'''Description'''

LibObj has a simple representation of "objects" as handles which are of type <code>integer</code>. Objects may be created and deleted using the "Object Base" module consisting of the functions <code>objNew</code> and <code>objDelete</code>. All handles returned by <code>objNew()</code> are unique within the script at any given point in time and positive (> 0). By themself, handles have little use but are instead intended to be used in combination with any of the extensions described below to associate additional data with the objects.

'''Important:''' In addition to deleting the object handle, the <code>objDelete</code> function also needs to call additional functions to delete any data associated with the object managed by the used extensions. Keep this in mind and make sure that all deletion function calls corresponding to the extensions you're using are included in the implementation of <code>objDelete</code>.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create a new object.
objDelete(a); // Delete it again.
</source>

== "Names" Extension ==

'''Interface'''

<source lang="lsl2">
integer objSetName(integer id, string name)
string objGetName(integer id)
integer objByName(string name)
</source>

'''Guarantees'''

* <code>objSetName</code> returns the given object handle, even if invalid.
* <code>objSetName</code> removes the name if <code>name == ""</code>.
* If a name for the given object already exists, <code>objSetName</code> replaces that name.
* <code>objByName</code> returns 0 if an object with the given name does not exist.

'''Assumptions'''

* No particular assumptions.

'''Description'''

The purpose of this extension is to address objects by name. Using the <code>objSetName</code> function of the names extension you can assign a name to an object. The main use of this extension is to look up objects by name using <code>objByName</code>. Once an object handle is retrieved, further operations may be performed on it. The <code>objByName</code> function returns 0 if an object with the given name is not found. Note that arbitrary data should generally not be stored as an object name; use the "data" or "properties" extensions for that purpose.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create a new object.
objSetName(a, "A"); // Assign name to object.
llOwnerSay(objGetName(a)); // Says "A".
integer b = objByName("A"); // b == a.
objDelete(b); // Deletes the object.
</source>

== "Paths" Extension ==

'''Interface'''

<source lang="lsl2">
integer objSetPath(integer id, list path)
list objGetPath(integer id)
string objGetPathItem(integer id, integer item)
integer objByPath(list path)
</source>

'''Guarantees'''

* <code>objSetPath</code> returns the given object handle, even if invalid.
* <code>objSetPath</code> removes the path if <code>path == []</code>.
* If a path for the given object already exists, <code>objSetPath</code> replaces it.
* <code>objByPath</code> returns 0 if the given path does not match any object.

'''Assumptions'''

* All elements of paths are automatically converted to the string data type.
* No element of valid paths should contain the newline character ("\n").

'''Description'''

The purpose of this extension is to address objects in a hierarchical (tree-like) manner. It is a generalization of the "names" extensions with more possibilities. Instead of assigning an object a single string as name, a multi-element list ("path") of names may be given. This principle may be used to group objects of a specific "type" by giving them a common prefix (for instance the first item in the path list). The <code>objByPath</code> function to retrieve an object handle by path does '''not''' require the whole path to match but instead returns the first object whose path '''prefix''' matches the given list.

'''Note:''' All elements of a given path are converted to strings and '''no''' path element shall contain a '''newline''' ("\n") character.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create a new object.
integer b = objNew(); // Create another object.
objSetPath(a, ["X"]); // Assigns path to object a.
objSetPath(b, ["X", "Y"]); // Assigns path to object b.
integer x = objByPath(["X"]); // x == a.
integer y = objByPath(["X", "Y"]); // y == b.
llOwnerSay(objGetPathItem(x, 0)); // Says "X".
llOwnerSay(objGetPathItem(y, 1)); // Says "Y".
objDelete(x); // Deletes x (and a).
objDelete(y); // Deletes y (and b).
</source>

== "Data" Extension ==

'''Interface'''

<source lang="lsl2">
integer objSetData(integer id, string data)
string objGetData(integer id)
</source>

'''Guarantees'''

* <code>objSetData</code> returns the given object handle, even if invalid.
* <code>objSetData</code> removes any existing data for the given object if <code>data == ""</code>.
* <code>objGetData</code> returns the empty string ("") if no data is associated with the given object.

'''Assumptions'''

* No particular assumptions.

'''Description'''

The purpose of this extension is to assign a (string) payload to an object. It is similar to the "names" extension but does not include the capability to retrieve objects given a string. It is suitable to store possibly unsafe user data related to an object.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create a new object.
objSetData(a, "Payload"); // Assign string data to object.
llOwnerSay(objGetData(a)); // Says "Payload".
objDelete(a); // Deletes the object.
</source>

== "Properties" Extension ==

'''Interface'''

<source lang="lsl2">
integer objSetProp(integer id, string prop, string data)
string objGetProp(integer id, string prop)
</source>

'''Guarantees'''

* <code>objSetProp</code> returns the given object handle, even if invalid.
* <code>objSetProp</code> removes '''all''' properties of the given object if <code>prop == ""</code>.
* <code>objSetProp</code> removes a given property "X" if <code>prop == "X"</code> and <code>data == ""</code>.
* <code>objGetProp</code> returns the empty string ("") if the given object or property does not exist.

'''Assumptions'''

* No particular assumptions.

'''Description'''

The purpose of this extension is to assign '''named''' properties to an object. It is a generalization of the "data" extension in that it allows to assign '''multiple''' separate string payloads to a single object. The idea is to simulate the concept of e.g. "structs" or "dictionaries" in other languages.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Creates a new object.
objSetProp(a, "A", "X"); // Add property "A" with content "X".
objSetProp(a, "B", "Y"); // Add property "B" with content "Y".
objSetProp(a, "A", "Z"); // Replace content of property "A" with "Z".
llOwnerSay(objGetProp(a, "A")); // Says "Z".
objDelete(a); // Delete the object.
</source>

== "Hierarchy" Extension ==

'''Interface'''

<source lang="lsl2">
integer objSetParent(integer id, integer parent)
integer objGetParent(integer id)
integer objGetChild(integer id)
list objGetChildren(integer id)
</source>

'''Guarantees'''

* <code>objSetParent</code> returns the given object handle, even if invalid.
* <code>objSetParent</code> removes the parent relation for the given object if <code>parent == 0</code>.
* <code>objGetChild</code> returns 0 if the given object has no children.
* <code>objGetChildren</code> returns the empty list ([]) if the given object has no children.

'''Assumptions'''

* If non-zero, the parent object given to <code>objSetParent</code> shall be a handle to an existing object.
* The <code>objDelete</code> function should take care of setting the parent of children of the object being deleted to 0.

'''Description'''

The purpose of this extension is to define "child-parent" relationships between objects which allows to build object hierarchies (without common, redundant name prefixes as with the "path" extension). An object may have one parent object specified using the <code>objSetParent</code> function. Conversely, an object <code>obj</code> may have multiple (implicitly defined) children which is the set of objects whose parent is <code>obj</code>. The function <code>objGetChild</code> returns the first child for a given object; the function <code>objGetChildren</code> may be used to get a list of all children of an object (a list of object handles).

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create object a.
integer b = objNew(); // Create object b.
integer c = objNew(); // Create object c.
objSetParent(b, a); // Set parent of object b to a.
objSetParent(c, a); // Set parent of object c to a.
list children = objGetChildren(a); // children == [b, c].
integer child = objGetChild(a); // x == b or x == c, implementation dependent.
while (child = objGetChild(a)) {objDelete(child);} // Delete children (b, c).
objDelete(a); // Delete remaining object.
</source>

== Object Timeouts ==

'''Interface'''

<source lang="lsl2">
integer objSetTimeout(integer id, integer time)
integer objCheckTimeout()

// Minimal timer event for handling timeouts:
timer() {
integer obj;
while (obj = objCheckTimeout()) {
// Do something with obj.

// Finally, you should either disable the timeout for the object
// by calling objSetTimeout(obj, 0) or delete the object.
objDelete(obj);
}
}
</source>

'''Guarantees'''

* <code>objSetTimeout</code> returns the given object handle, even if invalid.
* Timeout is removed by <code>objSetTimeout</code> if <code>time <= 0</code>

'''Assumptions'''

* The temporal resolution of timeouts are relatively coarse (seconds).
* The timeout mechanism should not be used for high frequency timers.

'''Description'''

The purpose of this extension is to set independent timeouts for objects which are handled asynchronously by a timer event at a later point in time.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create a new object.
objSetTimeout(a, 5); // Timeout handle will trigger in approximately 5 seconds in timer event.
</source>

LibObj

2015-10-24T13:44:06Z

Ochi Wolfe:

{{LSL Header|ml=*}}

== Introduction ==

LibObj is a collection of functions that are designed to simplify data management of multiple, (pseudo-)parallel threads in LSL scripts. Examples include the communication with multiple avatars (e.g. through dialogs) or objects (e.g. through listens or HTTP) where the states of the communication threads are usually independent from one another.

To this end, the library implements a rudimentary concept of object-oriented data management. The concept should be relatively easy to grasp and use for programmers and offers versatile means to data management which is not resticted to its originally intended use case.

Management of "objects" is based on two functions, <code>objNew</code> and <code>objDelete</code>, which merely manage unique, light-weight object handles. Functionality is extended by various functions which operate on these handles. The library is modular in that only the subset of functions which is actually used by a particular script needs to be included.

== Documentation ==

[[LibObj/Reference|Reference]]

For complete examples, please see the "Examples" subdirectory in the GitHub repo linked below.

== License ==

The library is open source under the MIT license.

== How to obtain ==

The latest version is available on [https://github.com/furware/libobj GitHub].

LibObj/Reference

2015-10-24T13:41:54Z

Ochi Wolfe: Initial version

== LibObj Base - Object Handles ==

'''Interface'''

<source lang="lsl2">
integer objNew()
objDelete(integer id)
</source>

'''Guarantees'''

* The handle returned by <code>objNew</code> is positive (> 0).
* The handle returned by <code>objNew</code> is unique among all handles existing at the moment the function is called.
* <code>objDelete</code> does nothing if the given handle id does not exist.

'''Assumptions'''

* The implementation of <code>objDelete</code> should include calls to suitable functions of any used extensions to delete data associated with the given object.

'''Description'''

LibObj has a simple representation of "objects" as handles which are of type <code>integer</code>. Objects may be created and deleted using the "Object Base" module consisting of the functions <code>objNew</code> and <code>objDelete</code>. All handles returned by <code>objNew()</code> are unique within the script at any given point in time and positive (> 0). By themself, handles have little use but are instead intended to be used in combination with any of the extensions described below to associate additional data with the objects.

'''Important:''' In addition to deleting the object handle, the <code>objDelete</code> function also needs to call additional functions to delete any data associated with the object managed by the used extensions. Keep this in mind and make sure that all deletion function calls corresponding to the extensions you're using are included in the implementation of <code>objDelete</code>.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create a new object.
objDelete(a); // Delete it again.
</source>

== "Names" Extension ==

'''Interface'''

<source lang="lsl2">
integer objSetName(integer id, string name)
string objGetName(integer id)
integer objByName(string name)
</source>

'''Guarantees'''

* <code>objSetName</code> returns the given object handle, even if invalid.
* <code>objSetName</code> removes the name if <code>name == ""</code>.
* If a name for the given object already exists, <code>objSetName</code> replaces that name.
* <code>objByName</code> returns 0 if an object with the given name does not exist.

'''Assumptions'''

* No particular assumptions.

'''Description'''

The purpose of this extension is to address objects by name. Using the <code>objSetName</code> function of the names extension you can assign a name to an object. The main use of this extension is to look up objects by name using <code>objByName</code>. Once an object handle is retrieved, further operations may be performed on it. The <code>objByName</code> function returns 0 if an object with the given name is not found. Note that arbitrary data should generally not be stored as an object name; use the "data" or "properties" extensions for that purpose.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create a new object.
setName(a, "A"); // Assign name to object.
llOwnerSay(getName(a)); // Says "A".
integer b = objByName("A"); // b == a.
objDelete(b); // Deletes the object.
</source>

== "Paths" Extension ==

'''Interface'''

<source lang="lsl2">
integer objSetPath(integer id, list path)
list objGetPath(integer id)
string objGetPathItem(integer id, integer item)
integer objByPath(list path)
</source>

'''Guarantees'''

* <code>objSetPath</code> returns the given object handle, even if invalid.
* <code>objSetPath</code> removes the path if <code>path == []</code>.
* If a path for the given object already exists, <code>objSetPath</code> replaces it.
* <code>objByPath</code> returns 0 if the given path does not match any object.

'''Assumptions'''

* All elements of paths are automatically converted to the string data type.
* No element of valid paths should contain the newline character ("\n").

'''Description'''

The purpose of this extension is to address objects in a hierarchical (tree-like) manner. It is a generalization of the "names" extensions with more possibilities. Instead of assigning an object a single string as name, a multi-element list ("path") of names may be given. This principle may be used to group objects of a specific "type" by giving them a common prefix (for instance the first item in the path list). The <code>objByPath</code> function to retrieve an object handle by path does '''not''' require the whole path to match but instead returns the first object whose path '''prefix''' matches the given list.

'''Note:''' All elements of a given path are converted to strings and '''no''' path element shall be '''empty''' or contain a '''newline''' ("\n") character.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create a new object.
integer b = objNew(); // Create another object.
objSetPath(a, ["X"]); // Assigns path to object a.
objSetPath(b, ["X", "Y"]); // Assigns path to object b.
integer x = objByPath(["X"]); // x == a.
integer y = objByPath(["X", "Y"]); // y == b.
llOwnerSay(objGetPathItem(y, 1)); // Says "Y".
objDelete(x); // Deletes x (and a).
objDelete(y); // Deletes y (and b).
</source>

== "Data" Extension ==

'''Interface'''

<source lang="lsl2">
integer objSetData(integer id, string data)
string objGetData(integer id)
</source>

'''Guarantees'''

* <code>objSetData</code> returns the given object handle, even if invalid.
* <code>objSetData</code> removes any existing data for the given object if <code>data == ""</code>.
* <code>objGetData</code> returns the empty string ("") if no data is associated with the given object.

'''Assumptions'''

* No particular assumptions.

'''Description'''

The purpose of this extension is to assign a (string) payload to an object. It is similar to the "names" extension but does not include the capability to retrieve objects given a string. It is suitable to store possibly unsafe user data related to an object.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create a new object.
objSetData(a, "Payload"); // Assign string data to object.
llOwnerSay(objGetData(a)); // Says "Payload".
objDelete(a); // Deletes the object.
</source>

== "Properties" Extension ==

'''Interface'''

<source lang="lsl2">
integer objSetProp(integer id, string prop, string data)
string objGetProp(integer id, string prop)
</source>

'''Guarantees'''

* <code>objSetProp</code> returns the given object handle, even if invalid.
* <code>objSetProp</code> removes '''all''' properties of the given object if <code>prop == ""</code>.
* <code>objGetProp</code> returns the empty string ("") if the given object or property does not exist.

'''Assumptions'''

* The id provided to <code>objSetProp</code> shall be positive (> 0).

'''Description'''

The purpose of this extension is to assign '''named''' properties to an object. It is a generalization of the "data" extension in that it allows to assign '''multiple''' separate string payloads to a single object. The idea is to simulate the concept of e.g. "structs" or "dictionaries" in other languages.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Creates a new object.
objSetProp(a, "A", "X"); // Add property "A" with content "X".
objSetProp(a, "B", "Y"); // Add property "B" with content "Y".
objSetProp(a, "A", "Z"); // Replace content of property "A" with "Z".
llOwnerSay(objGetProp(a, "A")); // Says "Z".
objDelete(a); // Delete the object.
</source>

== "Hierarchy" Extension ==

'''Interface'''

<source lang="lsl2">
integer objSetParent(integer id, integer parent)
integer objGetParent(integer id)
integer objGetChild(integer id)
list objGetChildren(integer id)
</source>

'''Guarantees'''

* <code>objSetParent</code> returns the given object handle, even if invalid.
* <code>objSetParent</code> removes the parent relation for the given object if <code>parent == 0</code>.
* <code>objGetChild</code> returns 0 if the given object has no children.
* <code>objGetChildren</code> returns the empty list ([]) if the given object has no children.

'''Assumptions'''

* If non-zero, the parent object given to <code>objSetParent</code> shall be a handle to an existing object.

'''Description'''

The purpose of this extension is to define "child-parent" relationships between objects which allows to build object hierarchies (without common, redundant name prefixes as with the "path" extension). An object may have one parent object specified using the <code>objSetParent</code> function. Conversely, an object <code>obj</code> may have multiple (implicitly defined) children which is the set of objects whose parent is <code>obj</code>. The function <code>objGetChild</code> returns the first child for a given object; the function <code>objGetChildren</code> may be used to get a list of all children of an object (a list of object handles).

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create object a.
integer b = objNew(); // Create object b.
integer c = objNew(); // Create object c.
objSetParent(b, a); // Set parent of object b to a.
objSetParent(c, a); // Set parent of object c to a.
list children = objGetChildren(a); // children == [b, c].
integer child = objGetChild(a); // x == b or x == c, implementation dependent.
while (child = objGetChild(a)) {objDelete(child);} // Delete children (b, c).
objDelete(a); // Delete remaining object.
</source>

== Object Timeouts ==

'''Interface'''

<source lang="lsl2">
integer objSetTimeout(integer id, integer time)
integer objCheckTimeout()

// Minimal timer event for handling timeouts:
timer() {
integer obj;
while (obj = objCheckTimeout()) {
// Do something with obj.

// Finally, you should either disable the timeout for the object
// by calling objSetTimeout(obj, 0) or delete the object.
objDelete(obj);
}
}
</source>

'''Guarantees'''

* <code>objSetTimeout</code> returns the given object handle, even if invalid.
* Timeout is removed by <code>objSetTimeout</code> if <code>time == 0</code>

'''Assumptions'''

* Behavior of <code>objSetTimeout</code> is undefined for <code>time < 0</code>

'''Description'''

The purpose of this extension is to set independent timeouts for objects which are handled asynchronously by a timer event at a later point in time.

'''Example'''

<source lang="lsl2">
integer a = objNew(); // Create a new object.
objSetTimeout(a, 5); // Timeout handle will trigger in approximately 5 seconds in timer event.
</source>

LibObj

2015-10-24T13:40:32Z

Ochi Wolfe: Initial version

{{LSL Header|ml=*}}

== Introduction ==

LibObj is a collection of functions that are designed to simplify data management of multiple, (pseudo-)parallel threads in LSL scripts. Examples include the communication with multiple avatars (e.g. through dialogs) or objects (e.g. through listens or HTTP) where the states of the communication threads are usually independent from one another.

To this end, the library implements a rudimentary concept of object-oriented data management. The concept should be relatively easy to grasp and use for programmers and offers versatile means to data management which is not resticted to its originally intended use case.

Management of "objects" is based on two functions, <code>objNew</code> and <code>objDelete</code>, which merely manage unique, light-weight object handles. Functionality is extended by various functions which operate on these handles. The library is modular in that only the subset of functions which is actually used by a particular script needs to be included.

== Documentation ==

[[LibObj/Reference|Reference]]

[[LibObj/Examples|Examples]]

== License ==

The library is open source under the MIT license.

== How to obtain ==

The latest version is available on [https://github.com/furware/libobj GitHub].

FURWARE text/de

2015-04-08T09:12:19Z

Ochi Wolfe: Removed todo section

{{LSL Header|ml=*}}

Diese Seite ist auch [[FURWARE_text|auf englisch]] verfügbar. / This page is also available [[FURWARE_text|in English]].

== Übersicht ==

FURWARE text ist ein '''Skript zur Darstellung von Text''' mittels Texturen auf Prims. Es ist zum '''Einbau in deine Objekte''' gedacht in denen es von '''deinen eigenen Skripten''' gesteuert wird.

FURWARE text '''ist keine''' vorgefertigte Anzeigetafel sondern ist für '''Skripter''' gedacht, die es in ihre eigene Kreationen integrieren.

Das Skript war von 2010 bis Juli 2013 proprietär bis ich ({{User|Ochi Wolfe}}) mich dazu entschieden habe, es Open Source unter der MIT-Lizenz zu machen. Dies ist mein erster Versuch eines vollständig offenen Produkts in Second Life.

== Merkmale ==

* '''Open source''' (MIT license)
* '''Nur ein Skript''' für eine ganze Gruppe ("sets") von Anzeigetafeln
* '''Formatierung''' (Farbe, Alpha, Ausrichtung, Umbruch, Trimming, Font, Rahmen)
* '''Mesh prims''' mit 1-8 Zeichen, die je nur 0.5 Prims belegen
* '''Virtuelle Text-Boxen''' um Text beliebig zu Positionieren
* '''Style templates''' um mehrere Stileinstellungen zusammenzufassen

== Wo du das Skript bekommst ==

Du kannst dir ein komplettes Paket inklusive dem Display Creator, Meshes und Schrift-Texturen auf [http://marketplace.secondlife.com/p/FURWARE-text/141379 dem Marketplace] holen.

Für Entwickler und interessierte Benutzer habe ich für die Skripte außerdem einen Account auf [http://github.com/furware/text GitHub] erstellt.

== Dokumentation ==

Unter den folgenden Unterseiten findest du eine Bedienungsanleitung sowie Dokumentation für Entwickler:

[[FURWARE_text/Tutorial/de|Erste Schritte & ausführliches Tutorial]]

[[FURWARE_text/Reference/de|Kurzreferenz & Versionsgeschichte]]

[[FURWARE_text/Snippets/de|Hilfsfunktionen für einfachere Verwendung]]

[[FURWARE_text/Developers/de|Dokumentation für Entwickler]]

== Texture creator ==

Auf [[FURWARE_text/TextureCreator/de|dieser]] Seite findest du mehr Informationen zum "texture creator", mit dem du deine eigenen Schrifttexturen erstellen kannst.

== Wie du helfen kannst ==

'''Für Anwender:''' Eine wichtige Hilfe bei der Entwicklung dieses Skripts ist das Berichten von Problemen bei seiner Verwendung sowie Vorschläge, wie man die Benutzung noch besser machen kann. Momentan sind die wahrscheinlich besten Möglichkeiten hierfür {{User|Ochi Wolfe}} eine Notecard zu schreiben oder deine Kommentare zur Diskussion dieser Wiki-Seite hinzuzufügen.

'''Für Entwickler:''' Wenn du Vorschläge für die Verbesserung des Skripts hast kannst du diese gerne auf dieselbe Weise kundtun. Alternativ kannst du aber auch gerne einen Branch des Projekts auf [http://github.com/furware/text GitHub] erstellen und Pull-Requests senden. Bitte stelle sicher, dass die Änderungen von sehr guter Qualität sind und sie das Skript nicht weiter aufblähen als es sowieso schon ist. Genauergesagt sind Vorschläge zur Verbesserung der Performance und Senkung des Speicherverbrauchs '''äußerst''' gern gesehen.

== Bekannte Probleme ==

Für die aktuelle Version sind keine Probleme bekannt. Falls welche auftreten, melde dies bitte.

FURWARE text

2015-04-08T09:11:46Z

Ochi Wolfe: Removed todo section

{{LSL Header|ml=*}}

This page is also available [[FURWARE_text/de|in German]]. / Diese Seite ist auch [[FURWARE_text/de|auf deutsch]] verfügbar.

== Overview ==

FURWARE text is a '''script for displaying text''' on prims using textures. It is intended to be '''integrated in your objects''' in which it will be controlled by '''your own scripts'''.

FURWARE text '''is not''' a ready-made display board but is intented for '''scripters''' who wish to integrate it in their own creations.

The script was proprietary from 2010 to July 2013 until I ({{User|Ochi Wolfe}}) have decided to make it open source under the MIT license. It is my first attempt to make a fully open sourced product in Second Life.

== Features ==

* '''Open source''' (MIT license)
* '''Only one script''' for a whole group ("sets") of displays
* '''Formatting''' (color, alpha, alignment, wrapping, trimming, font, borders)
* '''Mesh prims''' with 1 to 8 chars, only occupying 0.5 prims each
* '''Virtual text boxes''' to position text arbitrarily
* '''Style templates''' for encapsulating multiple style settings

== How to obtain the script ==

You can obtain a complete package containing the script, the display creator, display meshes and font textures at [http://marketplace.secondlife.com/p/FURWARE-text/141379 the Marketplace].

For developers and interested users, I have also set up a [http://github.com/furware/text GitHub] account for the core scripts.

== Documentation ==

Please see the following subpages for the user's manual and developer documentation:

[[FURWARE_text/Tutorial|First steps & extensive tutorial]]

[[FURWARE_text/Reference|Short reference & version history]]

[[FURWARE_text/Snippets|Helper functions for more convenient usage]]

[[FURWARE_text/Developers|Developer documentation]]

== Texture creator ==

Please see [[FURWARE_text/TextureCreator|this page]] for information about the texture creator tool for making your own font textures.

== How to contribute ==

'''For users:''' A very important part of contribution to the development of this script is to report any problems you experience while using it as well as suggestions how to make using it even more awesome. For the time being, feel free to write a notecard to {{User|Ochi Wolfe}} or add your comments to the discussion of this wiki-page.

'''For developers:''' If you have any suggestions for improvements to the script itself, you can either post them in the same way or you can branch the project on [http://github.com/furware/text GitHub] and send your pull requests. Just make sure that they are, of course, of awesome quality and that they don't bloat the script more than it already is bloated. In fact, any suggestions to improve performance and decrease memory consumption are '''very''' welcome.

== Known issues ==

No issues are known for the current release, but please report any problems you find.

Talk:Syntax Highlighting Examples

2015-04-08T09:04:51Z

Ochi Wolfe:

It seems like this extension is no longer working correctly (most languages are not being formatted correctly anymore). Is it officially deprecated or is this a bug? [[User:Ochi Wolfe|Ochi Wolfe]] ([[User talk:Ochi Wolfe|talk]]) 01:28, 8 April 2015 (PDT)

- Nevermind, see [https://jira.secondlife.com/browse/BUG-8292] [[User:Ochi Wolfe|Ochi Wolfe]] ([[User talk:Ochi Wolfe|talk]]) 02:04, 8 April 2015 (PDT)

FURWARE text/Snippets/de

2015-04-08T08:49:42Z

Ochi Wolfe: Fixed source highlighting

{{Multi-lang}}

Diese Seite beinhaltet verschiedene nützliche Code-Schnipsel (Funktionen, Konstanten), die die Arbeit mit [[FURWARE_text/de|FURWARE_text]] wesentlich angenehmer machen.

== Grundlegende Funktionen ==

Die Funktionen in diesem Abschnitt sind Wrapper um die einzelnen [[FURWARE_text/de|FURWARE_text]]-Befehle. Sie wurden so entworfen, dass sie den folgenden Anforderungen genügen:

* Die Funktionen sollen ''in sich abgeschlossen'' sein. Das heißt, dass du auch nur diejenigen Funktionen kopieren kannst, die du wirklich benötigst und sie werden funktionieren.
* Die Funktionen (und deren Parameter) sollen ''selbsterklärend'' sein. Das heißt, dass sie auch direkt als eine Kurzreferenz für den Befehl dienen sollen, den sie ausführen.

Dass die Funktionen in sich abgeschlossen sind bedeutet auch, dass jede der Funktionen einen [[llMessageLinked]](...)-Aufruf enthält. Das Ziel dieser Aufrufe ist hier auf [[LINK_SET]] (also das gesamte Linkset) gesetzt. Falls nötig, ändere dieses Ziel bitte in deinen Skripten.

<source lang="lsl2">
fwSetText(string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data");
}

fwSetBoxText(string box, string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data:" + box);
}

fwSetStyle(string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf");
}

fwSetBoxStyle(string box, string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf:" + box);
}

fwSetDefaultStyle(string target, string style) {
// "target" darf leer, "root" oder "nonroot" sein.
llMessageLinked(LINK_SET, 0, style, "fw_defaultconf:" + target);
}

fwSetVariable(string name, string value) {
llMessageLinked(LINK_SET, 0, value, "fw_var:" + name);
}

fwAddBox(string name, string parent, integer x, integer y, integer w, integer h, string text, string style) {
llMessageLinked(LINK_SET, 0, text, "fw_addbox: " +name + ":" + parent + ":"+
(string)x + "," + (string)y + "," + (string)w + "," + (string)h + ":" + style);
}

fwDelBox(string name) {
llMessageLinked(LINK_SET, 0, "", "fw_delbox:" + name);
}

fwTouchQuery(integer linkNumber, integer faceNumber, string userData) {
llMessageLinked(LINK_SET, 0, userData, "fw_touchquery:" + (string)linkNumber + ":" + (string)faceNumber);
}

list fwTouchReply(string replyString) {
list tokens = llParseStringKeepNulls(replyString, [":"], []);
return [
llList2String(tokens, 0), llList2Integer(tokens, 1), llList2Integer(tokens, 2),
llList2String(tokens, 3), llList2Integer(tokens, 4), llList2Integer(tokens, 5),
llDumpList2String(llDeleteSubList(tokens, 0, 5), ":")
];
}

fwSetNotify(integer enabled) {
string s = "off"; if (enabled) s = "on";
llMessageLinked(LINK_SET, 0, s, "fw_notify");
}

fwMemory() {
llMessageLinked(LINK_SET, 0, "", "fw_memory");
}

fwReset() {
llMessageLinked(LINK_SET, 0, "", "fw_reset");
}
</source>

=== Beispiele ===

Die oben aufgeführen Funktionen erlauben dir zwar die meisten Befehle einfacher zu verwenden, aber einige Details müssen dennoch von Hand erledigt werden, beispielsweise das Angeben von Textstil-Konfigurationen. Die folgenden Zeilen geben dir ein paar Beispiele für die Verwendung der Funktionen.

<source lang="lsl2">
// Setzt den Text aller Boxen in allen Sets.
fwSetText("Hello world!");

// Setzt den Text der Box "SomeBox".
fwSetBoxText("SomeBox", "This is some box!");

// Setzt den Standard-Stil aller Boxen auf color=red, align=center (der nächste Abschnitt zeigt, wie man dies schöner erledigen kann).
fwSetDefaultStyle("", "c=red;a=center");

// Füge eine Box "NewBox" mit "ExistingBox" als Parent hinzu.
fwAddBox("NewBox", "ExistingBox", 2, 2, 10, 5, "Some initial text", "");

// Lösche eine Box.
fwDelBox("NewBox");

// Sende eine Touch Query aus dem touch_start(...)-Event heraus.
touch_start(integer num) {
fwTouchQuery(llDetectedLinkNumber(0), llDetectedTouchFace(0), "Arbitrary user data goes here");
}

// Verarbeite eine "Touch Reply"-Antwort im link_message(...)-Event.
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_touchreply") {
list result = fwTouchReply(str);
// Die Liste "result" enthält jetzt die Antwort als [boxName, boxRelativeX, boxRelativeY, rootName, absoluteX, absoluteY, userData].
// "boxName" ist leer, wenn die Touch Query ungültig war.
}
}
</source>

== Noch angenehmere Verwendung ==

Die Funktionen im letzten Abschnitt sind lediglich Wrapper um die [[FURWARE_text/de|FURWARE_text]]-Befehle, allerdings muss du weiterhin Dinge wie Stileinstellungen selber schreiben und dir die verschiedenen Optionen und deren Werte merken. Die folgenden Konstanten und Funktionen nehmen dir einen Teil dieser Arbeit ab (auch hier gilt, dass du nur die Teile kopieren musst, die du tatsächlich benötigst – auch um Speicher zu sparen!).

{{KBtip|Beachte, dass die folgenden Zeilen die Funktionen im vorigen Abschnitt ergänzen, d.h. du musst die entsprechenden Funktionen zusätzlich mitkopieren.}}

<source lang="lsl2">
// === Farben (colors) ===

string COLOR_DEFAULT = "c=def;";

// Graustufen.
string COLOR_WHITE = "c=white;";
string COLOR_SILVER = "c=silver;";
string COLOR_GRAY = "c=gray;";
string COLOR_BLACK = "c=black;";

// Standardfarben.
string COLOR_RED = "c=red;";
string COLOR_GREEN = "c=green;";
string COLOR_BLUE = "c=blue;";
string COLOR_CYAN = "c=cyan;";
string COLOR_MAGENTA = "c=magenta;";
string COLOR_YELLOW = "c=yellow;";

// Dunkle Farben.
string COLOR_DARKRED = "c=darkred;";
string COLOR_DARKGREEN = "c=darkgreen;";
string COLOR_DARKBLUE = "c=darkblue;";
string COLOR_DARKCYAN = "c=darkcyan;";
string COLOR_DARKMAGENTA = "c=darkmagenta;";
string COLOR_DARKYELLOW = "c=darkyellow;";

// Beliebige RGB- (Rot, Grün, Blau) Farben.
string fwColorRGB(float red, float green, float blue) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + ",1" + ";";
}

// Beliebige RGBA- (Rot, Grün, Blau, Alpha/Deckkraft) Farben.
string fwColorRGBA(float red, float green, float blue, float alpha) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + "," + (string)alpha + ";";
}

// === Ausrichtung (alignment) ===

string ALIGN_DEFAULT = "a=def;";
string ALIGN_LEFT = "a=left;";
string ALIGN_CENTER = "a=center;";
string ALIGN_RIGHT = "a=right;";

// === Umbruch (wrapping) ===

string WRAP_DEFAULT = "w=def;";
string WRAP_WORD = "w=word;";
string WRAP_CHAR = "w=char;";
string WRAP_NONE = "w=none;";

// === Abschneiden von Leerzeichen am Anfang/Ende (trimming) ===

string TRIM_DEFAULT = "t=def;";
string TRIM_ON = "t=on;";
string TRIM_OFF = "t=off;";

// === Schriftarten (fonts) ===

string FONT_DEFAULT = "f=def;";
string FONT_ANDALE = "f=e31ce6e8-4117-7073-6aac-e6503034b4c5;";
string FONT_ANONYMOUS_PRO = "f=24c4ead5-04cd-1831-5fd9-ec48882e00b1;";
string FONT_ANONYMOUS_PRO_BOLD = "f=82c4fcac-3990-223c-286d-5bc92a258fbc;";
string FONT_DEJAVU = "f=f974fdfc-8fbd-2f29-2b38-3c34411c1fcc;";
string FONT_DEJAVU_BOLD = "f=5054fec3-1465-af8f-2fe5-e9507795c82a;";
string FONT_ENVYCODER = "f=a2ec2cf0-b207-db51-d4a1-f3f8d6684c07;";
string FONT_FREEFONT = "f=05f6f69e-8bdf-a824-a2cf-d91c9e371c23;";
string FONT_INCONSOLATA = "f=867288f9-940e-a7cf-ac7d-5596ea7fb2c5;";
string FONT_LIBERATION = "f=c992dfc4-0aca-02c8-bc01-8330e6db6f87;";
string FONT_LIBERATION_BOLD = "f=1494337d-5296-3c43-8f7c-45617448ec9a;";
string FONT_LUXI = "f=2d8f52d7-2220-2d7a-15b5-e685a9449e5c;";
string FONT_LUXI_BOLD = "f=03812794-535b-f546-6171-6bec5bf399be;";
string FONT_MONOFUR = "f=8fc63e35-a18f-e335-3936-e2ca196a944d;";
string FONT_NOVA = "f=2df8e09d-e1bd-d17f-6bec-b8d713790380;";
string FONT_PROFONT = "f=45a8e6f6-90e4-299d-d3bc-0bf4dbf170db;";

// === Rahmen (borders) ===

string BORDER_DEFAULT = "border=def;";

// Einige Beispiele für oft benutzte Rahmenstile.
string BORDER_ALL_SIDES = "border=tblr;";
string BORDER_ALL_SIDES_THICK = "border=tblr1;";
string BORDER_ALL_SIDES_DOUBLE = "border=tblr2;";
string BORDER_BOTTOM = "border=b;";
string BORDER_LEFT_RIGHT = "border=lr;";

// Eine allgemeinere Hilfsfunktion für Rahmen. Die Seiten-Parameter sind von oben beginnend im Uhrzeigersinn angeordnet.
string fwBorder(integer top, integer right, integer bottom, integer left, integer style) {
string result = "border=";
if (top) result += "t"; if (right) result += "r";
if (bottom) result += "b"; if (left) result += "l";
if (style) result += (string)style;
return result + ";";
}

// === Stil-Variablen ===

// Lädt einen in einer fw_var(iable) gespeicherten Stil.
string fwStyle(string styleVariableName) {
return "style=" + styleVariableName + ";";
}
</source>

=== Beispiele ===

Jeder Wert der Konstanten endet mit einem ";". Das erlaubt dir, die Konstanten einfach mit "+" zu verbinden und trotzdem gültige Strings für Stileinstellungen zu erhalten. Damit kannst du so etwas schreiben wie:

<source lang="lsl2">
// Setzt die Farbe (color), den Umbruch (wrapping) und die Schriftart (font) für alle Boxen.
fwSetStyle(COLOR_YELLOW + WRAP_NONE + FONT_MONOFUR);

// Setzt die Standard-Stileinstellung für alle Boxen.
fwSetDefaultStyle("", COLOR_RED + ALIGN_CENTER);

// Füge eine Box mit einer Stileinstellung hinzu. Wir benutzen hier eine selbstspezifizierte RGB-Farbe.
fwAddBox("SomeBox", "ParentBox", 2, 2, 10, 5, "Some initial text", FONT_LUXI + fwColorRGB(0.5, 0.75, 0.0) + BORDER_ALL_SIDES);

// Speichere einen Stil-String in einer Variablen und benutze diesen.
fwSetVariable("MyStyle", FONT_MONOFUR + ALIGN_CENTER + BORDER_ALL_SIDES);
fwSetBoxStyle("BoxA", fwStyle("MyStyle"));
fwSetBoxStyle("BoxB", fwStyle("MyStyle"));
</source>

FURWARE text/Snippets

2015-04-08T08:48:31Z

Ochi Wolfe: Fixed syntax highlighting

{{Multi-lang}}

This page contains several useful code snippets (functions, constants) that can make the usage of [[FURWARE_text]] a lot more convenient.

== Basic convenience functions ==

The functions in this section are wrappers around each of the FURWARE text commands. They were designed to follow these rules:

* The functions shall be ''self-contained''. That is, you may copy any subset of the functions that you need and they will work.
* The functions (and their parameters) shall be ''self-explanatory''. That is, they also serve as a quick reference guide to the parameters of the commands they execute.

The fact that the functions are self-contained also means that each of them contains a [[llMessageLinked]](...)-call. The target of this call is set to [[LINK_SET]] (the whole linkset). Please change this target accordingly in your scripts, if needed.

<source lang="lsl2">
fwSetText(string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data");
}

fwSetBoxText(string box, string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data:" + box);
}

fwSetStyle(string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf");
}

fwSetBoxStyle(string box, string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf:" + box);
}

fwSetDefaultStyle(string target, string style) {
// "target" may be empty, "root" or "nonroot".
llMessageLinked(LINK_SET, 0, style, "fw_defaultconf:" + target);
}

fwSetVariable(string name, string value) {
llMessageLinked(LINK_SET, 0, value, "fw_var:" + name);
}

fwAddBox(string name, string parent, integer x, integer y, integer w, integer h, string text, string style) {
llMessageLinked(LINK_SET, 0, text, "fw_addbox: " +name + ":" + parent + ":"+
(string)x + "," + (string)y + "," + (string)w + "," + (string)h + ":" + style);
}

fwDelBox(string name) {
llMessageLinked(LINK_SET, 0, "", "fw_delbox:" + name);
}

fwTouchQuery(integer linkNumber, integer faceNumber, string userData) {
llMessageLinked(LINK_SET, 0, userData, "fw_touchquery:" + (string)linkNumber + ":" + (string)faceNumber);
}

list fwTouchReply(string replyString) {
list tokens = llParseStringKeepNulls(replyString, [":"], []);
return [
llList2String(tokens, 0), llList2Integer(tokens, 1), llList2Integer(tokens, 2),
llList2String(tokens, 3), llList2Integer(tokens, 4), llList2Integer(tokens, 5),
llDumpList2String(llDeleteSubList(tokens, 0, 5), ":")
];
}

fwSetNotify(integer enabled) {
string s = "off"; if (enabled) s = "on";
llMessageLinked(LINK_SET, 0, s, "fw_notify");
}

fwMemory() {
llMessageLinked(LINK_SET, 0, "", "fw_memory");
}

fwReset() {
llMessageLinked(LINK_SET, 0, "", "fw_reset");
}
</source>

=== Examples ===

The above snippets allow you to use the basic commands more easily, but you may still need to do some manual work, for example when specifying style configuration strings. The following lines give a few assorted examples of calls using the functions.

<source lang="lsl2">
// Set the text of all boxes in all sets.
fwSetText("Hello world!");

// Set the text of the box "SomeBox".
fwSetBoxText("SomeBox", "This is some box!");

// Set the default style of all boxes to color=red, align=center (see the next section how to make this much nicer).
fwSetDefaultStyle("", "c=red;a=center");

// Add a box "NewBox" using "ExistingBox" as its parent.
fwAddBox("NewBox", "ExistingBox", 2, 2, 10, 5, "Some initial text", "");

// Delete a box.
fwDelBox("NewBox");

// Send a touch query from the touch_start(...)-event.
touch_start(integer num) {
fwTouchQuery(llDetectedLinkNumber(0), llDetectedTouchFace(0), "Arbitrary user data goes here");
}

// Parse a touch reply in the link_message(...)-event.
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_touchreply") {
list result = fwTouchReply(str);
// The list "result" now contains the reply as [boxName, boxRelativeX, boxRelativeY, rootName, absoluteX, absoluteY, userData].
// "boxName" is empty if the touch query was invalid.
}
}
</source>

== Additional awesomeness ==

The functions in the previous section are wrappers around the [[FURWARE_text]] commands, but you still need to write, for instance, style configuration strings yourself and remember the style options and values. The following set of constants and functions help you with that (again, you don't have to copy all of them but just the ones you need to save script memory!).

{{KBtip|Note that these constants complement the functions defined above, so make sure to copy the functions you need as well.}}

<source lang="lsl2">
// === Colors ===

string COLOR_DEFAULT = "c=def;";

// Grayscales.
string COLOR_WHITE = "c=white;";
string COLOR_SILVER = "c=silver;";
string COLOR_GRAY = "c=gray;";
string COLOR_BLACK = "c=black;";

// Standard colors.
string COLOR_RED = "c=red;";
string COLOR_GREEN = "c=green;";
string COLOR_BLUE = "c=blue;";
string COLOR_CYAN = "c=cyan;";
string COLOR_MAGENTA = "c=magenta;";
string COLOR_YELLOW = "c=yellow;";

// Dark colors.
string COLOR_DARKRED = "c=darkred;";
string COLOR_DARKGREEN = "c=darkgreen;";
string COLOR_DARKBLUE = "c=darkblue;";
string COLOR_DARKCYAN = "c=darkcyan;";
string COLOR_DARKMAGENTA = "c=darkmagenta;";
string COLOR_DARKYELLOW = "c=darkyellow;";

// Arbitrary RGB (red, green, blue) color.
string fwColorRGB(float red, float green, float blue) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + ",1" + ";";
}

// Arbitrary RGBA (red, green, blue, alpha/opacity) color.
string fwColorRGBA(float red, float green, float blue, float alpha) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + "," + (string)alpha + ";";
}

// === Alignment ===

string ALIGN_DEFAULT = "a=def;";
string ALIGN_LEFT = "a=left;";
string ALIGN_CENTER = "a=center;";
string ALIGN_RIGHT = "a=right;";

// === Wrapping ===

string WRAP_DEFAULT = "w=def;";
string WRAP_WORD = "w=word;";
string WRAP_CHAR = "w=char;";
string WRAP_NONE = "w=none;";

// === Trimming ===

string TRIM_DEFAULT = "t=def;";
string TRIM_ON = "t=on;";
string TRIM_OFF = "t=off;";

// === Fonts ===

string FONT_DEFAULT = "f=def;";
string FONT_ANDALE = "f=e31ce6e8-4117-7073-6aac-e6503034b4c5;";
string FONT_ANONYMOUS_PRO = "f=24c4ead5-04cd-1831-5fd9-ec48882e00b1;";
string FONT_ANONYMOUS_PRO_BOLD = "f=82c4fcac-3990-223c-286d-5bc92a258fbc;";
string FONT_DEJAVU = "f=f974fdfc-8fbd-2f29-2b38-3c34411c1fcc;";
string FONT_DEJAVU_BOLD = "f=5054fec3-1465-af8f-2fe5-e9507795c82a;";
string FONT_ENVYCODER = "f=a2ec2cf0-b207-db51-d4a1-f3f8d6684c07;";
string FONT_FREEFONT = "f=05f6f69e-8bdf-a824-a2cf-d91c9e371c23;";
string FONT_INCONSOLATA = "f=867288f9-940e-a7cf-ac7d-5596ea7fb2c5;";
string FONT_LIBERATION = "f=c992dfc4-0aca-02c8-bc01-8330e6db6f87;";
string FONT_LIBERATION_BOLD = "f=1494337d-5296-3c43-8f7c-45617448ec9a;";
string FONT_LUXI = "f=2d8f52d7-2220-2d7a-15b5-e685a9449e5c;";
string FONT_LUXI_BOLD = "f=03812794-535b-f546-6171-6bec5bf399be;";
string FONT_MONOFUR = "f=8fc63e35-a18f-e335-3936-e2ca196a944d;";
string FONT_NOVA = "f=2df8e09d-e1bd-d17f-6bec-b8d713790380;";
string FONT_PROFONT = "f=45a8e6f6-90e4-299d-d3bc-0bf4dbf170db;";

// === Borders ===

string BORDER_DEFAULT = "border=def;";

// These are just some examples for common border styles.
string BORDER_ALL_SIDES = "border=tblr;";
string BORDER_ALL_SIDES_THICK = "border=tblr1;";
string BORDER_ALL_SIDES_DOUBLE = "border=tblr2;";
string BORDER_BOTTOM = "border=b;";
string BORDER_LEFT_RIGHT = "border=lr;";

// A more general helper function for borders. The side parameters are ordered clockwise, starting on top.
string fwBorder(integer top, integer right, integer bottom, integer left, integer style) {
string result = "border=";
if (top) result += "t"; if (right) result += "r";
if (bottom) result += "b"; if (left) result += "l";
if (style) result += (string)style;
return result + ";";
}

// === Style variables ===

// Loads a style stored in a fw_var(iable).
string fwStyle(string styleVariableName) {
return "style=" + styleVariableName + ";";
}
</source>

=== Examples ===

Note that the value of each constant ends with ";". This allows you to simply "+" them together and you still get valid style strings which you may then use wherever you need a style config string. This allows you to write things like this:

<source lang="lsl2">
// Set the color, wrapping and font of all boxes.
fwSetStyle(COLOR_YELLOW + WRAP_NONE + FONT_MONOFUR);

// Set the default style for all boxes.
fwSetDefaultStyle("", COLOR_RED + ALIGN_CENTER);

// Add a box with some style config. We will use a custom RGB color here.
fwAddBox("SomeBox", "ParentBox", 2, 2, 10, 5, "Some initial text", FONT_LUXI + fwColorRGB(0.5, 0.75, 0.0) + BORDER_ALL_SIDES);

// Store a style string in a variable and use it.
fwSetVariable("MyStyle", FONT_MONOFUR + ALIGN_CENTER + BORDER_ALL_SIDES);
fwSetBoxStyle("BoxA", fwStyle("MyStyle"));
fwSetBoxStyle("BoxB", fwStyle("MyStyle"));
</source>

FURWARE text/Reference/de

2015-04-08T08:46:38Z

Ochi Wolfe: Fixed syntax highlighting

{{Multi-lang}}

== Kurzreferenz ==

Dieses Kapitel ist als eine knappe Zusammenfassung aller Dinge gedacht, die zur Arbeit mit FURWARE text nötig sind. Das sind vor allem die Namen und Parameter der verschiedenen Befehle. Das Kapitel ist nicht als Ersatz für das Tutorial gedacht.

=== Befehle ===

==== fw_data & fw_conf ====

Box-Einstellung für Text (fw_data) und Stil (fw_conf)

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Some new text", "fw_data : BoxSpec : BoxSpec : BoxSpec : ...");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_conf : BoxSpec : BoxSpec : BoxSpec : ...");
</source>

Jedes "'''BoxSpec'''" kann hierbei verschiedene Formen haben um verschiedene Boxen auszuwählen. Seien in der folgenden Tabelle "BoxOne" und "BoxTwo" zwei gültige Box-Namen aus demselben Display-Set:

{|{{Prettytable}}
! BoxSpec
! Bedeutung
|-
| (leer)
| Alle Boxen in allen Sets.
|-
| BoxOne
| Genau die Box "BoxOne".
|-
| BoxOne ; BoxTwo
| Alle Boxen zwischen* (und inklusive) "BoxOne" und "BoxTwo".
|-
| BoxOne ;
| "BoxOne" und alle folgenden* Boxen im selben Display-Set.
|-
| ; BoxTwo
| "BoxTwo" und alle davorliegenden* Boxen im selben Display-Set.
|}

(*) Abhängig von der Reihenfolge, in denen die Boxen hinzugefügt wurden.

==== fw_defaultconf ====

Setzt globale Stilvoreinstellungen

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf : root");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf : nonroot");
</source>

Die drei Varianten setzen die Stilvoreinstellung für alle Boxen, alle Root-Boxen bzw. alle Nicht-Root-Boxen.

==== fw_var ====

Speichert einen String in einem "Variablennamen". Dies wird momentan nur für Stilvorlangen verwendet.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Some string", "fw_var : varName");
</source>

Setzt den Inhalt der Variable "varName" auf "Some string". Variablen können gelöscht werden, indem ihnen der leere String zugewiesen wird.

==== fw_addbox ====

Fügt eine neue virtuelle Textbox hinzu. Es kann höchstens 16 Boxen pro Set (inklusive der Basis-Box) geben.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Some initial text", "fw_addbox : boxName : parentName : dx, dy, sx, sy : stylePrefs");
</source>

Siehe das Tutorial für Details.

==== fw_delbox ====

Löscht eine oder mehrere Textboxen.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_delbox : boxOne : boxTwo : ...");
</source>

Löscht die Textboxen "boxOne", "boxTwo", usw.

==== fw_touchquery ====

Führt eine Anfrage aus, welche Box wo geklickt wurde.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "userData", "fw_touchquery : linkNumber : faceNumber");
</source>

Die Antwort hat die Form (Pseudo-Code):

<source lang="lsl2">
link_message(..., ..., "boxName:dx:dy:rootName:x:y:userData", "fw_touchreply") {
...
}
</source>

Siehe das Tutorial für Details.

==== fw_notify ====

Aktiviere oder deaktiviere Benachrichtigungen per Link Message wenn das Aktualisieren der Anzeige fertig ist. Standardmäßig aus.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "on", "fw_notify");
llMessageLinked(LINK_SET, 0, "off", "fw_notify");
</source>

Wenn die Benachrichtigungen aktiviert sind, sendet das Textskript eine Link Message in welcher "id" auf "fw_done" gesetzt ist wenn alle ausstehendenen Aktualisierungen der Anzeige durchgeführt wurden.

==== fw_memory ====

Teilt dem Besitzer des Objekts mit wie viel Speicher verfügbar ist.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_memory");
</source>

==== fw_reset ====

Setzt das Textskript vollständig zurück.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_reset");
</source>

{{KBtip|Wenn das Zurücksetzen abgeschlossen ist sendet das Skript an alle Prims eine Link Message, in der der "id"-Parameter auf "fw_ready" gesetzt ist. Dadurch weiß man wann das Skript wieder Befehle entgegennehmen kann.}}

{{KBcaution|Setze das Skript nur zurück wenn es nötig ist. Die Initialisierung ist eine relativ aufwendige Operation und das Textskript ist für einen Moment nicht verfügbar.}}

=== Style settings ===

Stil- und Formateinstellungen werden durch spezielle Strings angegeben. Diese werden für globale Einstellungen, Einstellungen pro Box ("fw_conf") und für Einstellungen direkt im Text (inline) verwendet.

Eine einzelne Einstellung wird als '''key=value'''-Paar angegeben, z.B. '''c=red'''.

Mehrere Einstellungen werden durch "''';'''" getrennt, z.B. '''c=red; a=center; w=none'''.

In der folgenden Tabelle: ''Kursiv'' = Standardwert

{|{{Prettytable}}
! Einstellung
! Schlüssel
! Werte
! Beschreibung
|-
| Schriftfarbe
| c
| R,G,B
| Schriftfarbe als Rot, Grün, Blau (jeweils im Bereich 0.0-1.0)
|-
|
|
| R,G,B,A
| Schriftfarbe als Rot, Grün, Blau, Alpha (jeweils im Bereich 0.0-1.0)
|-
|
|
| rand
| Zufällige Farbe (mit Alpha = 1)
|-
|
|
| (vordefiniert)
| Vordefinierte Farbe, siehe Tabelle unten
|-
| Ausrichtung
| a
| ''left''
| Ausrichtung links
|-
|
|
| center
| Ausrichtung zentriert
|-
|
|
| right
| Ausrichtung rechts
|-
| Umbruch
| w
| ''word''
| Möglichst nach Wörtern umbrechen
|-
|
|
| char
| An jeder beliebigen Stelle umbrechen
|-
|
|
| none
| Kein Umbruch; schneidet überlange Zeilen ab
|-
| Trimmen
| t
| ''on''
| Schneidet Leerzeichen von Anfang und Ende jeder Zeile ab
|-
|
|
| off
| Behält Leerzeichen bei (außer bei wrap=word)
|-
| Schriftart
| f
| (UUID/name)
| Setzt die Schrift-Textur auf UUID oder Name
|-
| Rahmen
| border
| {trblTRBL12}
| Stellt den Rahmen von Boxen ein
|-
| Stilvorlage
| style
| (Style name)
| Verwendet einen mit fw_var definierten Stil
|-
| Inline styles
| tags
| ''on''
| Aktiviert die Verwendung von inline styles
|-
|
|
| off
| Deaktiviert die Verwendung von inline styles
|-
| Force refresh
| force
| on
| Aktiviert die erzwungene Aktualierung aller Faces (deaktiviert Optimierungen!)
|-
|
|
| ''off''
| Deaktiviert die erzwungene Aktualisierung alles Faces (ermöglicht Optimierungen)
|}

=== Vordefinierte Farben ===

Du kannst die Folgenden Namen anstelle von vektoriellen Farbangeben in Stilen verwenden.

[[File:FURWARE_text_colors.png]]

=== Schriftarten ===

Die hier angegebenen Schriftarten kannst du mit der "'''f=...'''"-Stilangabe entweder durch Angabe ihrer UUID verwenden oder indem du die zugehörige Textur (diese sind Teil des FURWARE text-Pakets) in dein Objekt legst und dann den Texturnamen benutzt.

[[File:FURWARE_text_fonts.png]]

== Versionsgeschichte ==

'''2.0.1'''

* Fehler behoben, der beim Anzeigen von Zeichen, die nicht in der Textur-Spezifikation enthalten sind, unerwartetes Verhalten verursachen konnte.
* Der Set Pointer einer Box wird jetzt bit-packed zusammen mit dem restlichen Box Status gespeichert. Das verkürzt die Länge eines Strides in boxDataList um 1.
* Nachricht über freien Speicher beim Skript-Start entfernt.
* getNumberOfPrims()-Funktion entfernt.
* Der Test, ob wenigstens ein Set verfügbar ist, wurde an den Anfang des link_message()-Handlers verschoben.

'''2.0'''

* Das Skript wurde unter der MIT-Lizenz als Open Source veröffentlicht.

'''2.0-Beta1'''

* Die Funktionalität von "fw_data" und "fw_conf" wurde überarbeitet um sie (hoffentlich) intuitiver zu machen.
* Mit den Befehlen "fw_data", "fw_conf" und "fw_delbox" können nun auch mehrere Boxen auf einmal modifiziert werden.
* Befehl "fw_defaultconf" hinzugefügt. Momentan für globale Stileinstellungen verwendet.
* Touch replies liefern jetzt auch den Namen der Root-Box und die absoluten Koordinaten.
* Stilattribut "force" hinzugefügt um stets alle Faces zu aktualisieren (nützlich für Schriften in denen das Leerzeichen nicht vollständig transparent ist).
* Optimierte Verarbeitung wenn mehrere "ähnliche" Befehle (z.B. "fw_delbox") schnell hintereinander ankommen.
* Überprüfung hinzugefügt ob das Board überhaupt erfolgreich initialisiert wurde bevor Befehle angenommen werden.

'''2.0-Beta0'''

* Mesh Prims mit bis zu 8 Buchstaben pro Prim, die jeweils 0.5 Prims belegen
* Virtuelle Text-Boxen um Text beliebig zu positionieren
* Style templates zum Speichern von Formatierungseinstellungen

'''1.1'''

* Die Entwicklerversion erlaubt jetzt eine Weitergabe entweder als +copy/-trans oder -copy/+trans

'''1.0.1'''

* Geschwindigkeit verbessert

'''1.0'''

* Erste veröffentlichte Version

FURWARE text/Reference

2015-04-08T08:43:17Z

Ochi Wolfe: Fixed syntax highlighting

{{Multi-lang}}

== Reference manual ==

This chapter is meant to be a quick overview of pretty much everything necessary to use FURWARE text, especially which names and parameters go where. It is '''not''' meant to replace the tutorial in any way.

=== Commands ===

==== fw_data & fw_conf ====

Per-box settings for text (fw_data) and style (fw_conf)

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Some new text", "fw_data : BoxSpec : BoxSpec : BoxSpec : ...");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_conf : BoxSpec : BoxSpec : BoxSpec : ...");
</source>

Each "'''BoxSpec'''" can have different forms to select different boxes. In the following table, let "BoxOne" and "BoxTwo" be two valid box names in the same display set:

{|{{Prettytable}}
! BoxSpec
! Meaning
|-
| (empty)
| All boxes in all sets.
|-
| BoxOne
| Only the box "BoxOne".
|-
| BoxOne ; BoxTwo
| All Boxes between* (and including) "BoxOne" and "BoxTwo".
|-
| BoxOne ;
| "BoxOne" and all following* boxes in the same display set.
|-
| ; BoxTwo
| "BoxTwo" and all preceding* boxes in the same display set.

|}

(*) Depending on the order in which the boxes were added.

==== fw_defaultconf ====

Sets global style preferences

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf : root");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf : nonroot");
</source>

The three variants set the global style preferences for all boxes, all root-boxes and all non-root boxes.

==== fw_var ====

Store some string data in a "variable" name. Currently only used for style templates.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Some string", "fw_var : varName");
</source>

Sets the contents of variable "varName" to "Some string". You can delete variables by passing the empty string as data.

==== fw_addbox ====

Adds a new virtual text box. There can be at most 16 boxes per set (including the root box).

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Some initial text", "fw_addbox : boxName : parentName : dx, dy, sx, sy : stylePrefs");
</source>

Please see the tutorial for details.

==== fw_delbox ====

Deletes one or more text boxes.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_delbox : boxOne : boxTwo : ...");
</source>

Deletes the boxes named "boxOne", "boxTwo", etc.

==== fw_touchquery ====

Performs a query which box has been touched where.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "userData", "fw_touchquery : linkNumber : faceNumber");
</source>

The reply has the form (pseudo code):

<source lang="lsl2">
link_message(..., ..., "boxName:dx:dy:rootName:x:y:userData", "fw_touchreply") {
...
}
</source>

Please see the tutorial for details.

==== fw_notify ====

Enable or disable link message notifications when the script has done rendering. Off by default.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "on", "fw_notify");
llMessageLinked(LINK_SET, 0, "off", "fw_notify");
</source>

When notifications are enabled, the text script will send a link message with "id" set to "fw_done" to the whole linkset to let you know when all pending rendering actions have been completed.

==== fw_memory ====

Tells the owner how much memory is available.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_memory");
</source>

==== fw_reset ====

Performs a full reset on the text script.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_reset");
</source>

{{KBtip|When the reset has completed, the script sends a link message with "id" set to "fw_ready" to all prims in the linkset. This tells you when the script is ready to take further commands.}}

{{KBcaution|Only reset the text script if necessary. Initialization is a quite expensive operation and the script will not be available to take commands for a few seconds.}}

=== Style settings ===

Text styles and format settings are specified using special strings. They are used for global and per-box settings ("fw_conf") as well as for specifying styles directly within the text (inline styles).

A single setting is given as a '''key=value''' pair, for example '''c=red'''.

Multiple settings are separated by "''';'''", for example '''c=red; a=center; w=none'''.

In the following table: ''Italic'' = Default

{|{{Prettytable}}
! Setting
! Key
! Values
! Description
|-
| Font color
| c
| R,G,B
| Font color as red, green, blue (each in range 0.0-1.0)
|-
|
|
| R,G,B,A
| Font color as red, green, blue, alpha (each in range 0.0-1.0)
|-
|
|
| rand
| Random color (with alpha = 1)
|-
|
|
| (predefined)
| Predefined color, see table below
|-
| Alignment
| a
| ''left''
| Alignment left
|-
|
|
| center
| Alignment centered
|-
|
|
| right
| Alignment right
|-
| Wrapping
| w
| ''word''
| Wrap after words, if possible
|-
|
|
| char
| Wrap at any position
|-
|
|
| none
| No wrapping; cuts overlong lines
|-
| Trimming
| t
| ''on''
| Trims whitespace from beginning and end of lines
|-
|
|
| off
| Keeps whitespace (except with wrap=word)
|-
| Font
| f
| (UUID/name)
| Sets the font texture to UUID or name
|-
| Borders
| border
| {trblTRBL12}
| Specifies the style of box borders
|-
| Style template
| style
| (Style name)
| Uses a style defined using fw_var
|-
| Inline styles
| tags
| ''on''
| Enables usage of inline styles
|-
|
|
| off
| Disables usage of inline styles
|-
| Force refresh
| force
| on
| Enables forced refresh of all faces (disables optimizations!)
|-
|
|
| ''off''
| Disables forced refresh of all faces (enables optimizations)
|}

=== Predefined colors ===

You may use the following names in place of color vectors in styles.

[[File:FURWARE_text_colors.png]]

=== Fonts ===

You can use the fonts listed here with the "'''f=...'''" style setting either by using their UUID or by putting the corresponding texture item (included in the FURWARE text package) into your object and then use the texture's name.

[[File:FURWARE_text_fonts.png]]

== Version history ==

'''2.0.1'''

* Fixed an issue where characters that are not part of the font texture specification would cause unexpected behavior.
* A box's set pointer is now stored bit-packed together with the rest of its status. This decreases the length of a stride in boxDataList by 1.
* Removed message about free memory on script startup.
* Removed getNumberOfPrims()-function.
* Moved the check if we have any sets at all to the beginning of the link_message()-handler.

'''2.0'''

* Made the script open source under the MIT license.

'''2.0-Beta1'''

* The functionality of "fw_data" and "fw_conf" has been reworked to (hopefully) make it more intuitive.
* The commands "fw_data", "fw_conf", and "fw_delbox" are now able to modify multiple boxes at once.
* Added "fw_defaultconf" command. Currently used to configure global style settings.
* Touch replies now also contain the name of the root box and the absolute coordinates.
* Added "force" style attribute to force refresh of all faces (useful for fonts where whitespace is not completely transparent).
* Optimized handling when multiple "similar" commands (e.g. "fw_delbox") come in quickly.

'''2.0-Beta0'''

* Mesh prims with up to 8 characters per prim, each occupying 0.5 prims
* Virtual text boxes for aligning text arbitrarily
* Style templates for saving format settings

'''1.1'''

* The developer version now allows distribution of the script as +copy/-trans or -copy/+trans

'''1.0.1'''

* Improved speed

'''1.0'''

* First released version

FURWARE text/Tutorial/de

2015-04-08T08:41:43Z

Ochi Wolfe: Fixed syntax highlighting

{{Multi-lang}}

== Erste Schritte ==

=== Displays erstellen ===

Du kannst (und solltest) den mitgelieferten "'''FURWARE display creator'''" verwenden um automatisch perfekt ausgerichtete Display Prims zu erstellen. Jedes Prim erhält automatisch einen speziellen Objektnamen der vom Textskript verwendet wird um die korrekte Reihenfolge unabhängig von der Link-Reihenfolge feststellen zu können.

Ein Display zu erstellen ist einfach:

* Stelle den Display Creator auf ein Landstück, auf dem du hinreichende Rechte hast.
* Klicke das Creator-Objekt. In dem erscheindenden Dialog kannst du die Parameter des neuen Displays einstellen:
** Einen '''Namen''' für das Display. Dieser wird dazu verwendet um festzulegen, welches Display du ansprechen möchtest wenn du mehrere davon in einem Linkset verwendest.
** Die Anzahl der '''Zeilen und Spalten''' des Displays (die Spalten werden hier in Prims gezählt, nicht in Zeichen).
** Die Anzahl von '''Faces''' (Flächen, entspricht hier der Anzahl von Zeichen) '''pro Prim'''. Es stehen Prims mit 1 bis 8 Faces zur Verfügung. Im Allgemeinen ist es effizienter, mehr Faces pro Prim zu verwenden.
* Wenn du mit den Einstellungen zufrieden bist, klicke "Create" um die Prims zu erstellen. Anschließend kannst du sie geeignet an das Objekt linken auf dem du das Display verwenden möchtest.

=== Einrichtung und Initialisierung ===

Wenn du dein(e) Display(s) erstellt und verlinkt hast, lege '''eine''' Kopie des FURWARE text-Skripts in das Linkset. Es ist nur ein einziges Skript nötig um mehrere Displays im Linkset anzusteuern. Das Skript muss '''nicht''' im Root-Prim liegen.

'''Wichtiger Hinweis:'''

Wahrscheinlich möchtest du dem Textskript einige Befehle senden nachdem es sich selbst initialisiert hat. Ein Reset kann in ein paar Fällen auftreten:

* Das Skript wurde neu in das Objekt hineingelegt.
* Das Objekt, in dem sich das Skript befindet, wurde durch Shift-Drag kopiert.
* Das Linkset hat sich geändert (dann muss das Skript neu nach Display Prims suchen).
* Es wurde manuell zurückgesetzt (etwa per "fw_reset"-Befehl).

Um genau zu wissen wann das Skript bereit ist Befehle zu empfangen, sendet es nach der Initialisierung eine Link Message an das gesamte Linkset, in der der "id"-Parameter auf "fw_ready" gesetzt ist. Es wird '''dringend empfohlen''' nach diesen Link Messages zu lauschen und die eigenen Befehle zur Einrichtung des Textskript erst dann zu senden. Dein Code könnte in etwa so aussehen:

<source lang="lsl2">
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_ready") {
llOwnerSay("FW text is up and running!");

// Sende die ersten Kommandos.
llMessageLinked(sender, 0, "c=red", "fw_conf");
llMessageLinked(sender, 0, "Default text", "fw_data");

// ...
}
}
</source>

== Tutorial ==

=== Vorbereitungen ===

Als erstes werden wir einen Rahmen schaffen mit welchem du die Beispiele in diesem Tutorial ausprobieren kannst. Es ist für den Anfang wahrscheinlich praktisch wenn sich das Textskript nach einer Änderung an deinem eigenen Skript zurücksetzt, sodass sich Einstellungen aus vorigen Experimenten nicht in die Quere kommen. Du kannst folgendes Skript als Ausgangspunkt verwenden:

<source lang="lsl2">
default {
state_entry() {
// Setze das FURWARE text-Skript zurück.
llMessageLinked(LINK_SET, 0, "", "fw_reset");
}

link_message(integer sender, integer num, string str, key id) {
// Das Textskript sendet "fw_ready" wenn es sich initialisiert hat.
if (id == "fw_ready") {
// Hier kannst du deine Kommandos ausprobieren.

}
}
}
</source>

{{KBtip|In diesem Tutorial wird der Einfachheit halber immer an LINK_SET gesendet. Du kannst in deinen Objekten natürlich spezifischere/optimierte Angaben zum Empfänger verwenden.}}

{{KBcaution|Es ist im Allgemeinen '''kein''' guter Stil das Skript jedes Mal zurückzusetzen wenn du irgendwas am Text verändern möchtest. Sobald du dich mit den Konzepten von FURWARE text vertraut gemacht hast wirst du sehen, dass man so gut wie alles machen kann ohne das Skript resetten zu müssen. Es ist lediglich praktischer für die ersten Experimente.}}

=== Einzelnes Display-Set ===

Schauen wir uns zunächst den einfachsten Fall an. Als konkretes Beispiel verwenden wir ein Display bestehend aus 3x4 Prims mit jeweils 8 Faces. Hier eine schematische Darstellung unseres Displays:

[[File:FURWARE_text_single_example_0.png]]

Zunächst die zwei wichtigsten Befehle von FURWARE text: "fw_data" zum Setzen von Text und "fw_conf" zum Einstellen des Textstils (Farbe, Ausrichtung, Schriftart usw.). Der Text wird folgendermaßen gesetzt:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "This is some example text", "fw_data");
</source>

Dies ergibt:

[[File:FURWARE_text_single_example_1.png]]

Auf ähnliche Weise können wir die '''Textfarbe''' (color) auf blau und die '''Ausrichtung''' (alignment) auf zentriert setzen:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=blue; a=center", "fw_conf");
</source>

Kombiniert mit dem vorherigen "fw_data"-Befehl ergibt dies dann:

[[File:FURWARE_text_single_example_2.png]]

{{KBtip|Du musst nicht jedes mal sowohl den Text als auch den Stil setzen wenn du eines von beidem ändern möchtest. Wenn du den Stil einstellst wird der gerade gesetzte Text wiederverwendet und mit dem neuen Stil dargestellt. Ebenso wird der aktuelle Stil verwendet wenn du neuen Text einstellst.}}

=== Mehrere Display-Sets ===

Ein einzelnes FURWARE text-Skript kann mehrere Display Sets in einem Linkset ansteuern. Das folgende Beispiel besteht aus drei Sets mit den Namen "Alpha", "Beta" und "Gamma":

[[File:FURWARE_text_multi_example_0.png]]

{{KBtip|Die Prims der einzelnen Sets müssen nicht denselben Prim-Typ haben (also Faces pro Prim). Allerdings müssen '''innerhalb''' eines Sets die Prim-Typen identisch und die Anzahl der Spalten in allen Zeilen gleich sein.}}

Wenn wir nun dieselben zwei Code-Zeilen wie im Fall des einzelnen Sets verwenden, werden '''alle Sets dieselben Einstellungen''' verwenden. Somit ergibt der Code

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "This is some example text", "fw_data");
llMessageLinked(LINK_SET, 0, "c=blue; a=center", "fw_conf");
</source>

folgendes:

[[File:FURWARE_text_multi_example_1.png]]

Nun stellt sich natürlich die Frage wie man die Sets '''einzeln''' anspricht. An dieser Stelle kommen die '''Namen''' ins Spiel, die wir bei der Display-Erstellung vergeben haben. Der letzte Parameter des llMessageLinked()-Befehls muss abgeändert werden. Um beispielsweise den Text und Stil von Set "Beta" zu ändern ergänzen wir "fw_data" und "fw_conf" jetzt um eine Angabe des Namens des Sets in der Form "'''fw_data : Beta'''" und "'''fw_conf : Beta'''":

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Only for set Beta", "fw_data : Beta");
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Beta");
</source>

Wenn wir dies wieder mit dem vorherigen Code verbinden, dann erhalten wir:

[[File:FURWARE_text_multi_example_2.png]]

=== Virtuelle Textboxen ===

Zusätzlich zur Verwendung von mehreren Sets können wir auch virtuelle '''Textboxen''' innerhalb eines Sets erstellen. Diese können dazu verwendet werden um auf einfache Weise Text zu positionieren, beispielsweise um '''Tabellen''', '''Dialoge''' und mehr zu realisieren.

Im folgenden Beispiel haben wir zwei Sets "Dialog" und "Table". Das Set "Dialog" wollen wir als einen einfachen Dialog mit zwei Knöpfen verwenden und das Set "Table" als eine Tabelle mit drei Zeilen, drei Spalten und noch eine zusätzliche Spalte für "up"- und "down"-Knöpfe.

Die kleine Überlappung (Overlap) zwischen den Spalten der Tabelle wird später nützlich sein wenn wir Rahmen zu den Boxen hinzufügen.

[[File:FURWARE_text_boxes_example_0.png]]

Die erste Aufgabe ist das '''Hinzufügen''' der Textboxen. Dies wird mit dem "fw_addbox"-Kommando erledigt. Die Syntax ist wie folgt:

''fw_addbox : boxName : parentName : dx, dy, sx, sy : stylePrefs''

Die einzelnen Parameter haben folgende Bedeutung:

* '''boxName''': Ein beliebiger Name für die Box. Muss '''eindeutig''' unter allen Box- und Set-Namen sein.
* '''parentName''': Der Name eines '''Sets oder einer Box''' zu dem oder der diese Box relativ positioniert werden soll.
* '''dx, dy, sx, sy''': Vier Ganzzahlen, die die '''Position''' der neuen Box relativ zum Parent (dx, dy) und die '''Größe''' der neuen Box (sx, sy) angeben.
* '''stylePrefs''': Die Angabe des Schriftstils (z.B. "c=red; a=center") den die neue Box standardmäßig verwenden soll; kann weggelassen werden.

Schreiben wir den Code zum Hinzufügen der Boxen auf. Wir werden dies zunächst ziemlich '''ausführlich''' machen und später eine kürzere Version anschauen.

<source lang="lsl2">
// Add the boxes.
llMessageLinked(LINK_SET, 0, "", "fw_addbox : ButtonOK : Dialog : 1, 2, 10, 1");
llMessageLinked(LINK_SET, 0, "", "fw_addbox : ButtonCancel : Dialog : 13, 2, 10, 1");

llMessageLinked(LINK_SET, 0, "", "fw_addbox : Column0 : Table : 0, 1, 8, 3");
llMessageLinked(LINK_SET, 0, "", "fw_addbox : Column1 : Column0 : 7, 0, 8, 3");
llMessageLinked(LINK_SET, 0, "", "fw_addbox : Column2 : Column1 : 7, 0, 8, 3");
llMessageLinked(LINK_SET, 0, "", "fw_addbox : UpDown : Column2 : 9, 0, 1, 3");

// Set the boxes' style.
llMessageLinked(LINK_SET, 0, "a=center", "fw_conf : ButtonOK");
llMessageLinked(LINK_SET, 0, "a=center", "fw_conf : ButtonCancel");

llMessageLinked(LINK_SET, 0, "w=none", "fw_conf : Column0");
llMessageLinked(LINK_SET, 0, "w=none", "fw_conf : Column1");
llMessageLinked(LINK_SET, 0, "w=none", "fw_conf : Column2");

// Set some text for the boxes.
llMessageLinked(LINK_SET, 0, "Some dialog", "fw_data : Dialog");
llMessageLinked(LINK_SET, 0, "OK", "fw_data : ButtonOK");
llMessageLinked(LINK_SET, 0, "Cancel", "fw_data : ButtonCancel");

llMessageLinked(LINK_SET, 0, "One\nTwo\nThree", "fw_data : Column0");
llMessageLinked(LINK_SET, 0, "123\n456\n789", "fw_data : Column1");
llMessageLinked(LINK_SET, 0, "1.2\n2.3\n3.4", "fw_data : Column2");
llMessageLinked(LINK_SET, 0, "▲\n\n▼", "fw_data : UpDown");
</source>

Dies liefert das folgende Ergebnis.

[[File:FURWARE_text_boxes_example_1.png]]

Bitte nimm dir einen Moment um alle Teile der Befehle zu verstehen.

Die ersten beiden Boxen wurden zu der Parent-Box "Dialog" hinzugefügt, also lautet der dritte Parameter von "fw_addbox" gerade "Dialog". Du kannst auch den Namen einer '''anderen Box''' als Parent angeben, dann sind die Positionsangaben '''relativ''' zu dem angegebenen Parent. Beispielsweise haben wir für den Parent von "Column1" die Box "Column0" verwendet und die Koordinaten relativ zu der oberen linken Ecke der Box angegeben. Das gleiche haben wir für die Boxen "Column2" und "UpDown" gemacht.

Nachdem die Boxen erstellt wurden haben wir einige Stileinstellungen vorgenommen. So haben wir die '''Ausrichtung''' der Dialog-Knöpfe auf zentriert eingestellt ("a=center") und den '''Textumbruch''' für die Tabellenspalten deaktiviert ("w=none"), sodass auch überlange Zeilen immer innerhalb einer Tabellenzeile bleiben.

Schließlich haben wir noch den Text der Boxen gesetzt.

==== Eine etwas knappere Variante ====

Wie bereits erwähnt können wir das vorhergegangene Beispiel auch etwas kürzer schreiben, indem wir den Stil und Text '''direkt beim Erstellen der Boxen''' angeben. Der folgende Code liefert das gleiche Ergebnis wie zuvor:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "OK", "fw_addbox : ButtonOK : Dialog : 1, 2, 10, 1 : a=center");
llMessageLinked(LINK_SET, 0, "Cancel", "fw_addbox : ButtonCancel : Dialog : 13, 2, 10, 1 : a=center");

llMessageLinked(LINK_SET, 0, "One\nTwo\nThree", "fw_addbox : Column0 : Table : 0, 1, 8, 3 : w=none");
llMessageLinked(LINK_SET, 0, "123\n456\n789", "fw_addbox : Column1 : Column0 : 7, 0, 8, 3 : w=none");
llMessageLinked(LINK_SET, 0, "1.2\n2.3\n3.4", "fw_addbox : Column2 : Column1 : 7, 0, 8, 3 : w=none");
llMessageLinked(LINK_SET, 0, "▲\n\n▼", "fw_addbox : UpDown : Column2 : 9, 0, 1, 3");

llMessageLinked(LINK_SET, 0, "Some dialog", "fw_data : Dialog");
</source>

==== Box-Rahmen ====

FURWARE text bietet eine besondere Stil-Option die vor allem für Boxen nützlich ist: Die '''border'''-Einstellung. Wahrscheinlich sagt hier ein Beispiel mehr als tausend Worte. Schauen wir uns deshalb folgende Abänderung des letzten Beispiels an:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "OK", "fw_addbox : ButtonOK : Dialog : 1, 2, 10, 1 : a=center; border=lr");
llMessageLinked(LINK_SET, 0, "Cancel", "fw_addbox : ButtonCancel : Dialog : 13, 2, 10, 1 : a=center; border=lr");

llMessageLinked(LINK_SET, 0, "One\nTwo\nThree", "fw_addbox : Column0 : Table : 0, 1, 8, 3 : w=none; border=lr");
llMessageLinked(LINK_SET, 0, "123\n456\n789", "fw_addbox : Column1 : Column0 : 7, 0, 8, 3 : w=none; border=lr");
llMessageLinked(LINK_SET, 0, "1.2\n2.3\n3.4", "fw_addbox : Column2 : Column1 : 7, 0, 8, 3 : w=none; border=lr");
llMessageLinked(LINK_SET, 0, "▲\n\n▼", "fw_addbox : UpDown : Column2 : 9, 0, 1, 3");

llMessageLinked(LINK_SET, 0, "Some dialog", "fw_data : Dialog");
llMessageLinked(LINK_SET, 0, "border=lrtb", "fw_conf : Dialog");
</source>

Im folgenden Bild wurden die Unterteilungen zwischen den einzelnen Faces weggelassen damit man die hinzugekommenen Rahmen besser sehen kann. Beachte wie das Textskript die Textposition automatisch an die Rahmen anpasst:

[[File:FURWARE_text_boxes_example_2.png]]

Die "border"-Einstellung akzeptiert als Wert '''jede (sinnvolle) Kombination''' der Zeichen '''tblrTBLR12''' (die Reihenfolge ist egal). Die Kleinbuchstaben t, b, l, r fügen Rahmen am oberen (top), unteren (bottom), linken (left) und rechten (right) Rand ein. Die Großbuchstaben T, B, L, R fügen zusätzlich spezielle Symbole an den Ecken der Boxen ein um diese mit weiteren Boxen verbinden zu können (siehe auch nächstes Bild). Die Zahlen "1" oder "2" wählen andere Stile für die Rahmen aus. Hier ein paar Beispiele:

[[File:FURWARE_text_boxes_example_3.png]]

Jetzt sollte auch klar sein wieso die zuvor erwähnte Überlappung zwischen den Tabellenspalten nützlich ist: Auf diese Weise können wir für '''alle''' Tabellenspalten einfach einen linken und rechten Rand angeben ohne unterscheiden zu müssen.

{{KBtip|Der zum Zeichnen der Rahmen zusätzlich benötigte Platz muss manuell zu den jeweiligen Box-Größen hinzuaddiert werden.}}

==== Boxen löschen ====

Das Entfernen einer Box wird mittels des "fw_delbox"-Befehls erledigt. Beispielsweise löscht der folgende Code die Knöpfe des Dialogs:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_delbox : ButtonOK");
llMessageLinked(LINK_SET, 0, "", "fw_delbox : ButtonCancel");
</source>

Es können auch mehrere Boxen auf einmal gelöscht werden. Folgender Code liefert dasselbe Ergebnis:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_delbox : ButtonOK : ButtonCancel");
</source>

{{KBcaution|Die "Basis"-Boxen der Display-Sets können nicht entfernt werden (in diesem Beispiel "Dialog" und "Table").}}

=== Klick-Abfragen (Touch Queries) ===

Das Beispiel aus dem letzten Abschnitt enthält einige Stellen auf den Boxen, die von dem Benutzer angeklickt werden können sollten, nämlich die Knöpfe des "Dialogs" und die "up"-/"down"-Knöpfe auf der Rechten Seite der Tabelle.

Mit einem speziellen Befehl kann vom FURWARE text-Skript erfragt werden, '''welche Box''' an '''welchen Koordinaten''' geklickt wurde. Das Skript rechnet dabei automatisch die Koordinaten relativ zur oberen linken Ecke der Box um und beachtet die Reihenfolge und etwaige Überlappungen zwischen Boxen.

==== Senden der Anfrage ====

Betrachten wir einen möglichen touch_start()-Handler in unserem Skript, der einen "fw_touchquery"-Befehl an das Textskript sendet:

<source lang="lsl2">
touch_start(integer numDetected) {
string link = (string)llDetectedLinkNumber(0);
string face = (string)llDetectedTouchFace(0);
llMessageLinked(LINK_SET, 0, "Some user data", "fw_touchquery:" + link + ":" + face);
}
</source>

Wie man sehen kann, enthält der letzte Parameter von llMessageLinked() den "fw_touchquery"-Befehl gefolgt von der Link-Nummer und Face-Nummer, die geklickt wurden. Diese Werte sind durch ":" getrennt.

Du kannst außerdem einen '''beliebigen String''' als dritten Parameter von llMessageLinked() übergeben; in diesem Beispiel ist dies "Some user data". Dieser String wird bei einer Antwort vom Textskript unverändert an dein Skript zurückgegeben. Auf diese Weise kannst du Anfragen den entsprechenden Antworten zuordnen.

==== Verarbeiten der Antwort ====

Das FURWARE text Skript antwortet '''immer''' auf eine solche Anfrage, auch wenn die Angaben keinen Sinn machen (etwa wenn das geklickte Prim gar nicht zu einem Display gehört).

Der "id"-Parameter des "link_message()"-Handlers enthält immer genau den String "fw_touchreply", sodass du die Antworten einfach aus sonstigen Link Messages filtern kannst.

Der "str"-Parameter enthält die ":"-separierte Antwort auf die Anfrage. Diese hat die Form

''boxName:dx:dy:rootName:x:y:userData''

Die einzelnen Teile sind dabei:

* '''boxName''' ist der Name der Box, die geklickt wurde.
* '''dx''' ist die Spalte des Klicks (gezählt in Zeichen) relativ zur linken Seite der Box.
* '''dy''' ist die Zeile des Klicks relativ zur oberen Seite.
* '''rootName''' ist der Name der Basis-Box des Display-Sets, in dem sich die Box befindet.
* '''x''' ist die Spalte des Klicks (gezählt in Zeichen) relativ zur linken Seite des Display-Sets.
* '''y''' ist die Zeile des Klicks relativ zur oberen Seite des Display-Sets.
* '''userData''' ist der String, der in der Anfrage als dritter Parameter von "llMessageLinked()" übergeben wurde.

{{KBtip|Alle Felder bis auf "userData" sind leer wenn die Anfrage ungültig war (z.b. wenn das übergebene Prim nicht zu einem Display gehört).}}

Hier ein Beispiel wie wir die Antwort in unserem Beispiel verarbeiten könnten:

<source lang="lsl2">
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_touchreply") {
list tokens = llParseStringKeepNulls(str, [":"], []);
string boxName = llList2String(tokens, 0);
integer dx = llList2Integer(tokens, 1);
integer dy = llList2Integer(tokens, 2);
string rootName = llList2String(tokens, 3);
integer x = llList2Integer(tokens, 4);
integer y = llList2Integer(tokens, 5);
string userData = llList2String(tokens, 6);

if (boxName == "ButtonOK") {
llOwnerSay("OK button was clicked.");
} else if (boxName == "ButtonCancel") {
llOwnerSay("Cancel button was clicked.");
} else if (boxName == "UpDown") {
// Wir benutzen die Y-Koordinate um festzustellen ob "hoch" oder "runter" geklickt wurde.
if (dy == 0) {
llOwnerSay("Up button was clicked.");
} else if (dy == 2) {
llOwnerSay("Down button was clicked.");
}
}
}
}
</source>

=== Stilvorlagen (Style Templates) ===

Machen wir die Knöpfe unseres Dialogs ein wenig interessanter. Wir können ihnen beispielsweise eine andere Schriftart und -farbe geben (zusätzlich zu den Rahmen auf der linken und rechten Seite sowie der zentrierten Ausrichtung). Wir '''könnten''' natürlich etwas schreiben wie:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "border=lr; a=center; c=darkgreen; f=5054fec3-1465-af8f-2fe5-e9507795c82a", "fw_conf : ButtonOK");
llMessageLinked(LINK_SET, 0, "border=lr; a=center; c=darkgreen; f=5054fec3-1465-af8f-2fe5-e9507795c82a", "fw_conf : ButtonCancel");
</source>

Das mag für dieses kleine Beispiel noch in Ordnung sein; es wirkt trotzdem etwas redundant. Wenn du mehrere Boxen oder Textpassagen hast bei denen du Stile mehrfach verwenden möchtest, dann ist es möglicherweise effizienter '''Vorlagen''' (Templates) zu verwenden.

FURWARE text erlaubt das Speichern von Strings in "Variablen", denen man einen Namen zuweisen kann. Momentan werden diese nur für die Stilvorlagen verwendet. Stecken wir also den oben angegebenen Stil in eine Variable mittels des "fw_var"-Befehls und geben der Variable den Namen "button":

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "border=lr; a=center; c=darkgreen; f=5054fec3-1465-af8f-2fe5-e9507795c82a", "fw_var : button");
</source>

Wir können diese Variable nun mittels der Syntax '''style=...''' in unserer Stildefinition verwenden. Schreiben wir die beiden "fw_conf"-Zeilen also um:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "style=button", "fw_conf : ButtonOK");
llMessageLinked(LINK_SET, 0, "style=button", "fw_conf : ButtonCancel");
</source>

Unser Dialog sieht dann folgendermaßen aus:

[[File:FURWARE_text_tmpl_example_0.png]]

Du kannst die Vorlagen sogar mit anderen Stileinstellungen kombinieren (sogar mit anderen Templates). Wenn wir beispielsweise den "Cancel"-Knopf dunkelrot machen wollen aber die übrigen Einstellungen des "button"-Templates beibehalten, so können wir schreiben:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "style=button; c=darkred", "fw_conf : ButtonCancel");
</source>

{{KBtip|Du kannst "fw_var" auch dazu verwenden um den Inhalt einer Variablen zu '''ändern'''. Wird als Inhalt der leere String übergeben, so '''löscht''' das die Variable. Beachte, dass das Ändern einer vorhandenen Variablen ein '''vollständiges Aktualisieren''' der Anzeige nach sich zieht, da das Skript nicht weiß, welche Teile der Anzeige von der Änderung betroffen sein könnten.}}

{{KBcaution|Stilvorlagen erlauben Rekursion (d.h. die Verwendung von Stilvorlagen innerhalb einer anderen Stilvorlage). Das Textskript prüft '''nicht''' auf unendliche Rekursion!}}

=== Mehrere Boxen auf einmal konfigurieren ===

Manchmal möchtest du vielleicht denselben Text oder Stil für mehrere Boxen auf einmal setzen. Betrachten wir als Beispiel ein "Spiel-Board" mit 9 separaten Boxen für die "X" und "O"-Zellen:

[[File:FURWARE_text_range_example_0.png]]

Nehmen wir nun an, dass wir die mittlere Zeile folgendermaßen hervorheben möchten:

[[File:FURWARE_text_range_example_1.png]]

Um das zu erreichen '''könnten''' wir natürlich folgendes schreiben:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Cell3");
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Cell4");
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Cell5");
</source>

Allerdings benötigt dies offensichtlich drei Link Messages. FURWARE text bietet eine spezielle Syntax der "fw_data"- und "fw_conf"-Befehle um den Text oder Stil von mehreren Boxen '''auf einmal''' einzustellen. Eine Möglichkeit in unserem Beispiel ist die Angabe aller Boxen, die konfiguriert werden sollen:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Cell3 : Cell4 : Cell5");
</source>

Wenn wir annehmen, dass die Boxen in der Reihenfolge "Cell0", "Cell1", etc. zum Board hinzugefügt wurden, dann können wir den Befehl sogar noch kürzer schreiben. Wir können '''Intervalle''' von Boxen in der folgenden Schreibweise angeben (beachte das Semikolon (";") zwischen den Box-Namen!):

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Cell3 ; Cell5");
</source>

Nehmen wir nun an, dass wir das Spiel "zurücksetzen" möchten, sodass alle Felder "?" anzeigen:

[[File:FURWARE_text_range_example_2.png]]

Dafür müssen wir die Farbe und den Text aller Felder zurücksetzen. Wir können hierfür die Intervall-Notation für "fw_conf" und "fw_data" verwenden:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_conf : Cell0 ; Cell8");
llMessageLinked(LINK_SET, 0, "?", "fw_data : Cell0 ; Cell8");
</source>

In dem vorliegenden Beispiel können wir sogar ein Ende des Intervalls weglassen: Da "Cell8" die letzte Box im Display-Set ist können wir ihren Namen weglassen und schreiben:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_conf : Cell0 ;");
llMessageLinked(LINK_SET, 0, "?", "fw_data : Cell0 ;");
</source>

Dies bedeutet "wende den Befehl auf Cell0 '''und alle folgenden Boxen''' im selben Display-Set an".

Die Intervall- und Einzel-Box-Schreibweisen können sogar gemischt verwendet werden. Betrachte den folgenden Code (die zusätzlichen Leerzeichen dienen nur der Übersichtlichkeit und können natürlich weggelassen werden):

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "!", "fw_data : Cell1;Cell3 : Cell5 : Cell7; ");
</source>

Angewendet auf das obige Beispiel-Board ergibt dies:

[[File:FURWARE_text_range_example_3.png]]

{{KBtip|Siehe auch die Referenz für eine vollständige Übersicht aller möglichen Parameter-Notationen.}}

=== Globale Stilvoreinstellungen ===

Einige Stileinstellungen können einen "globalen" Charakter haben. Beispielsweise möchtest du vielleicht eine bestimmte Schriftart für '''alle''' Boxen verwenden und diese schnell ändern können.

Im letzten Abschnitt haben wir bereits eine Möglichkeit gesehen wie wir mehreren Boxen einen Stil geben und diesen später zentral ändern können (nämlich indem wir die zugehörige Variable mittels "fw_var" ändern). Der '''Nachteil''' dieser Methode ist, dass das "style=..." für jede Box separat angegeben werden muss und wir daran denken müssen es wieder hinzuschreiben wenn wir andere Einstellungen einer Box ändern mittels "fw_conf".

Für solche Fälle bietet das Skript den Befehl "'''fw_defaultconf'''". Mit diesem Befehl kannst du globale Stileinstellungen für '''alle Boxen''', '''alle Root-Boxen''' (d.h. alle "Basis"-Boxen der Display-Sets) und '''alle Nicht-Root-Boxen''' vornehmen.

Momentan existieren drei Varianten dieses Befehls um die oben genannten Voreinstellungen vorzunehmen. Hier einige Beispiele für die Verwendung (beachte die verschiedenen Argumente des "fw_defaultconf:..."-Befehls):

<source lang="lsl2">
// Setzt die Voreinstellung für alle Boxen auf rot, zentriert.
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf");

// Setzt die Voreinstellung für alle ROOT-Boxen auf grün, kein Wrapping.
llMessageLinked(LINK_SET, 0, "c=green; w=none", "fw_defaultconf : root");

// Setzt die Voreinstellung für alle NICHT-ROOT-Boxen auf "kein Trimming".
llMessageLinked(LINK_SET, 0, "t=off", "fw_defaultconf : nonroot");
</source>

=== Stilangaben im Text (Inline Styles) ===

Bisher haben wir Stileinstellungen global und pro Box vorgenommen. FURWARE text unterstützt eine weitere Stufe dieser Einstellungen: Stileinstellungen, die '''direkt im Text''' vorgenommen werden. Dies Erlaubt ein Überschreiben der aktuellen Einstellungen für einzelne Textpassagen, beispielsweise um einzelne Wörter hervorzuheben oder einzelne Zeilen auszurichten.

So eine Einstellung wird von "'''<!'''" eingeleitet (beachte das Ausrufezeichen) und von "'''>'''" beendet. Innerhalb dieser Begrenzer kannst du Angaben über den Textstil machen. Machen wir beispielsweise den Text unseres Dialogs zentriert, weisen einem Wort eine zufällige Farbe zu und ändern die Schriftart teilweise:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "<!a=center>Some <!c=rand; f=5054fec3-1465-af8f-2fe5-e9507795c82a>fancy<!c=def> dialog", "fw_data : Dialog");
</source>

Das Ergebnis sieht dann in etwa so aus (die Farbe ist natürlich bei jeder Aktualisierung zufällig):

[[File:FURWARE_text_inline_example_0.png]]

Schau' dir den Code genau an: Wir haben die spezielle Einstellung "'''c=def'''" verwendet um die '''normale Farbe''' der Box nach dem Wort "fancy" wiederherzustellen, allerdings haben wir '''die Schriftart nicht zurückgesetzt'''. Das bedeutet, dass die Schriftart für den Rest des Texts geändert bleibt. Du kannst den speziellen Wert "'''def'''" für alle Einstellungen (Farbe, Schriftart, Ausrichtung, etc.) verwenden um die Standardeinstellung der Box wiederherzustellen.

{{KBtip|Du kannst Stilvorlagen auch direkt im Text mittels dem "style"-Befehl verwenden.}}

{{KBcaution|Die "border"-Einstellung im Fließtext zu verwenden hat keinen Effekt.}}

{{KBcaution|Ausrichtung, Trimmen und Umbruch dürfen nur direkt '''am Anfang einer neuen Zeile''' (d.h. auch direkt nach jedem "\n") verwendet werden und haben dann Auswirkung auf diese und folgende Zeilen.}}

==== Inline Styles selektiv deaktivieren ====

Unter Umständen möchtest du Stilangaben im Text für bestimmte Teile deines Displays deaktivieren, beispielsweise bei der Darstellung von Benutzereingaben wo ein "<!" nicht als der Anfang von Stilangaben interpretiert werden soll.

Kurioserweise ist der Befehl dafür selbst eine Stileinstellung, nämlich "'''tags=off'''". Nachdem diese Angabe verarbeitet wurde werden keine weiteren "<!" mehr interpretiert. Beispielsweise deaktiviert der folgende Befehl Stilangaben im Text unseres "Dialogs":

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "border=tblr; tags=off", "fw_conf : Dialog");
</source>

Du kannst diese Einstellung sogar "inline" verwenden, aber nur am Anfang von Zeilen (genauso wie bei Ausrichtung usw.). Dann werden Angaben für den Rest der Zeile und '''alle''' weiteren Zeilen ignoriert (es gibt dann ja keine Möglichkeit mehr, die Stilangaben innerhalb der Zeile wieder zu aktivieren).

FURWARE text/Tutorial

2015-04-08T08:37:25Z

Ochi Wolfe: Fixed syntax highlighting

{{Multi-lang}}

== First steps ==

=== Creating displays ===

You may (and should) use the included "'''FURWARE display creator'''" to have a perfectly aligned grid of display prims automatically created for you. Every prim will be automatically assigned a special object name that is used internally by the text script so that it knows how to order them correctly, independently of the link order.

Creating a display is simple:

* Rez the display creator on a parcel where you have sufficient permissions.
* Touch the creator object. A dialog appears where you can set some parameters of the new display:
** A '''name''' for the display. You will use this name to identify which display you wish to manipulate when using multiple displays within one linkset.
** The number of '''rows and columns''' of the display (the columns are counted in prims here, not in characters).
** The number of '''faces per prim'''. There are mesh prims from 1 to 8 faces available. Generally speaking, using more faces per prim is more efficient.
* When you're happy with the settings, click "Create" to start rezzing the prims. Link them to your creation as appropriate.

=== Setup and initialization ===

When you have created your display(s) and linked them together in your creation, simply put '''a single copy''' of the FURWARE text script into the linkset. Only a single copy of the text script is required for handling multiple display sets within a linkset. The script does '''not''' have to be in the root prim.

'''Important hint:'''

You may wish to send some initial commands to the text script as soon as its initialization is done. A reset of the text script may happen in a number of cases:

* The script was just put into the object.
* The object in which the script resides was shift-copied.
* The linkset has changed (then the script needs to search for display prims again).
* The script was reset manually (for instance using the "fw_reset" command).

In order to know when exactly the script is ready to take commands, it sends a link message to the whole set with the "id" parameter set to "fw_ready". It is '''good practice''' to watch for these messages and send your initialization commands when receiving this message. Your code could look something like this:

<source lang="lsl2">
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_ready") {
llOwnerSay("FW text is up and running!");

// Start sending some initialization stuff.
llMessageLinked(sender, 0, "c=red", "fw_conf");
llMessageLinked(sender, 0, "Default text", "fw_data");

// ...
}
}
</source>

== Tutorial ==

=== Preparations ===

Let's first prepare a small framework that you can use to try out the examples in this tutorial. It may be convenient to reset the FURWARE text script each time you make changes to the controller script to start with a freshly initialized script so that settings made in previous runs won't interfere. You can use the following snippet as a starting point:

<source lang="lsl2">
default {
state_entry() {
// Reset the FURWARE text script.
llMessageLinked(LINK_SET, 0, "", "fw_reset");
}

link_message(integer sender, integer num, string str, key id) {
// The text script sends "fw_ready" when it has initialized itself.
if (id == "fw_ready") {
// Here you can try out your commands.

}
}
}
</source>

{{KBtip|For the sake of simplicity, all commands shown in this tutorial will be sent to LINK_SET. You can of course use more specific/optimized receivers in your own objects.}}

{{KBcaution|It is usually '''not''' considered good practice to reset the script each time you wish to change something. Once you get more familiar with the concepts of FURWARE text you will see that you can do almost anything without ever having to fully reset the script. It is just more convenient for your first experiments.}}

=== Single display set ===

Let's first consider the simplest case. As a concrete example, let's assume that we have created a display consisting of 3 by 4 prims, each of them having 8 faces. Here's a schematic representation of our display:

[[File:FURWARE_text_single_example_0.png]]

We first take look at the two most important commands of FURWARE text, namely "fw_data" for setting text and "fw_conf" to control style preferences (text color, alignment, font, etc.). Setting the text is done like so:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "This is some example text", "fw_data");
</source>

This will yield:

[[File:FURWARE_text_single_example_1.png]]

Similarly, setting the text '''color''' to blue and the '''alignment''' to centered is done using the following call:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=blue; a=center", "fw_conf");
</source>

Combined with the previous "fw_data" call, the display now looks like this:

[[File:FURWARE_text_single_example_2.png]]

{{KBtip|You do not have to send both style and text data each time you wish to change one or the other. When setting the style, the currently set text is re-used and rendered with the new style. Likewise, when setting text, the currently set style will be used.}}

=== Multiple display sets ===

A single FURWARE text script can handle multiple display sets within a linkset. Let's consider the following example consisting of three sets named "Alpha", "Beta" and "Gamma":

[[File:FURWARE_text_multi_example_0.png]]

{{KBtip|The sets do not have to use the same prim type (i.e. number of faces per prim) but '''within''' a particular set, the prim type and the number of columns in each row need to be the same.}}

If we use the same two lines of code for setting the text and style as in the single-set case, '''all sets''' will use the '''same''' settings. So using the code

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "This is some example text", "fw_data");
llMessageLinked(LINK_SET, 0, "c=blue; a=center", "fw_conf");
</source>

will yield

[[File:FURWARE_text_multi_example_1.png]]

Now the question arises how to set text and styles for the '''individual''' sets independently. This is where the '''names''' of the display sets that we have specified when we created the displays come into play. The last parameter of the llMessageLinked()-call needs to be modified. For instance, for setting the text and style of the set "Beta", instead of writing "fw_data" and "fw_conf" we specify the set name by writing "'''fw_data : Beta'''" and "'''fw_conf : Beta'''":

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Only for set Beta", "fw_data : Beta");
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Beta");
</source>

Again combining these lines with the previous code, this will yield:

[[File:FURWARE_text_multi_example_2.png]]

=== Virtual text boxes ===

In addition to using multiple sets, we can also define multiple virtual '''text boxes''' within a display set. This can be used to easily position text on a display, for example for displaying '''tables''', '''dialog boxes''' and much more.

In the following example we have two sets called "Dialog" and "Table". Let's assume that we wish to use the set "Dialog" as a simple dialog with two buttons and the set "Table" as a small table having three rows, three columns and an additional column that will be used for "up" and "down" buttons.

The small overlap between the column boxes will be useful later when adding borders to our boxes.

[[File:FURWARE_text_boxes_example_0.png]]

The first task is to '''add''' the text boxes to the sets. This is done using the "fw_addbox" command. The syntax of the command is:

''fw_addbox : boxName : parentName : dx, dy, sx, sy : stylePrefs''

The meaning of the individual parameters is as follows:

* '''boxName''': A user-specified name for the new box. Must be '''unique''' among all box and set names.
* '''parentName''': The name of the '''set or box''' that the new box should be aligned relatively to.
* '''dx, dy, sx, sy''': Four integers specifying the '''position''' relative to the parent set or box (dx, dy) and the '''size''' of the box (sx, sy).
* '''stylePrefs''': A style string (for example "c=red; a=center") that the box should use as its default; may be omitted.

Let us write down the code for adding the boxes in our example. We will first make it rather '''verbose''' and take a look at a shorter version later.

<source lang="lsl2">
// Add the boxes.
llMessageLinked(LINK_SET, 0, "", "fw_addbox : ButtonOK : Dialog : 1, 2, 10, 1");
llMessageLinked(LINK_SET, 0, "", "fw_addbox : ButtonCancel : Dialog : 13, 2, 10, 1");

llMessageLinked(LINK_SET, 0, "", "fw_addbox : Column0 : Table : 0, 1, 8, 3");
llMessageLinked(LINK_SET, 0, "", "fw_addbox : Column1 : Column0 : 7, 0, 8, 3");
llMessageLinked(LINK_SET, 0, "", "fw_addbox : Column2 : Column1 : 7, 0, 8, 3");
llMessageLinked(LINK_SET, 0, "", "fw_addbox : UpDown : Column2 : 9, 0, 1, 3");

// Set the boxes' style.
llMessageLinked(LINK_SET, 0, "a=center", "fw_conf : ButtonOK");
llMessageLinked(LINK_SET, 0, "a=center", "fw_conf : ButtonCancel");

llMessageLinked(LINK_SET, 0, "w=none", "fw_conf : Column0");
llMessageLinked(LINK_SET, 0, "w=none", "fw_conf : Column1");
llMessageLinked(LINK_SET, 0, "w=none", "fw_conf : Column2");

// Set some text for the boxes.
llMessageLinked(LINK_SET, 0, "Some dialog", "fw_data : Dialog");
llMessageLinked(LINK_SET, 0, "OK", "fw_data : ButtonOK");
llMessageLinked(LINK_SET, 0, "Cancel", "fw_data : ButtonCancel");

llMessageLinked(LINK_SET, 0, "One\nTwo\nThree", "fw_data : Column0");
llMessageLinked(LINK_SET, 0, "123\n456\n789", "fw_data : Column1");
llMessageLinked(LINK_SET, 0, "1.2\n2.3\n3.4", "fw_data : Column2");
llMessageLinked(LINK_SET, 0, "▲\n\n▼", "fw_data : UpDown");
</source>

This will yield a constellation as depicted below.

[[File:FURWARE_text_boxes_example_1.png]]

Please take a moment to understand all parts of the commands.

The first two boxes were added to the parent "Dialog" which is the name of the left set, hence the "Dialog" as the third parameter to "fw_addbox". You may also specify the name of '''another box''' as the parent, then the coordinates of the new box will be '''relative''' to the upper-left corner of that (already added) box. For instance, for box "Column1" we have used "Column0" as the parent box and then specified the coordinates relative to the upper-left corner of that box. The same was done for the boxes "Column2" and "UpDown".

After the boxes have been created, we have set some style preferences for them. For instance, we have set the '''alignment''' of the dialog buttons to center ("a=center") and '''disabled wrapping''' ("w=none") for the table's columns so that even overlong lines will always stay within one row of our table.

Lastly, we have set some text for each of the boxes.

==== A more concise version ====

As mentioned before, we can write the above example in a more concise way by directly specifying style and text data '''when creating the boxes'''. The following code results in the same constellation as in the last example:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "OK", "fw_addbox : ButtonOK : Dialog : 1, 2, 10, 1 : a=center");
llMessageLinked(LINK_SET, 0, "Cancel", "fw_addbox : ButtonCancel : Dialog : 13, 2, 10, 1 : a=center");

llMessageLinked(LINK_SET, 0, "One\nTwo\nThree", "fw_addbox : Column0 : Table : 0, 1, 8, 3 : w=none");
llMessageLinked(LINK_SET, 0, "123\n456\n789", "fw_addbox : Column1 : Column0 : 7, 0, 8, 3 : w=none");
llMessageLinked(LINK_SET, 0, "1.2\n2.3\n3.4", "fw_addbox : Column2 : Column1 : 7, 0, 8, 3 : w=none");
llMessageLinked(LINK_SET, 0, "▲\n\n▼", "fw_addbox : UpDown : Column2 : 9, 0, 1, 3");

llMessageLinked(LINK_SET, 0, "Some dialog", "fw_data : Dialog");
</source>

==== Box borders ====

FURWARE text offers a special style option that comes in especially handy when dealing with boxes: The '''border''' style option. Because an example probably says more than words here, consider the following modification of the previous example:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "OK", "fw_addbox : ButtonOK : Dialog : 1, 2, 10, 1 : a=center; border=lr");
llMessageLinked(LINK_SET, 0, "Cancel", "fw_addbox : ButtonCancel : Dialog : 13, 2, 10, 1 : a=center; border=lr");

llMessageLinked(LINK_SET, 0, "One\nTwo\nThree", "fw_addbox : Column0 : Table : 0, 1, 8, 3 : w=none; border=lr");
llMessageLinked(LINK_SET, 0, "123\n456\n789", "fw_addbox : Column1 : Column0 : 7, 0, 8, 3 : w=none; border=lr");
llMessageLinked(LINK_SET, 0, "1.2\n2.3\n3.4", "fw_addbox : Column2 : Column1 : 7, 0, 8, 3 : w=none; border=lr");
llMessageLinked(LINK_SET, 0, "▲\n\n▼", "fw_addbox : UpDown : Column2 : 9, 0, 1, 3");

llMessageLinked(LINK_SET, 0, "Some dialog", "fw_data : Dialog");
llMessageLinked(LINK_SET, 0, "border=lrtb", "fw_conf : Dialog");
</source>

In the following picture, the separating lines between the prims and faces were omitted so you can get a better view on the borders introduced by the above commands. Note how FURWARE text automatically adjusts the text positions according to the borders.

[[File:FURWARE_text_boxes_example_2.png]]

The "border" style setting takes '''any (meaningful) combination''' of the letters '''tblrTBLR12''' (order does not matter). The lowercase letters t, b, l, r introduce borders at the top, bottom, left or right side. The uppercase letters T, B, L, R additionally introduce special characters at the corners of boxes to connect them with other boxes (see also the next picture). The numbers "1" or "2" yield different border styles. Here are a few examples:

[[File:FURWARE_text_boxes_example_3.png]]

Now it should become clear why the previously mentioned overlap of the table's columns is useful: This way we could simply set the borders of '''all''' table columns to left and right without having to distinguish between them.

{{KBtip|The additional space that is needed to draw the borders must be manually added to the respective box sizes.}}

==== Deleting boxes ====

Deleting boxes is done using the "fw_delbox" command followed by the box's name. For instance, the following code would remove the dialog's buttons:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_delbox : ButtonOK");
llMessageLinked(LINK_SET, 0, "", "fw_delbox : ButtonCancel");
</source>

You can also delete multiple boxes at once. The following code yields the same result:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_delbox : ButtonOK : ButtonCancel");
</source>

{{KBcaution|You cannot delete the "root" boxes of the display sets ("Dialog" and "Table" in this example).}}

=== Touch queries ===

The example we used in the last chapter contains parts of the text that the user should be able to touch on the object and get some response, namely the buttons of the "dialog" and the up/down buttons right of our table.

The FURWARE text script can be queried about '''which box''' has been touched and at '''what coordinates''', given the prim and face number that has been touched. The script will automatically take into account the correct translation into coordinates relative to the box, the correct ordering and any overlap between boxes.

==== Performing a query ====

Let's take a look at the touch_start()-handler in our script and how it can send a "fw_touchquery" to the FURWARE text script:

<source lang="lsl2">
touch_start(integer numDetected) {
string link = (string)llDetectedLinkNumber(0);
string face = (string)llDetectedTouchFace(0);
llMessageLinked(LINK_SET, 0, "Some user data", "fw_touchquery:" + link + ":" + face);
}
</source>

As you can see, the last parameter of llMessageLinked() contains the "fw_touchquery" command, the touched link number and face number, all separated by ":".

In addition, you may pass an '''arbitrary string''' as the third parameter to llMessageLinked(); "Some user data" in this example. This data will be sent back unmodified in the response message. This way you can associate queries with respones.

==== Parsing the reply ====

The FURWARE text script will '''always''' reply to such a query, even if something went wrong and it could not make sense of the parameters given in the query (for instance when a prim was touched that is not a display prim).

The "id" parameter of the "link_message()" handler always contains the string "fw_touchreply" so you can quickly distinguish the reply messages from other link messages.

The "str" parameter contains ":"-separated data about the result of the query in the form

''boxName:dx:dy:rootName:x:y:userData''

where

* '''boxName''' is the name of the box that has been touched.
* '''dx''' is the column (in characters) of the touch relative to the box's left side.
* '''dy''' is the row of the touch relative to the box's top side.
* '''rootName''' is the name of the base box of the display set in which the box resides.
* '''x''' is the column (in characters) of the touch relative to the display set's left side.
* '''y''' is the row of the touch relative to the display set's top side.
* '''userData''' is the string that has been passed as third parameter of "llMessageLinked()" in the touch query.

{{KBtip|All fields except for "userData" will be empty if the touch query was invalid (e.g. a prim was touched that is not part of a display).}}

Here is an example how we could parse a reply in our example:

<source lang="lsl2">
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_touchreply") {
list tokens = llParseStringKeepNulls(str, [":"], []);
string boxName = llList2String(tokens, 0);
integer dx = llList2Integer(tokens, 1);
integer dy = llList2Integer(tokens, 2);
string rootName = llList2String(tokens, 3);
integer x = llList2Integer(tokens, 4);
integer y = llList2Integer(tokens, 5);
string userData = llList2String(tokens, 6);

if (boxName == "ButtonOK") {
llOwnerSay("OK button was clicked.");
} else if (boxName == "ButtonCancel") {
llOwnerSay("Cancel button was clicked.");
} else if (boxName == "UpDown") {
// We use the Y coordinate to determine whether "up" or "down" was touched.
if (dy == 0) {
llOwnerSay("Up button was clicked.");
} else if (dy == 2) {
llOwnerSay("Down button was clicked.");
}
}
}
}
</source>

=== Style templates ===

Let's say we wish to make the buttons of our dialog a bit more fancy. For instance, we might wish to give them another font and color (in addition to their left and right borders and the centered alignment). We '''could''' of course write something like this:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "border=lr; a=center; c=darkgreen; f=5054fec3-1465-af8f-2fe5-e9507795c82a", "fw_conf : ButtonOK");
llMessageLinked(LINK_SET, 0, "border=lr; a=center; c=darkgreen; f=5054fec3-1465-af8f-2fe5-e9507795c82a", "fw_conf : ButtonCancel");
</source>

Although it might not be that bad in this small example, it seems to be a little redundant. If you have more boxes or text passages with styles that you wish to share among boxes, using '''templates''' is probably more efficient.

FURWARE text allows you to store string "variables" that you can assign a name. Currently, these variables are only used for style templates. Let's put the above shared style commands into such a variable using the "fw_var" command and give it the name "button":

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "border=lr; a=center; c=darkgreen; f=5054fec3-1465-af8f-2fe5-e9507795c82a", "fw_var : button");
</source>

We may now use this variable in style specifications using the '''style=...''' syntax. Let's rewrite the two "fw_conf" lines from before:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "style=button", "fw_conf : ButtonOK");
llMessageLinked(LINK_SET, 0, "style=button", "fw_conf : ButtonCancel");
</source>

Our dialog then looks like this:

[[File:FURWARE_text_tmpl_example_0.png]]

You may even mix templates with other style settings (even other templates). For instance, we might want to make the "Cancel" button dark red but keep the other style attributes of the "button" template:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "style=button; c=darkred", "fw_conf : ButtonCancel");
</source>

{{KBtip|You can also use "fw_var" to '''change''' the contents of an existing variable. Passing the empty string as the variable's contents '''deletes''' the variable. Note that changing an existing variable will trigger a '''complete refresh''' of the display because it doesn't know where the variables might be currently in use.}}

{{KBcaution|Style templates allow recursion (i.e. calling a style template from within another style template). The text script does '''not''' check for infinite recursion!}}

=== Configuring multiple boxes at once ===

Sometimes you may wish to set the same style or text data for multiple boxes at once. As an example, let us consider the following "game board" that has 9 separate boxes for the "X" and "O" cells:

[[File:FURWARE_text_range_example_0.png]]

Now let's say that we wish to highlight the middle row like this:

[[File:FURWARE_text_range_example_1.png]]

To achieve this, we '''could''' of course write:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Cell3");
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Cell4");
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Cell5");
</source>

But this obviously requires three link messages. FURWARE text offers a special syntax that can be used for the "fw_data" and "fw_conf" commands to set text or style data for multiple boxes '''at once'''. One possibilty for our example is to specify the names of all boxes that should be configured like so:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Cell3 : Cell4 : Cell5");
</source>

If we assume that the boxes were added to the display in the order "Cell0", "Cell1", and so on, we can shorten the code even more. We may specify '''intervals''' of boxes that we wish to set using the following syntax (note the semicolon (";") between the box names!):

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=red", "fw_conf : Cell3 ; Cell5");
</source>

Let's say that we wish to "reset" the game so that all fields to show the "?" symbol like this:

[[File:FURWARE_text_range_example_2.png]]

To achieve this, we need to reset the color and the text for all fields. We can use the interval notation for both "fw_conf" and "fw_data":

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_conf : Cell0 ; Cell8");
llMessageLinked(LINK_SET, 0, "?", "fw_data : Cell0 ; Cell8");
</source>

In this concrete example we can even omit one end of the interval: Because "Cell8" is the last box in the display set, we may omit its name and write:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_conf : Cell0 ;");
llMessageLinked(LINK_SET, 0, "?", "fw_data : Cell0 ;");
</source>

This means "apply to Cell0 '''and all following boxes''' in the same display set".

It is even possible to mix interval- and single-box-notation. Consider the following code (the additional whitespace is just inserted for clarity, you may of course omit it):

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "!", "fw_data : Cell1;Cell3 : Cell5 : Cell7; ");
</source>

Applied to the above example board, this yields:

[[File:FURWARE_text_range_example_3.png]]

{{KBtip|Please see the reference for a complete overview of all possible parameter notations.}}

=== Global style settings ===

Some of the style settings of your board may have a "global" nature. For instance, you might wish to always use a certain font for '''all''' boxes and be able to change that setting quickly.

Using the style templates from the last section, we already have a way to give multiple boxes a style that we can later on change centrally (by changing the respective variable using "fw_var"). The '''drawback''' of this method is that we still need to specify the "style=..." for each box separately and remember to include it again when changing some other style settings specific to a box using "fw_conf".

For such cases, the script offers the "'''fw_defaultconf'''" command. Using this command, you may set global defaults for '''all boxes''', '''all root boxes''' (i.e. the "base" boxes of each display set) and '''all non-root boxes'''.

There currently are three variants of the command that can be sent for setting the defaults as mentioned above. Here are examples showing their usage (note the different arguments for "fw_defaultconf:..." command):

<source lang="lsl2">
// Sets the default style for all boxes to red, centered.
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf");

// Sets the default style for all ROOT boxes to green, no wrapping.
llMessageLinked(LINK_SET, 0, "c=green; w=none", "fw_defaultconf : root");

// Sets the default style for all NON-ROOT boxes to "no trimming".
llMessageLinked(LINK_SET, 0, "t=off", "fw_defaultconf : nonroot");
</source>

=== Inline styles ===

By now we have used global and per-box style configuration. FURWARE text supports yet another level which is the most fine-grained: Style commands that are placed '''directly within''' the text. This allows you to override parts of the current style settings for only parts of your text, for instance to highlight words or align individual lines of text differently.

Such a style command is started by "<!" (note the exclamation mark) and ended by ">". In between those tags, you may specify style commands. As an example, let's make the heading text of our dialog centered, one word within the text randomly colored and make it use a different font:

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "<!a=center>Some <!c=rand; f=5054fec3-1465-af8f-2fe5-e9507795c82a>fancy<!c=def> dialog", "fw_data : Dialog");
</source>

The result may look something like this (of course, here the color is random each time the dialog is rendered):

[[File:FURWARE_text_inline_example_0.png]]

Take a close look at the result and at the code: We have used a special setting "'''c=def'''" to '''restore the normal color''' of the text after the word "fancy" but '''we have not reset the font''' and thus it will stay active for the rest of the text. You may use the special setting "'''def'''" for any setting (color, font, alignment, etc.) to restore the box's default.

{{KBtip|You may also use style templates using the inline formatting command "style".}}

{{KBcaution|Using "border" settings as an inline style does not have any effect.}}

{{KBcaution|Alignment, trimming or wrapping settings may only be used immediately at the beginning of a new line (also immediately after each "\n") and will then affect that line and following lines.}}

==== Selectively disabling inline styles ====

You might want to disable inline styles for parts of your display, for instance when displaying user input where you do not want the "<!" to be interpreted as the start of style data.

Curiously enough, the command for doing this is a style setting itself, namely "'''tags=off'''". After it has been parsed, further "<!" tags will be ignored. As an example, the following command disables inline styles for the contents of our "Dialog":

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "border=tblr; tags=off", "fw_conf : Dialog");
</source>

You can even use this setting in an inline fashion, but only at the beginning of new lines (similar to alignment, etc.). Then this line and '''all''' following lines will ignore inline styles (indeed there is no way to enable them again using an inline command).

Template talk:KBtip

2015-04-08T08:36:13Z

Ochi Wolfe: Created page with "Seems like the icons of the box templates are not showing anymore - bug? ~~~~"

Seems like the icons of the box templates are not showing anymore - bug? [[User:Ochi Wolfe|Ochi Wolfe]] ([[User talk:Ochi Wolfe|talk]]) 01:36, 8 April 2015 (PDT)

Talk:Syntax Highlighting Examples

2015-04-08T08:28:32Z

Ochi Wolfe: Created page with "It seems like this extension is no longer working correctly (most languages are not being formatted correctly anymore). Is it officially deprecated or is this a bug? ~~~~"

FURWARE text/TextureCreator/Reference

2013-09-06T21:46:09Z

Ochi Wolfe: Updated loadFont description to match git master

{{LSL Header|ml=*}}

== Chain/script commands ==

The following commands may be used in "chain" and "script" files.

=== <code>runScript</code> ===
''Parameters: <code>scriptName</code>''

Executes commands from another script file (usually with the extension ".script"; file name only, '''not''' a full path; note that ''<code>scriptName</code>'' must include the file name extension). The given script file ist first searched for in the folder of the font that is currently being processed and, if not found, in the global "scripts" directory. After successful execution of the commands in the other script, execution continues where runScript was called.

=== <code>init</code> ===
''Parameters: <code>sizeX sizeY scaleX scaleY</code>''

Initializes a new texture to draw to. This command should generally be one of the first things to call, except for "runScript" commands. The ''<code>sizeX</code>'', ''<code>sizeY</code>'' values set the size of the drawing area in pixels. However, this only equals the size of the resulting texture if ''<code>scaleX</code>'', ''<code>scaleY</code>'' is set to <code>1.0</code>, <code>1.0</code>. The scale parameters may be used to create larger or smaller versions of a texture without having to tweak any positioning of characters, etc. because everything will be scaled relative to these values.

For instance, the configs that come with the creator are made for 1024x1024 textures. If you set the ''<code>size*</code>'' values to <code>1024</code> and the ''<code>scale*</code>'' values to <code>0.5</code>, you will get a 512x512 texture with the same content as the 1024x1024 version, just smaller. In contrast, if you set the ''<code>size*</code>'' values to <code>512</code> and keep the ''<code>scale</code>'' values set to <code>1.0</code>, you will get a cropped version of the 1024x1024 version, showing only the upper-left quarter of the texture. Note that the scaling is not performed by scaling the final texture but during the drawing, yielding smooth and detailed textures at all scales.

=== <code>setOutputName</code> ===
''Parameters: <code>outputName</code>''

Sets the name of the texture file to be created. Note that ''<code>outputName</code>'' should not include the file extension, for instance <code>.tga</code>. When you do not call '''<code>setOutputName</code>''', the name of the folder of the font currently being processed is used as the texture name. This command may be used for creating multiple versions of a texture from the same font.

=== <code>setOutputNameSuffix</code> ===
''Parameters: <code>outputNameSuffix</code>''

Similar to '''<code>setOutputName</code>''', with the difference that '''<code>outputNameSuffix</code>''' is appended to the currently set output name. This allows you to append suffixes like <code>-512</code> or <code>-1024</code> to different versions of textures created from the same font.

=== <code>setCellSize</code> ===
''Parameters: <code>sizeX sizeY</code>''

Sets the size of one character cell to ''<code>sizeX</code>'', ''<code>sizeY</code>'' (in pixels, assuming a scale of <code>1.0</code>).

=== <code>setCellOffset</code> ===
''Parameters: <code>offsetX offsetY</code>''

Sets the distance of the center of the upper-left cell to the upper-left corner of the texture to ''<code>offsetX</code>'', ''<code>offsetY</code>'' (in pixels, assuming a scale of <code>1.0</code>).

=== <code>setCellSpacing</code> ===
''Parameters: <code>spaceX spaceY</code>''

Sets the horizontal and vertical spacing between the centers of two cells to ''<code>spaceX</code>'', ''<code>spaceY</code>'' (in pixels, assuming a scale of <code>1.0</code>).

=== <code>setCellCount</code> ===
''Parameters: <code>numX numY</code>''

Sets the number of cells in horizontal and vertical direction. Used for various purposes, especially for determining when to go to the next row when drawing many characters at once.

=== <code>setBaselineOffset</code> ===
''Parameters: <code>value unit</code>''

Sets the vertical offset of the font's native baseline from the cell centers. The ''<code>unit</code>'' parameter determines how ''<code>value</code>'' is interpreted; see below for possible values of ''<code>unit</code>''.

=== <code>jumpToCell</code> ===
''Parameters: <code>cellX cellY</code>''

Sets the position of the virtual "cursor" in the cell grid to ''<code>cellX</code>'', ''<code>cellY</code>''. The next call of '''<code>drawChars</code>''' will then draw the next character to that cell.

=== <code>loadFont</code> ===
''Parameters: <code>fontName</code>''

Loads a font for drawing, also loading the respective <code>font.conf</code> file, if there is one in the same folder as the font file. ''<code>fontName</code>'' may be empty to load the font that is currently being processed by the tool. If it is not empty, it must be the name of one of the directories in the "fonts" directory. This command may be used to use symbols from other fonts, for instance when they offer special characters that are not available in the font being processed.

=== <code>drawChars</code> ===
''Parameters: <code>listOfChars</code>''

Draws the characters given in ''<code>listOfChars</code>'' to the current cursor position (see also '''<code>jumpToCell</code>'''). When multiple characters are specified, the virtual cursor will automatically be moved forward and, if necessary, to the next row.

=== <code>drawLineBetweenCells</code> ===
''Parameters: <code>thickness startX startY endX endY startOffsetX startOffsetY endOffsetX endOffsetY</code>''

Used to draw a line between two cells with the given line ''<code>thickness</code>''. The ''<code>startX</code>'', ''<code>startY</code>'' and ''<code>endX</code>'', ''<code>endY</code>'' values are the coordinates of the start/end cells in the cell grid, starting from <code>0</code>. The ''<code>*Offset*</code>'' values are offsets of the line endpoints from the start/end cells' center, in pixels.

=== <code>drawRectBetweenCells</code> ===
''Parameters: <code>thickness startX startY endX endY startOffsetX startOffsetY endOffsetX endOffsetY</code>''

Similar to '''<code>drawLineBetweenCells</code>''', but draws the outline of a rectangle between two cells instead of a line, with the given stroke thickness. The start coordinates specify the upper-left, the end coordinates for the lower-right corner of the rectangle.

=== <code>drawFilledRectBetweenCells</code> ===
''Parameters: <code>thickness startX startY endX endY startOffsetX startOffsetY endOffsetX endOffsetY</code>''

Similar to '''<code>drawRectBetweenCells</code>''', but draws a filled rectangle. Note that the ''<code>thickness</code>'' parameter does not actually have any effect for this command.

=== <code>noBuild</code> ===
''Parameters: none''

Causes script execution for the current font to be stopped and no texture is created. Used for fonts which are only there for usage from other scripts but for which no complete textures shall be created.

=== <code>drawDebugGrid</code> ===
''Parameters: none''

Draws an opaque grid showing the grid layout behind any drawn characters or geometry. Shall be called after the grid has been set up completely using '''<code>init</code>''' and the necessary '''<code>set*</code>''' functions, but before drawing any characters, etc.

== Font configuration files ==

The following commands may be used in <code>font.conf</code> files to tweak per-font and per-character settings.

=== <code>offset</code> ===
''Parameters: <code>offsetX offsetY unitX unitY</code>''

Sets the offset of all characters drawn using this font. See below for possible values of ''<code>unitX</code>'', ''<code>unitY</code>'' which decides in which unit the ''<code>offset*</code>'' values are given.

=== <code>scale</code> ===
''Parameters: <code>value unit</code>''

Sets the scaling (text size) for all characters drawn using this font. See below for possible values of ''<code>unit</code>'' which decides in which unit the ''<code>value</code>'' argument is given.

=== <code>charSettings</code> ===
''Parameters: <code>char offsetX offsetY scaleX scaleY</code>''

Set per-character offset and scaling values. The ''<code>char</code>'' parameter shall be exactly one character for which the settings are being set. The ''<code>offset*</code>'' parameters set an offset that should be '''added''' to the global offset set using the '''<code>offset</code>''' setting when drawing the character ''<code>char</code>''; given in pixels (assuming a scale of <code>1.0</code>). The ''<code>scale</code>'' parameters are floats where a value of <code>1.0</code> means "no scaling".

=== <code>enableAutoShrink</code> ===
''Parameters: none''

If this line is given in the font config, a heuristic is activated that tries to guess a horizontal down-scaling for characters that would otherwise be too wide to fit in a cell. The idea is to automatically tweak the wider characters of non-monospace fonts (like <code>W</code>) to fit into the grid cells. This is very experimental.

== The ''unit*'' parameters ==

Some functions have ''<code>unit*</code>'' parameters that specify how the given values (offsets, sizes) shall be interpreted. Each ''<code>unit*</code>'' parameter may be one of:

* <code>cellWidth</code>: The offset/size value is interpreted relative to the set cell width, so a value of <code>1.0</code> means equal to the cell width.
* <code>cellHeight</code>: Same as <code>cellWidth</code>, but using the cell height.
* Any other value, recommended is <code>abs</code>: Absolute pixel values (assuming a texture scale of <code>1.0</code>).

FURWARE text

2013-09-03T20:08:44Z

Ochi Wolfe: Small updates to the to-do list

FURWARE text/TextureCreator/Usage

2013-09-01T19:59:00Z

Ochi Wolfe: Link to Fonts subpage

== Quick start ==

You can find download links for the tool on the [[FURWARE_text/TextureCreator|TextureCreator page]]. To run the TextureCreator under Windows, the easiest way is probably to fetch the pre-compiled package. Otherwise (and for using it on Linux or Mac), you can get the latest Python 2 code on the GitHub page. Note that when using the Python version, you will need Python 2 (tested with 2.7.5), pyCairo, Cairo, FreeType and any dependencies of these packages. A Python 3 version is currently not available because the pyCairo package for Python 3 does not have some of the required functionality.

Once you have the TextureCreator tool running and it is able to create textures for the included fonts, you may add your own font folders to the "fonts" directory and place a ".ttf" or ".otf" font file inside it. When you execute the TextureCreator, it should create a texture using the newly added font using default settings. However, more tweaking may be necessary to really get the best out of a certain font (most notably a custom "font.conf" file), because every font is different. See below for a more in-depth description of how the TextureCreator works.

== More on the mode of operation ==

The most important items in the texture creator directory are the main program file ("TextureCreator.py" or "TextureCreator.exe"), the "fonts" directory, the "scripts" directory and the "output" directory (which might not exist initially, but it is created automatically by the tool when needed).

The basic mode of operation is to load font files together with any custom configurations from the ''fonts'' directory, process them using one or more ''chain and script file(s)'' and output the resulting texture to the ''output'' directory.

The "fonts" directory contains sub-directories; one for each font. Each of these sub-directories usually contains a font file (TrueType (ttf) or OpenType (otf)). If a sub-directory does not contain any font file, it is silently ignored. Please note that only the most basic font files come bundled with the TextureCreator; see [[FURWARE_text/TextureCreator/Fonts|this page]] for links to the rest of the standard FURWARE text font files.

The texture creator searches each of the font sub-directories for a font file and if it finds one, it continues by searching for one or more "chain" files which contain commands that shall be executed for creating a texture for the font. Such commands might be (figuratively) "create a texture of a certain size", "draw these symbols using the currently loaded font at certain positions" or "continue with commands in another file".

Thus the "chain" files may be seen as the "entry points" for execution of commands for a certain font. The way the texture creator searches for chain files is as follows: First, the font's directory is searched for chain files; this allows you to specify chains that are specific to the font. Only if no chain files are contained in the font's directory, all chains contained in the "scripts" directory are executed.

Chain files may execute commands contained in other files (".script" files). For instance, the default chain files in the scripts directory execute several script files containing commands for initializing the new texture, drawing basic symbols, special symbols, and so on. Note that the only difference between ".chain" and ".script" files is the file extension; the same set of commands is available in both chain and script files, but only files with the ".chain" extension are used as the entry points for script execution.

Note that, just like chain files, ".script" files are also searched for in the font's directory first, then in the global "scripts" directory. This, again, allows you to bundle custom script files specific to a certain font.

Each font sub-directory may also contain a "font.conf" file for font-specific configuration. These files are different from the chain and script files. They may contain font-specific offset and scaling settings, also for individual symbols of the respective font. Whenever a font is being loaded for drawing (also when it is loaded from other script files), that font's configuration is used.

After all commands in a chain file have been executed, the created texture is written out to the "output" directory. By default, the name of the font directory is used for the texture's name (plus the image format's extension), but that name may be changed using script commands.

FURWARE text/TextureCreator

2013-09-01T19:55:05Z

Ochi Wolfe: Added link to the Fonts subpage

FURWARE text/TextureCreator/Fonts

2013-09-01T19:53:07Z

Ochi Wolfe: Initial version

== Links to the FURWARE text standard font files ==

Only the most basic fonts (DejaVu, FreeFont Serif) come bundled with the TextureCreator tool. For the other standard fonts, only configuration files are included. If you wish to build font textures for these fonts, please use the following links to download the font files.

'''Notes:'''
* The "Hashes" sections contain the SHA1 hashes of the font files that were last tested and used for creating the "official", bundled FURWARE text font textures.
* Please also note that the "Hashes" sections contain the names of the used font files. The downloadable font packages often contain many more variations of the respective font.
* Please report any broken links.

=== Andale ===

'''Links:''' [http://sourceforge.net/projects/corefonts/files/the%20fonts/final/ Website], [http://sourceforge.net/projects/corefonts/files/the%20fonts/final/andale32.exe/download Direct link]

'''Notes:''' The font file is packed in a self-extracting archive. Under Linux, you may use "cabextract" to extract the font file.

'''Hashes:'''

<code>
953839b69c5bc047cb53efefc755dd21175a3a1d fonts/Andale/AndaleMo.TTF
</code>

=== Anonymous Pro ===

'''Links:''' [http://www.marksimonson.com/fonts/view/anonymous-pro Website], [http://www.marksimonson.com/assets/content/fonts/AnonymousPro-1.002.zip Direct link]

'''Hashes:'''

<code>
a5af97297e863b4fc9d463200e5befc7ee102d57 fonts/AnonymousPro/Anonymous Pro.ttf

8fd93c43aa27045a533c56bbf948e1e4e3081ef0 fonts/AnonymousPro-Bold/Anonymous Pro B.ttf
</code>

=== DejaVu ===

'''Links:''' [http://dejavu-fonts.org/wiki/Download Website], [http://sourceforge.net/projects/dejavu/files/dejavu/2.34/dejavu-fonts-ttf-2.34.zip/download Direct link]

'''Hashes:'''

<code>
73225779da81fc5a874596d065e336ca3d7b4c37 fonts/DejaVu/DejaVuSansMono.ttf

a2152e5cc64b7f038546d0150bfb68f61572aa55 fonts/DejaVu-Bold/DejaVuSansMono-Bold.ttf
</code>

=== EnvyCodeR ===

'''Links:''' [http://damieng.com/blog/2008/05/26/envy-code-r-preview-7-coding-font-released Website], [http://download.damieng.com/fonts/original/EnvyCodeR-PR7.zip Direct link]

'''Hashes:'''

<code>
b8bfc57294faf001ce3b5297f045d323cf524d50 fonts/EnvyCodeR/Envy Code R.ttf
</code>

=== FreeFont/FreeSerif ===

'''Links:''' [http://savannah.gnu.org/projects/freefont/ Website], [http://ftp.gnu.org/gnu/freefont/freefont-ttf-20120503.zip Direct link]

'''Hashes:'''

<code>
583e0b2acb91c59954c8fa7692c453a36c1b1a82 fonts/FreeFont/FreeMonoBold.ttf

6023b0abf77647ad1489d059678f5b7a63c78147 fonts/FreeSerif/FreeSerif.ttf
</code>

=== Inconsolata ===

'''Links:''' [http://levien.com/type/myfonts/inconsolata.html Website], [http://levien.com/type/myfonts/Inconsolata.otf Direct link]

'''Hashes:'''

<code>
7f0a4919d91edcef0af9dc153054ec49d1ab3072 fonts/Inconsolata/Inconsolata.otf
</code>

=== Liberation ===

'''Links:''' [https://fedorahosted.org/liberation-fonts/ Website], [https://fedorahosted.org/releases/l/i/liberation-fonts/liberation-fonts-ttf-2.00.1.tar.gz Direct link]

'''Hashes:'''

<code>
302c90a3435f6768669be3b0796b32f02e02fb8c fonts/Liberation/LiberationMono-Regular.ttf

96429f1d58a45ffa36f21d1052d691a0cd11125c fonts/Liberation-Bold/LiberationMono-Bold.ttf
</code>

=== Luxi ===

'''Links:''' [http://en.wikipedia.org/wiki/Luxi_fonts Website], [http://xorg.freedesktop.org/releases/individual/font/font-bh-ttf-1.0.3.tar.bz2 Direct link]

'''Hashes:'''

<code>
14abb9893507742837094ad262e6cd78edf1e42a fonts/Luxi/luximr.ttf

01bcf993dc3161f3eddaa76f91a3b323ce2c225e fonts/Luxi-Bold/luximb.ttf
</code>

=== Monofur ===

'''Links:''' [http://www.dafont.com/monofur.font Website], [http://img.dafont.com/dl/?f=monofur Direct link]

'''Hashes:'''

<code>
30c79031b7a6a6e613f1e2c00dcedf0027902aed fonts/Monofur/monof55.ttf
</code>

=== Nova Mono ===

'''Links:''' [http://www.google.com/fonts/specimen/Nova+Mono Website], [http://www.google.com/fonts/download?kit=_m2nPFkZFucmzq044Y7St1tkqrIMaAZWyLYEoB48lSQ Direct link]

'''Hashes:'''

<code>
dfd7d60609fcd7c6d7a7b372d2ec1f91b3cab650 fonts/Nova/NovaMono.ttf
</code>

=== ProFont ===

'''Links:''' [http://www.tobias-jung.de/seekingprofont/index.html Website], [http://www.tobiasjung.net/download.php?file=ProFontWinTweaked.zip Direct link]

'''Notes:''' Please use the '''tweaked''' TrueType version of the font.

'''Hashes:'''

<code>
82f6ad711c91f59f5fd30b3d3770d0340762fa4f fonts/ProFont/ProFontWindows.ttf
</code>

FURWARE text/TextureCreator

2013-08-31T22:13:26Z

Ochi Wolfe: Added links to documentation subpages

FURWARE text/TextureCreator/Reference

2013-08-31T22:08:14Z

Ochi Wolfe: Updated to match current git version

{{LSL Header|ml=*}}

== Chain/script commands ==

The following commands may be used in "chain" and "script" files.

=== <code>runScript</code> ===
''Parameters: <code>scriptName</code>''

Executes commands from another script file (usually with the extension ".script"; file name only, '''not''' a full path; note that ''<code>scriptName</code>'' must include the file name extension). The given script file ist first searched for in the folder of the font that is currently being processed and, if not found, in the global "scripts" directory. After successful execution of the commands in the other script, execution continues where runScript was called.

=== <code>init</code> ===
''Parameters: <code>sizeX sizeY scaleX scaleY</code>''

Initializes a new texture to draw to. This command should generally be one of the first things to call, except for "runScript" commands. The ''<code>sizeX</code>'', ''<code>sizeY</code>'' values set the size of the drawing area in pixels. However, this only equals the size of the resulting texture if ''<code>scaleX</code>'', ''<code>scaleY</code>'' is set to <code>1.0</code>, <code>1.0</code>. The scale parameters may be used to create larger or smaller versions of a texture without having to tweak any positioning of characters, etc. because everything will be scaled relative to these values.

For instance, the configs that come with the creator are made for 1024x1024 textures. If you set the ''<code>size*</code>'' values to <code>1024</code> and the ''<code>scale*</code>'' values to <code>0.5</code>, you will get a 512x512 texture with the same content as the 1024x1024 version, just smaller. In contrast, if you set the ''<code>size*</code>'' values to <code>512</code> and keep the ''<code>scale</code>'' values set to <code>1.0</code>, you will get a cropped version of the 1024x1024 version, showing only the upper-left quarter of the texture. Note that the scaling is not performed by scaling the final texture but during the drawing, yielding smooth and detailed textures at all scales.

=== <code>setOutputName</code> ===
''Parameters: <code>outputName</code>''

Sets the name of the texture file to be created. Note that ''<code>outputName</code>'' should not include the file extension, for instance <code>.tga</code>. When you do not call '''<code>setOutputName</code>''', the name of the folder of the font currently being processed is used as the texture name. This command may be used for creating multiple versions of a texture from the same font.

=== <code>setOutputNameSuffix</code> ===
''Parameters: <code>outputNameSuffix</code>''

Similar to '''<code>setOutputName</code>''', with the difference that '''<code>outputNameSuffix</code>''' is appended to the currently set output name. This allows you to append suffixes like <code>-512</code> or <code>-1024</code> to different versions of textures created from the same font.

=== <code>setCellSize</code> ===
''Parameters: <code>sizeX sizeY</code>''

Sets the size of one character cell to ''<code>sizeX</code>'', ''<code>sizeY</code>'' (in pixels, assuming a scale of <code>1.0</code>).

=== <code>setCellOffset</code> ===
''Parameters: <code>offsetX offsetY</code>''

Sets the distance of the center of the upper-left cell to the upper-left corner of the texture to ''<code>offsetX</code>'', ''<code>offsetY</code>'' (in pixels, assuming a scale of <code>1.0</code>).

=== <code>setCellSpacing</code> ===
''Parameters: <code>spaceX spaceY</code>''

Sets the horizontal and vertical spacing between the centers of two cells to ''<code>spaceX</code>'', ''<code>spaceY</code>'' (in pixels, assuming a scale of <code>1.0</code>).

=== <code>setCellCount</code> ===
''Parameters: <code>numX numY</code>''

Sets the number of cells in horizontal and vertical direction. Used for various purposes, especially for determining when to go to the next row when drawing many characters at once.

=== <code>setBaselineOffset</code> ===
''Parameters: <code>value unit</code>''

Sets the vertical offset of the font's native baseline from the cell centers. The ''<code>unit</code>'' parameter determines how ''<code>value</code>'' is interpreted; see below for possible values of ''<code>unit</code>''.

=== <code>jumpToCell</code> ===
''Parameters: <code>cellX cellY</code>''

Sets the position of the virtual "cursor" in the cell grid to ''<code>cellX</code>'', ''<code>cellY</code>''. The next call of '''<code>drawChars</code>''' will then draw the next character to that cell.

=== <code>loadFont</code> ===
''Parameters: <code>fontFilePath</code>''

Loads a font file (<code>.ttf</code>, <code>.otf</code>) for drawing, also loading the respective <code>font.conf</code> file, if there is one in the same folder as the font file. ''<code>fontFilePath</code>'' may be empty to load the font that is currently being processed by the tool. If it is not empty, it must be either a complete path, or a path relative to where the TextureCreator program is being executed (for example: <code>fonts/DejaVu/DejaVu.ttf</code>). This command may be used to use symbols from other fonts, for instance when they offer special characters that are not available in the font being processed.

=== <code>drawChars</code> ===
''Parameters: <code>listOfChars</code>''

Draws the characters given in ''<code>listOfChars</code>'' to the current cursor position (see also '''<code>jumpToCell</code>'''). When multiple characters are specified, the virtual cursor will automatically be moved forward and, if necessary, to the next row.

=== <code>drawLineBetweenCells</code> ===
''Parameters: <code>thickness startX startY endX endY startOffsetX startOffsetY endOffsetX endOffsetY</code>''

Used to draw a line between two cells with the given line ''<code>thickness</code>''. The ''<code>startX</code>'', ''<code>startY</code>'' and ''<code>endX</code>'', ''<code>endY</code>'' values are the coordinates of the start/end cells in the cell grid, starting from <code>0</code>. The ''<code>*Offset*</code>'' values are offsets of the line endpoints from the start/end cells' center, in pixels.

=== <code>drawRectBetweenCells</code> ===
''Parameters: <code>thickness startX startY endX endY startOffsetX startOffsetY endOffsetX endOffsetY</code>''

Similar to '''<code>drawLineBetweenCells</code>''', but draws the outline of a rectangle between two cells instead of a line, with the given stroke thickness. The start coordinates specify the upper-left, the end coordinates for the lower-right corner of the rectangle.

=== <code>drawFilledRectBetweenCells</code> ===
''Parameters: <code>thickness startX startY endX endY startOffsetX startOffsetY endOffsetX endOffsetY</code>''

Similar to '''<code>drawRectBetweenCells</code>''', but draws a filled rectangle. Note that the ''<code>thickness</code>'' parameter does not actually have any effect for this command.

=== <code>noBuild</code> ===
''Parameters: none''

Causes script execution for the current font to be stopped and no texture is created. Used for fonts which are only there for usage from other scripts but for which no complete textures shall be created.

=== <code>drawDebugGrid</code> ===
''Parameters: none''

Draws an opaque grid showing the grid layout behind any drawn characters or geometry. Shall be called after the grid has been set up completely using '''<code>init</code>''' and the necessary '''<code>set*</code>''' functions, but before drawing any characters, etc.

== Font configuration files ==

The following commands may be used in <code>font.conf</code> files to tweak per-font and per-character settings.

=== <code>offset</code> ===
''Parameters: <code>offsetX offsetY unitX unitY</code>''

Sets the offset of all characters drawn using this font. See below for possible values of ''<code>unitX</code>'', ''<code>unitY</code>'' which decides in which unit the ''<code>offset*</code>'' values are given.

=== <code>scale</code> ===
''Parameters: <code>value unit</code>''

Sets the scaling (text size) for all characters drawn using this font. See below for possible values of ''<code>unit</code>'' which decides in which unit the ''<code>value</code>'' argument is given.

=== <code>charSettings</code> ===
''Parameters: <code>char offsetX offsetY scaleX scaleY</code>''

Set per-character offset and scaling values. The ''<code>char</code>'' parameter shall be exactly one character for which the settings are being set. The ''<code>offset*</code>'' parameters set an offset that should be '''added''' to the global offset set using the '''<code>offset</code>''' setting when drawing the character ''<code>char</code>''; given in pixels (assuming a scale of <code>1.0</code>). The ''<code>scale</code>'' parameters are floats where a value of <code>1.0</code> means "no scaling".

=== <code>enableAutoShrink</code> ===
''Parameters: none''

If this line is given in the font config, a heuristic is activated that tries to guess a horizontal down-scaling for characters that would otherwise be too wide to fit in a cell. The idea is to automatically tweak the wider characters of non-monospace fonts (like <code>W</code>) to fit into the grid cells. This is very experimental.

== The ''unit*'' parameters ==

Some functions have ''<code>unit*</code>'' parameters that specify how the given values (offsets, sizes) shall be interpreted. Each ''<code>unit*</code>'' parameter may be one of:

* <code>cellWidth</code>: The offset/size value is interpreted relative to the set cell width, so a value of <code>1.0</code> means equal to the cell width.
* <code>cellHeight</code>: Same as <code>cellWidth</code>, but using the cell height.
* Any other value, recommended is <code>abs</code>: Absolute pixel values (assuming a texture scale of <code>1.0</code>).

FURWARE text/TextureCreator/Usage

2013-08-29T20:13:25Z

Ochi Wolfe: Initial version

== Quick start ==

You can find download links for the tool on the [[FURWARE_text/TextureCreator|TextureCreator page]]. To run the TextureCreator under Windows, the easiest way is probably to fetch the pre-compiled package. Otherwise (and for using it on Linux or Mac), you can get the latest Python 2 code on the GitHub page. Note that when using the Python version, you will need Python 2 (tested with 2.7.5), pyCairo, Cairo, FreeType and any dependencies of these packages. A Python 3 version is currently not available because the pyCairo package for Python 3 does not have some of the required functionality.

Once you have the TextureCreator tool running and it is able to create textures for the included fonts, you may add your own font folders to the "fonts" directory and place a ".ttf" or ".otf" font file inside it. When you execute the TextureCreator, it should create a texture using the newly added font using default settings. However, more tweaking may be necessary to really get the best out of a certain font (most notably a custom "font.conf" file), because every font is different. See below for a more in-depth description of how the TextureCreator works.

== More on the mode of operation ==

The most important items in the texture creator directory are the main program file ("TextureCreator.py" or "TextureCreator.exe"), the "fonts" directory, the "scripts" directory and the "output" directory (which might not exist initially, but it is created automatically by the tool when needed).

The basic mode of operation is to load font files together with any custom configurations from the ''fonts'' directory, process them using one or more ''chain and script file(s)'' and output the resulting texture to the ''output'' directory.

The "fonts" directory contains sub-directories; one for each font. Each of these sub-directories usually contains a font file (TrueType (ttf) or OpenType (otf)). If a sub-directory does not contain any font file, it is silently ignored (please see below why many font sub-directories do not contain font files by default).

The texture creator searches each of the font sub-directories for a font file and if it finds one, it continues by searching for one or more "chain" files which contain commands that shall be executed for creating a texture for the font. Such commands might be (figuratively) "create a texture of a certain size", "draw these symbols using the currently loaded font at certain positions" or "continue with commands in another file".

Thus the "chain" files may be seen as the "entry points" for execution of commands for a certain font. The way the texture creator searches for chain files is as follows: First, the font's directory is searched for chain files; this allows you to specify chains that are specific to the font. Only if no chain files are contained in the font's directory, all chains contained in the "scripts" directory are executed.

Chain files may execute commands contained in other files (".script" files). For instance, the default chain files in the scripts directory execute several script files containing commands for initializing the new texture, drawing basic symbols, special symbols, and so on. Note that the only difference between ".chain" and ".script" files is the file extension; the same set of commands is available in both chain and script files, but only files with the ".chain" extension are used as the entry points for script execution.

Note that, just like chain files, ".script" files are also searched for in the font's directory first, then in the global "scripts" directory. This, again, allows you to bundle custom script files specific to a certain font.

Each font sub-directory may also contain a "font.conf" file for font-specific configuration. These files are different from the chain and script files. They may contain font-specific offset and scaling settings, also for individual symbols of the respective font. Whenever a font is being loaded for drawing (also when it is loaded from other script files), that font's configuration is used.

After all commands in a chain file have been executed, the created texture is written out to the "output" directory. By default, the name of the font directory is used for the texture's name (plus the image format's extension), but that name may be changed using script commands.

FURWARE text/TextureCreator/Reference

2013-08-29T19:48:46Z

Ochi Wolfe: Initial version

{{LSL Header|ml=*}}

== Chain/script commands ==

The following commands may be used in "chain" and "script" files.

=== <code>runScript</code> ===
''Parameters: <code>scriptName</code>''

Executes commands from another script file (usually with the extension ".script"; file name only, '''not''' a full path; note that ''<code>scriptName</code>'' must include the file name extension). The given script file ist first searched for in the folder of the font that is currently being processed and, if not found, in the global "scripts" directory. After successful execution of the commands in the other script, execution continues where runScript was called.

=== <code>init</code> ===
''Parameters: <code>sizeX sizeY scaleX scaleY</code>''

Initializes a new texture to draw to. This command should generally be one of the first things to call, except for "runScript" commands. The ''<code>sizeX</code>'', ''<code>sizeY</code>'' values set the size of the drawing area in pixels. However, this only equals the size of the resulting texture if ''<code>scaleX</code>'', ''<code>scaleY</code>'' is set to <code>1.0</code>, <code>1.0</code>. The scale parameters may be used to create larger or smaller versions of a texture without having to tweak any positioning of characters, etc. because everything will be scaled relative to these values.

For instance, the configs that come with the creator are made for 1024x1024 textures. If you set the ''<code>size*</code>'' values to <code>1024</code> and the ''<code>scale*</code>'' values to <code>0.5</code>, you will get a 512x512 texture with the same content as the 1024x1024 version, just smaller. In contrast, if you set the ''<code>size*</code>'' values to <code>512</code> and keep the ''<code>scale</code>'' values set to <code>1.0</code>, you will get a cropped version of the 1024x1024 version, showing only the upper-left quarter of the texture. Note that the scaling is not performed by scaling the final texture but during the drawing, yielding smooth and detailed textures at all scales.

=== <code>setOutputName</code> ===
''Parameters: <code>outputName</code>''

Sets the name of the texture file to be created. Note that ''<code>outputName</code>'' should not include the file extension, for instance <code>.tga</code>. When you do not call '''<code>setOutputName</code>''', the name of the folder of the font currently being processed is used as the texture name. This command may be used for creating multiple versions of a texture from the same font.

=== <code>setOutputNameSuffix</code> ===
''Parameters: <code>outputNameSuffix</code>''

Similar to '''<code>setOutputName</code>''', with the difference that '''<code>outputNameSuffix</code>''' is appended to the currently set output name. This allows you to append suffixes like <code>-512</code> or <code>-1024</code> to different versions of textures created from the same font.

=== <code>setCellSize</code> ===
''Parameters: <code>sizeX sizeY</code>''

Sets the size of one character cell to ''<code>sizeX</code>'', ''<code>sizeY</code>'' (in pixels, assuming a scale of <code>1.0</code>).

=== <code>setCellOffset</code> ===
''Parameters: <code>offsetX offsetY</code>''

Sets the distance of the center of the upper-left cell to the upper-left corner of the texture to ''<code>offsetX</code>'', ''<code>offsetY</code>'' (in pixels, assuming a scale of <code>1.0</code>).

=== <code>setCellSpacing</code> ===
''Parameters: <code>spaceX spaceY</code>''

Sets the horizontal and vertical spacing between the centers of two cells to ''<code>spaceX</code>'', ''<code>spaceY</code>'' (in pixels, assuming a scale of <code>1.0</code>).

=== <code>setCellCount</code> ===
''Parameters: <code>numX numY</code>''

Sets the number of cells in horizontal and vertical direction. Used for various purposes, especially for determining when to go to the next row when drawing many characters at once.

=== <code>jumpToCell</code> ===
''Parameters: <code>cellX cellY</code>''

Sets the position of the virtual "cursor" in the cell grid to ''<code>cellX</code>'', ''<code>cellY</code>''. The next call of '''<code>drawChars</code>''' will then draw the next character to that cell.

=== <code>loadFont</code> ===
''Parameters: <code>fontFilePath</code>''

Loads a font file (<code>.ttf</code>, <code>.otf</code>) for drawing, also loading the respective <code>font.conf</code> file, if there is one in the same folder as the font file. ''<code>fontFilePath</code>'' may be empty to load the font that is currently being processed by the tool. If it is not empty, it must be either a complete path, or a path relative to where the TextureCreator program is being executed (for example: <code>fonts/DejaVu/DejaVu.ttf</code>). This command may be used to use symbols from other fonts, for instance when they offer special characters that are not available in the font being processed.

=== <code>drawChars</code> ===
''Parameters: <code>listOfChars</code>''

Draws the characters given in ''<code>listOfChars</code>'' to the current cursor position (see also '''<code>jumpToCell</code>'''). When multiple characters are specified, the virtual cursor will automatically be moved forward and, if necessary, to the next row.

=== <code>drawLineBetweenCells</code> ===
''Parameters: <code>thickness startX startY endX endY startOffsetX startOffsetY endOffsetX endOffsetY</code>''

Used to draw a line between two cells with the given line ''<code>thickness</code>''. The ''<code>startX</code>'', ''<code>startY</code>'' and ''<code>endX</code>'', ''<code>endY</code>'' values are the coordinates of the start/end cells in the cell grid, starting from <code>0</code>. The ''<code>*Offset*</code>'' values are offsets of the line endpoints from the start/end cells' center, in pixels.

=== <code>drawRectBetweenCells</code> ===
''Parameters: <code>thickness startX startY endX endY startOffsetX startOffsetY endOffsetX endOffsetY</code>''

Similar to '''<code>drawLineBetweenCells</code>''', but draws the outline of a rectangle between two cells instead of a line, with the given stroke thickness. The start coordinates specify the upper-left, the end coordinates for the lower-right corner of the rectangle.

=== <code>drawFilledRectBetweenCells</code> ===
''Parameters: <code>thickness startX startY endX endY startOffsetX startOffsetY endOffsetX endOffsetY</code>''

Similar to '''<code>drawRectBetweenCells</code>''', but draws a filled rectangle. Note that the ''<code>thickness</code>'' parameter does not actually have any effect for this command.

=== <code>noBuild</code> ===
''Parameters: none''

Causes script execution for the current font to be stopped and no texture is created. Used for fonts which are only there for usage from other scripts but for which no complete textures shall be created.

=== <code>drawDebugGrid</code> ===
''Parameters: none''

Draws an opaque grid showing the grid layout behind any drawn characters or geometry. Shall be called after the grid has been set up completely using '''<code>init</code>''' and the necessary '''<code>set*</code>''' functions, but before drawing any characters, etc.

== Font configuration files ==

The following commands may be used in <code>font.conf</code> files to tweak per-font and per-character settings.

=== <code>offset</code> ===
''Parameters: <code>offsetX offsetY unitX unitY</code>''

Sets the offset of all characters drawn using this font. See below for possible values of ''<code>unitX</code>'', ''<code>unitY</code>'' which decides in which unit the ''<code>offset*</code>'' values are given.

=== <code>scale</code> ===
''Parameters: <code>value unit</code>''

Sets the scaling (text size) for all characters drawn using this font. See below for possible values of ''<code>unit</code>'' which decides in which unit the ''<code>value</code>'' argument is given.

=== <code>charOffset</code> ===
''Parameters: <code>char offsetX offsetY scaleX scaleY</code>''

Sets an offset that should be '''added''' to the global offset set using the '''<code>offset</code>''' setting when drawing the character ''<code>char</code>''. The ''<code>char</code>'' char parameter shall be exactly one character. The ''<code>offset*</code>'' parameters are given in pixels (assuming a scale of <code>1.0</code>). The ''<code>scale</code>'' parameters are floats where a value of <code>1.0</code> means "no scaling".

=== <code>guessingChar</code> ===
''Parameters: <code>char</code>''

Sets the character that is used for auomatically guessing parameters for centering the characters in the cells. The default character that is used is the capital <code>X</code>. Other good candidates might be <code>M</code> or <code>W</code> but this depends heavily on the font.

=== <code>enableAutoShrink</code> ===
''Parameters: none''

If this line is given in the font config, a heuristic is activated that tries to guess a horizontal down-scaling for characters that would otherwise be too wide to fit in a cell. The idea is to automatically tweak the wider characters of non-monospace fonts (like <code>W</code>) to fit into the grid cells. This is very experimental.

== The ''unit*'' parameters ==

Some functions have ''<code>unit*</code>'' parameters that specify how the given values (offsets, sizes) shall be interpreted. Each ''<code>unit*</code>'' parameter may be one of:

* <code>cellWidth</code>: The offset/size value is interpreted relative to the set cell width, so a value of <code>1.0</code> means equal to the cell width.
* <code>cellHeight</code>: Same as <code>cellWidth</code>, but using the cell height.
* Any other value, recommended is <code>abs</code>: Absolute pixel values (assuming a texture scale of <code>1.0</code>).

FURWARE text/TextureCreator

2013-08-26T22:26:32Z

Ochi Wolfe: Some extensions

{{LSL Header|ml=*}}

== Overview ==

FURWARE texture creator is a tool for creating font textures for the FURWARE text script from TrueType/OpenType font files. It offers quite flexible configuration options for tweaking per-font and per-symbol options like offsets and scaling. This enables you to create configuration files for specific fonts to fit perfectly for usage with FURWARE text without any additional, manual tweaking of the resulting textures.

The tool is available as a Python 2 script and a pre-compiled package for Windows; see below.

== Mode of operation ==

The most important items in the texture creator directory are the main program file ("TextureCreator.py" or "TextureCreator.exe"), the "fonts" directory, the "scripts" directory and the "output" directory (which might not exist initially, but it is created automatically by the tool when needed).

The basic mode of operation is to load font files together with any custom configurations from the ''fonts'' directory, process them using one or more ''chain and script file(s)'' and output the resulting texture to the ''output'' directory.

The "fonts" directory contains sub-directories; one for each font. Each of these sub-directories usually contains a font file (TrueType (ttf) or OpenType (otf)). If a sub-directory does not contain any font file, it is silently ignored (please see below why many font sub-directories do not contain font files by default).

The texture creator searches each of the font sub-directories for a font file and if it finds one, it continues by searching for one or more "chain" files which contain commands that shall be executed for creating a texture for the font. Such commands might be (figuratively) "create a texture of a certain size", "draw these symbols using the currently loaded font at certain positions" or "continue with commands in another file".

Thus the "chain" files may be seen as the "entry points" for execution of commands for a certain font. The way the texture creator searches for chain files is as follows: First, the font's directory is searched for chain files; this allows you to specify chains that are specific to the font. Only if no chain files are contained in the font's directory, all chains contained in the "scripts" directory are executed.

Chain files may execute commands contained in other files (".script" files). For instance, the default chain files in the scripts directory execute several script files containing commands for initializing the new texture, drawing basic symbols, special symbols, and so on. Note that the only difference between ".chain" and ".script" files is the file extension; the same set of commands is available in both chain and script files, but only files with the ".chain" extension are used as the entry points for script execution.

Note that, just like chain files, ".script" files are also searched for in the font's directory first, then in the global "scripts" directory. This, again, allows you to bundle custom script files specific to a certain font.

Each font sub-directory may also contain a "font.conf" file for font-specific configuration. These files are different from the chain and script files. They may contain font-specific offset and scaling settings, also for individual symbols of the respective font. Whenever a font is being loaded for drawing (also when it is loaded from other script files), that font's configuration is used.

After all commands in a chain file have been executed, the created texture is written out to the "output" directory. By default, the name of the font directory is used for the texture's name (plus the image format's extension), but that name may be changed using script commands.

== Script commands ==

''Will follow soon''

== How to obtain the tool ==

The Python 2 code is available at [http://github.com/furware/text/tree/master/TextureCreator GitHub].

Also, there is a pre-compiled package for Windows available from the [http://www.furware.de/products/text/TextureCreator.zip FURWARE website].

FURWARE text/de

2013-08-25T22:01:52Z

Ochi Wolfe:

FURWARE text/de

2013-08-25T22:01:22Z

Ochi Wolfe: Added texture creator link

{{LSL Header|ml=*}}

Diese Seite ist auch [[FURWARE_text|auf englisch]] verfügbar. / This page is also available [[FURWARE_text|in English]].

== Übersicht ==

FURWARE text ist ein '''Skript zur Darstellung von Text''' mittels Texturen auf Prims. Es ist zum '''Einbau in deine Objekte''' gedacht in denen es von '''deinen eigenen Skripten''' gesteuert wird.

FURWARE text '''ist keine''' vorgefertigte Anzeigetafel sondern ist für '''Skripter''' gedacht, die es in ihre eigene Kreationen integrieren.

Das Skript war von 2010 bis Juli 2013 proprietär bis ich ({{User|Ochi Wolfe}}) mich dazu entschieden habe, es Open Source unter der MIT-Lizenz zu machen. Dies ist mein erster Versuch eines vollständig offenen Produkts in Second Life.

== Merkmale ==

* '''Open source''' (MIT license)
* '''Nur ein Skript''' für eine ganze Gruppe ("sets") von Anzeigetafeln
* '''Formatierung''' (Farbe, Alpha, Ausrichtung, Umbruch, Trimming, Font, Rahmen)
* '''Mesh prims''' mit 1-8 Zeichen, die je nur 0.5 Prims belegen
* '''Virtuelle Text-Boxen''' um Text beliebig zu Positionieren
* '''Style templates''' um mehrere Stileinstellungen zusammenzufassen

== Wo du das Skript bekommst ==

Du kannst dir ein komplettes Paket inklusive dem Display Creator, Meshes und Schrift-Texturen auf [http://marketplace.secondlife.com/p/FURWARE-text/141379 dem Marketplace] holen.

Für Entwickler und interessierte Benutzer habe ich für die Skripte außerdem einen Account auf [http://github.com/furware/text GitHub] erstellt.

== Dokumentation ==

Unter den folgenden Unterseiten findest du eine Bedienungsanleitung sowie Dokumentation für Entwickler:

[[FURWARE_text/Tutorial/de|Erste Schritte & ausführliches Tutorial]]

[[FURWARE_text/Reference/de|Kurzreferenz & Versionsgeschichte]]

[[FURWARE_text/Snippets/de|Hilfsfunktionen für einfachere Verwendung]]

[[FURWARE_text/Developers/de|Dokumentation für Entwickler]]

== Texture creator ==

Auf [[FURWARE_text/TextureCreator|dieser]] Seite findest du mehr Informationen zum "texture creator", mit dem du deine eigenen Schrifttexturen erstellen kannst.

== Wie du helfen kannst ==

'''Für Anwender:''' Eine wichtige Hilfe bei der Entwicklung dieses Skripts ist das Berichten von Problemen bei seiner Verwendung sowie Vorschläge, wie man die Benutzung noch besser machen kann. Momentan sind die wahrscheinlich besten Möglichkeiten hierfür {{User|Ochi Wolfe}} eine Notecard zu schreiben oder deine Kommentare zur Diskussion dieser Wiki-Seite hinzuzufügen.

'''Für Entwickler:''' Wenn du Vorschläge für die Verbesserung des Skripts hast kannst du diese gerne auf dieselbe Weise kundtun. Alternativ kannst du aber auch gerne einen Branch des Projekts auf [http://github.com/furware/text GitHub] erstellen und Pull-Requests senden. Bitte stelle sicher, dass die Änderungen von sehr guter Qualität sind und sie das Skript nicht weiter aufblähen als es sowieso schon ist. Genauergesagt sind Vorschläge zur Verbesserung der Performance und Senkung des Speicherverbrauchs '''äußerst''' gern gesehen.

== Bekannte Probleme ==

Für die aktuelle Version sind keine Probleme bekannt. Falls welche auftreten, melde dies bitte.

== To do ==

Siehe bitte die [[FURWARE_text|englische Version dieser Seite]].

FURWARE text

2013-08-25T21:58:47Z

Ochi Wolfe: Added texture creator link

FURWARE text/TextureCreator

2013-08-25T21:55:20Z

Ochi Wolfe:

{{LSL Header|ml=*}}

The FURWARE texture creator is a tool to generate font textures from TrueType/OpenType font files. It is currently under development and documentation will follow soon.

You can get the Python 2 source code at [http://github.com/furware/text/tree/master/TextureCreator].

Also, there is a pre-compiled package for Windows available at [http://www.furware.de/products/text/TextureCreator.zip].

FURWARE text/TextureCreator/de

2013-08-25T21:53:43Z

Ochi Wolfe: Initial version

{{LSL Header|ml=*}}

FURWARE texture creator ist ein Programm zur Erstellung von Schrifttexturen aus TrueType-/OpenType-Dateien. Es befindet sich momentan in der Entwicklung und eine Anleitung folgt bald.

Du kannst den Python 2-Code unter [http://github.com/furware/text/tree/master/TextureCreator] beziehen.

Außerdem ist ein vorkompiliertes Paket für Windows unter [http://www.furware.de/products/text/TextureCreator.zip] verfügbar.

FURWARE text/TextureCreator

2013-08-25T21:49:10Z

Ochi Wolfe: Initial version

{{LSL Header|ml=*}}

The FURWARE texture creator is a tool to generate font textures from TrueType/OpenType font files. It is currently under development and documentation will follow soon.

You can get raw the Python 2 code at [http://github.com/furware/text/tree/master/TextureCreator].

Also, there is a pre-compiled "convenience package" for Windows available at [http://www.furware.de/products/text/TextureCreator.zip].

FURWARE text/Reference/de

2013-07-20T12:11:55Z

Ochi Wolfe: /* Versionsgeschichte */

{{Multi-lang}}

== Kurzreferenz ==

Dieses Kapitel ist als eine knappe Zusammenfassung aller Dinge gedacht, die zur Arbeit mit FURWARE text nötig sind. Das sind vor allem die Namen und Parameter der verschiedenen Befehle. Das Kapitel ist nicht als Ersatz für das Tutorial gedacht.

=== Befehle ===

==== fw_data & fw_conf ====

Box-Einstellung für Text (fw_data) und Stil (fw_conf)

<lsl>
llMessageLinked(LINK_SET, 0, "Some new text", "fw_data : BoxSpec : BoxSpec : BoxSpec : ...");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_conf : BoxSpec : BoxSpec : BoxSpec : ...");
</lsl>

Jedes "'''BoxSpec'''" kann hierbei verschiedene Formen haben um verschiedene Boxen auszuwählen. Seien in der folgenden Tabelle "BoxOne" und "BoxTwo" zwei gültige Box-Namen aus demselben Display-Set:

{|{{Prettytable}}
! BoxSpec
! Bedeutung
|-
| (leer)
| Alle Boxen in allen Sets.
|-
| BoxOne
| Genau die Box "BoxOne".
|-
| BoxOne ; BoxTwo
| Alle Boxen zwischen* (und inklusive) "BoxOne" und "BoxTwo".
|-
| BoxOne ;
| "BoxOne" und alle folgenden* Boxen im selben Display-Set.
|-
| ; BoxTwo
| "BoxTwo" und alle davorliegenden* Boxen im selben Display-Set.
|}

(*) Abhängig von der Reihenfolge, in denen die Boxen hinzugefügt wurden.

==== fw_defaultconf ====

Setzt globale Stilvoreinstellungen

<lsl>
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf : root");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf : nonroot");
</lsl>

Die drei Varianten setzen die Stilvoreinstellung für alle Boxen, alle Root-Boxen bzw. alle Nicht-Root-Boxen.

==== fw_var ====

Speichert einen String in einem "Variablennamen". Dies wird momentan nur für Stilvorlangen verwendet.

<lsl>
llMessageLinked(LINK_SET, 0, "Some string", "fw_var : varName");
</lsl>

Setzt den Inhalt der Variable "varName" auf "Some string". Variablen können gelöscht werden, indem ihnen der leere String zugewiesen wird.

==== fw_addbox ====

Fügt eine neue virtuelle Textbox hinzu. Es kann höchstens 16 Boxen pro Set (inklusive der Basis-Box) geben.

<lsl>
llMessageLinked(LINK_SET, 0, "Some initial text", "fw_addbox : boxName : parentName : dx, dy, sx, sy : stylePrefs");
</lsl>

Siehe das Tutorial für Details.

==== fw_delbox ====

Löscht eine oder mehrere Textboxen.

<lsl>
llMessageLinked(LINK_SET, 0, "", "fw_delbox : boxOne : boxTwo : ...");
</lsl>

Löscht die Textboxen "boxOne", "boxTwo", usw.

==== fw_touchquery ====

Führt eine Anfrage aus, welche Box wo geklickt wurde.

<lsl>
llMessageLinked(LINK_SET, 0, "userData", "fw_touchquery : linkNumber : faceNumber");
</lsl>

Die Antwort hat die Form (Pseudo-Code):

<lsl>
link_message(..., ..., "boxName:dx:dy:rootName:x:y:userData", "fw_touchreply") {
...
}
</lsl>

Siehe das Tutorial für Details.

==== fw_notify ====

Aktiviere oder deaktiviere Benachrichtigungen per Link Message wenn das Aktualisieren der Anzeige fertig ist. Standardmäßig aus.

<lsl>
llMessageLinked(LINK_SET, 0, "on", "fw_notify");
llMessageLinked(LINK_SET, 0, "off", "fw_notify");
</lsl>

Wenn die Benachrichtigungen aktiviert sind, sendet das Textskript eine Link Message in welcher "id" auf "fw_done" gesetzt ist wenn alle ausstehendenen Aktualisierungen der Anzeige durchgeführt wurden.

==== fw_memory ====

Teilt dem Besitzer des Objekts mit wie viel Speicher verfügbar ist.

<lsl>
llMessageLinked(LINK_SET, 0, "", "fw_memory");
</lsl>

==== fw_reset ====

Setzt das Textskript vollständig zurück.

<lsl>
llMessageLinked(LINK_SET, 0, "", "fw_reset");
</lsl>

{{KBtip|Wenn das Zurücksetzen abgeschlossen ist sendet das Skript an alle Prims eine Link Message, in der der "id"-Parameter auf "fw_ready" gesetzt ist. Dadurch weiß man wann das Skript wieder Befehle entgegennehmen kann.}}

{{KBcaution|Setze das Skript nur zurück wenn es nötig ist. Die Initialisierung ist eine relativ aufwendige Operation und das Textskript ist für einen Moment nicht verfügbar.}}

=== Style settings ===

Stil- und Formateinstellungen werden durch spezielle Strings angegeben. Diese werden für globale Einstellungen, Einstellungen pro Box ("fw_conf") und für Einstellungen direkt im Text (inline) verwendet.

Eine einzelne Einstellung wird als '''key=value'''-Paar angegeben, z.B. '''c=red'''.

Mehrere Einstellungen werden durch "''';'''" getrennt, z.B. '''c=red; a=center; w=none'''.

In der folgenden Tabelle: ''Kursiv'' = Standardwert

{|{{Prettytable}}
! Einstellung
! Schlüssel
! Werte
! Beschreibung
|-
| Schriftfarbe
| c
| R,G,B
| Schriftfarbe als Rot, Grün, Blau (jeweils im Bereich 0.0-1.0)
|-
|
|
| R,G,B,A
| Schriftfarbe als Rot, Grün, Blau, Alpha (jeweils im Bereich 0.0-1.0)
|-
|
|
| rand
| Zufällige Farbe (mit Alpha = 1)
|-
|
|
| (vordefiniert)
| Vordefinierte Farbe, siehe Tabelle unten
|-
| Ausrichtung
| a
| ''left''
| Ausrichtung links
|-
|
|
| center
| Ausrichtung zentriert
|-
|
|
| right
| Ausrichtung rechts
|-
| Umbruch
| w
| ''word''
| Möglichst nach Wörtern umbrechen
|-
|
|
| char
| An jeder beliebigen Stelle umbrechen
|-
|
|
| none
| Kein Umbruch; schneidet überlange Zeilen ab
|-
| Trimmen
| t
| ''on''
| Schneidet Leerzeichen von Anfang und Ende jeder Zeile ab
|-
|
|
| off
| Behält Leerzeichen bei (außer bei wrap=word)
|-
| Schriftart
| f
| (UUID/name)
| Setzt die Schrift-Textur auf UUID oder Name
|-
| Rahmen
| border
| {trblTRBL12}
| Stellt den Rahmen von Boxen ein
|-
| Stilvorlage
| style
| (Style name)
| Verwendet einen mit fw_var definierten Stil
|-
| Inline styles
| tags
| ''on''
| Aktiviert die Verwendung von inline styles
|-
|
|
| off
| Deaktiviert die Verwendung von inline styles
|-
| Force refresh
| force
| on
| Aktiviert die erzwungene Aktualierung aller Faces (deaktiviert Optimierungen!)
|-
|
|
| ''off''
| Deaktiviert die erzwungene Aktualisierung alles Faces (ermöglicht Optimierungen)
|}

=== Vordefinierte Farben ===

Du kannst die Folgenden Namen anstelle von vektoriellen Farbangeben in Stilen verwenden.

[[File:FURWARE_text_colors.png]]

=== Schriftarten ===

Die hier angegebenen Schriftarten kannst du mit der "'''f=...'''"-Stilangabe entweder durch Angabe ihrer UUID verwenden oder indem du die zugehörige Textur (diese sind Teil des FURWARE text-Pakets) in dein Objekt legst und dann den Texturnamen benutzt.

[[File:FURWARE_text_fonts.png]]

== Versionsgeschichte ==

'''2.0.1'''

* Fehler behoben, der beim Anzeigen von Zeichen, die nicht in der Textur-Spezifikation enthalten sind, unerwartetes Verhalten verursachen konnte.
* Der Set Pointer einer Box wird jetzt bit-packed zusammen mit dem restlichen Box Status gespeichert. Das verkürzt die Länge eines Strides in boxDataList um 1.
* Nachricht über freien Speicher beim Skript-Start entfernt.
* getNumberOfPrims()-Funktion entfernt.
* Der Test, ob wenigstens ein Set verfügbar ist, wurde an den Anfang des link_message()-Handlers verschoben.

'''2.0'''

* Das Skript wurde unter der MIT-Lizenz als Open Source veröffentlicht.

'''2.0-Beta1'''

* Die Funktionalität von "fw_data" und "fw_conf" wurde überarbeitet um sie (hoffentlich) intuitiver zu machen.
* Mit den Befehlen "fw_data", "fw_conf" und "fw_delbox" können nun auch mehrere Boxen auf einmal modifiziert werden.
* Befehl "fw_defaultconf" hinzugefügt. Momentan für globale Stileinstellungen verwendet.
* Touch replies liefern jetzt auch den Namen der Root-Box und die absoluten Koordinaten.
* Stilattribut "force" hinzugefügt um stets alle Faces zu aktualisieren (nützlich für Schriften in denen das Leerzeichen nicht vollständig transparent ist).
* Optimierte Verarbeitung wenn mehrere "ähnliche" Befehle (z.B. "fw_delbox") schnell hintereinander ankommen.
* Überprüfung hinzugefügt ob das Board überhaupt erfolgreich initialisiert wurde bevor Befehle angenommen werden.

'''2.0-Beta0'''

* Mesh Prims mit bis zu 8 Buchstaben pro Prim, die jeweils 0.5 Prims belegen
* Virtuelle Text-Boxen um Text beliebig zu positionieren
* Style templates zum Speichern von Formatierungseinstellungen

'''1.1'''

* Die Entwicklerversion erlaubt jetzt eine Weitergabe entweder als +copy/-trans oder -copy/+trans

'''1.0.1'''

* Geschwindigkeit verbessert

'''1.0'''

* Erste veröffentlichte Version

FURWARE text/Reference

2013-07-20T12:07:57Z

Ochi Wolfe: /* Version history */

{{Multi-lang}}

== Reference manual ==

This chapter is meant to be a quick overview of pretty much everything necessary to use FURWARE text, especially which names and parameters go where. It is '''not''' meant to replace the tutorial in any way.

=== Commands ===

==== fw_data & fw_conf ====

Per-box settings for text (fw_data) and style (fw_conf)

<lsl>
llMessageLinked(LINK_SET, 0, "Some new text", "fw_data : BoxSpec : BoxSpec : BoxSpec : ...");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_conf : BoxSpec : BoxSpec : BoxSpec : ...");
</lsl>

Each "'''BoxSpec'''" can have different forms to select different boxes. In the following table, let "BoxOne" and "BoxTwo" be two valid box names in the same display set:

{|{{Prettytable}}
! BoxSpec
! Meaning
|-
| (empty)
| All boxes in all sets.
|-
| BoxOne
| Only the box "BoxOne".
|-
| BoxOne ; BoxTwo
| All Boxes between* (and including) "BoxOne" and "BoxTwo".
|-
| BoxOne ;
| "BoxOne" and all following* boxes in the same display set.
|-
| ; BoxTwo
| "BoxTwo" and all preceding* boxes in the same display set.

|}

(*) Depending on the order in which the boxes were added.

==== fw_defaultconf ====

Sets global style preferences

<lsl>
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf : root");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf : nonroot");
</lsl>

The three variants set the global style preferences for all boxes, all root-boxes and all non-root boxes.

==== fw_var ====

Store some string data in a "variable" name. Currently only used for style templates.

<lsl>
llMessageLinked(LINK_SET, 0, "Some string", "fw_var : varName");
</lsl>

Sets the contents of variable "varName" to "Some string". You can delete variables by passing the empty string as data.

==== fw_addbox ====

Adds a new virtual text box. There can be at most 16 boxes per set (including the root box).

<lsl>
llMessageLinked(LINK_SET, 0, "Some initial text", "fw_addbox : boxName : parentName : dx, dy, sx, sy : stylePrefs");
</lsl>

Please see the tutorial for details.

==== fw_delbox ====

Deletes one or more text boxes.

<lsl>
llMessageLinked(LINK_SET, 0, "", "fw_delbox : boxOne : boxTwo : ...");
</lsl>

Deletes the boxes named "boxOne", "boxTwo", etc.

==== fw_touchquery ====

Performs a query which box has been touched where.

<lsl>
llMessageLinked(LINK_SET, 0, "userData", "fw_touchquery : linkNumber : faceNumber");
</lsl>

The reply has the form (pseudo code):

<lsl>
link_message(..., ..., "boxName:dx:dy:rootName:x:y:userData", "fw_touchreply") {
...
}
</lsl>

Please see the tutorial for details.

==== fw_notify ====

Enable or disable link message notifications when the script has done rendering. Off by default.

<lsl>
llMessageLinked(LINK_SET, 0, "on", "fw_notify");
llMessageLinked(LINK_SET, 0, "off", "fw_notify");
</lsl>

When notifications are enabled, the text script will send a link message with "id" set to "fw_done" to the whole linkset to let you know when all pending rendering actions have been completed.

==== fw_memory ====

Tells the owner how much memory is available.

<lsl>
llMessageLinked(LINK_SET, 0, "", "fw_memory");
</lsl>

==== fw_reset ====

Performs a full reset on the text script.

<lsl>
llMessageLinked(LINK_SET, 0, "", "fw_reset");
</lsl>

{{KBtip|When the reset has completed, the script sends a link message with "id" set to "fw_ready" to all prims in the linkset. This tells you when the script is ready to take further commands.}}

{{KBcaution|Only reset the text script if necessary. Initialization is a quite expensive operation and the script will not be available to take commands for a few seconds.}}

=== Style settings ===

Text styles and format settings are specified using special strings. They are used for global and per-box settings ("fw_conf") as well as for specifying styles directly within the text (inline styles).

A single setting is given as a '''key=value''' pair, for example '''c=red'''.

Multiple settings are separated by "''';'''", for example '''c=red; a=center; w=none'''.

In the following table: ''Italic'' = Default

{|{{Prettytable}}
! Setting
! Key
! Values
! Description
|-
| Font color
| c
| R,G,B
| Font color as red, green, blue (each in range 0.0-1.0)
|-
|
|
| R,G,B,A
| Font color as red, green, blue, alpha (each in range 0.0-1.0)
|-
|
|
| rand
| Random color (with alpha = 1)
|-
|
|
| (predefined)
| Predefined color, see table below
|-
| Alignment
| a
| ''left''
| Alignment left
|-
|
|
| center
| Alignment centered
|-
|
|
| right
| Alignment right
|-
| Wrapping
| w
| ''word''
| Wrap after words, if possible
|-
|
|
| char
| Wrap at any position
|-
|
|
| none
| No wrapping; cuts overlong lines
|-
| Trimming
| t
| ''on''
| Trims whitespace from beginning and end of lines
|-
|
|
| off
| Keeps whitespace (except with wrap=word)
|-
| Font
| f
| (UUID/name)
| Sets the font texture to UUID or name
|-
| Borders
| border
| {trblTRBL12}
| Specifies the style of box borders
|-
| Style template
| style
| (Style name)
| Uses a style defined using fw_var
|-
| Inline styles
| tags
| ''on''
| Enables usage of inline styles
|-
|
|
| off
| Disables usage of inline styles
|-
| Force refresh
| force
| on
| Enables forced refresh of all faces (disables optimizations!)
|-
|
|
| ''off''
| Disables forced refresh of all faces (enables optimizations)
|}

=== Predefined colors ===

You may use the following names in place of color vectors in styles.

[[File:FURWARE_text_colors.png]]

=== Fonts ===

You can use the fonts listed here with the "'''f=...'''" style setting either by using their UUID or by putting the corresponding texture item (included in the FURWARE text package) into your object and then use the texture's name.

[[File:FURWARE_text_fonts.png]]

== Version history ==

'''2.0.1'''

* Fixed an issue where characters that are not part of the font texture specification would cause unexpected behavior.
* A box's set pointer is now stored bit-packed together with the rest of its status. This decreases the length of a stride in boxDataList by 1.
* Removed message about free memory on script startup.
* Removed getNumberOfPrims()-function.
* Moved the check if we have any sets at all to the beginning of the link_message()-handler.

'''2.0'''

* Made the script open source under the MIT license.

'''2.0-Beta1'''

* The functionality of "fw_data" and "fw_conf" has been reworked to (hopefully) make it more intuitive.
* The commands "fw_data", "fw_conf", and "fw_delbox" are now able to modify multiple boxes at once.
* Added "fw_defaultconf" command. Currently used to configure global style settings.
* Touch replies now also contain the name of the root box and the absolute coordinates.
* Added "force" style attribute to force refresh of all faces (useful for fonts where whitespace is not completely transparent).
* Optimized handling when multiple "similar" commands (e.g. "fw_delbox") come in quickly.

'''2.0-Beta0'''

* Mesh prims with up to 8 characters per prim, each occupying 0.5 prims
* Virtual text boxes for aligning text arbitrarily
* Style templates for saving format settings

'''1.1'''

* The developer version now allows distribution of the script as +copy/-trans or -copy/+trans

'''1.0.1'''

* Improved speed

'''1.0'''

* First released version

FURWARE text/Developers/de

2013-07-20T12:04:57Z

Ochi Wolfe: Updated to reflect changes in v2.0.1

{{Multi-lang}}

Diese Seite beinhaltet technische Informationen zu [[FURWARE_text/de|FURWARE text]] und richtet sich an Entwickler und interessierte Benutzer.

{{KBtip|Wenn du mehr zu einem bestimmten Thema wissen möchtest, hinterlasse bitte eine Notiz auf der Diskussionsseite. :)}}

== Terminologie und Hierarchien ==

Ein "'''Set'''" bezeichnet ein Text-Display, das aus in Zeilen und Spalten angeordneten Prims besteht. Jedes Set hat einen Namen, der in der Regel mithilfe des Display Creators gesetzt wird. Ein Linkset kann mehrere Sets enthalten.

Eine "'''Box'''" ist eine virtuelle Text-Box innerhalb eines Sets. Jedes Set hat immer eine (Root-)Box mit derselben Größe und demselben Namen wie das Set. Jeder Box wird beim Erstellen ein Name zugewiesen (per Parameter des ''fw_addbox''-Befehls). Zu einem Set können mehrere Boxen hinzugefügt werden, die dann in Layern übereinandergelegt dargestellt werden (in der Reihenfolge, in der sie hinzugefügt wurden).

Daraus folgen einige Zusammenhänge:

* Eine Box ist immer Teil von einem Set und liegt vollständig innerhalb von diesem.
* Ein Set besteht aus einem oder mehreren Prims.
* Ein Prim kann mehrere Faces haben.
* Jedes Face stellt ein Zeichen des Texts dar.

Der Text-Inhalt einer Box wird oft als "'''data'''" der Box bezeichnet ("data" wird aber auch in allgemeinerem Zusammenhang verwendet).

Der Text-Stil einer Box (oder Textabschnitten) wird oft als "'''conf'''" (der Box) bezeichnet.

== Datenstrukturen für Box-, Set- und Prim-Informationen ==

Die meisten Informationen zur Geometrie und zum Inhalt des Displays werden in einigen [[list|Listen]] gespeichert. Einige [[list|Listen]] enthalten auch Indizes ("Pointer") zu Daten in anderen [[list|Listen]].

=== Box-Informationen ===

* "boxNameList" ist eine einfache [[list|Liste]] der Namen aller Boxen. Der Grund dafür, dass die Namen in einer separaten [[list|Liste]] vorgehalten werden (und nicht als Teil von "boxDataList", siehe unten) ist, dass die Namen schnell durchsuchbar sein sollen. Das ist beispielsweise nötig wenn neuer Text gesetzt werden soll und der Index einer Box ermittelt werden muss anhand ihres Namens.

* "boxDataList" ist eine [[:Category:LSL_List#Strided_lists|Strided List]], die mehr Informationen zu jeder Box enthält. Ein Stride enthält:
** Den Text der Box ([[string]]).
** Die Textstil-Einstellung der Box ([[string]]).
** Einen bit-packed [[integer]], der den Layer der Box (4 Bits), den Index des Sets, zu dem die Box gehört (8 Bits), dirty flags (2 bits), zwei reservierte Bits und die "Layer Override"-Bits (16 Bits) enthält.
** Die Geometrie der box (Spalten-Offset, Zeilen-Offset, Breite, Höhe) ([[rotation]]).

=== Set-Informationen ===

* "setDataList" ist eine [[:Category:LSL_List#Strided_lists|Strided List]], die Informationen zu jedem Set enthält. Ein Stride enthält:
** Die Geometrie des Sets (Anzahl von Prim-Spalten und -Zeilen, Anzahl der Faces) ([[vector]]).
** Einen Pointer zum Beginn der Prim-Informationen in den "prim*List"-Listen ([[integer]]).

=== Prim-Informationen ===

* "primLinkList" enthält die Link-Nummern der einzelnen Prims, sortiert zuerst nach Set, dann nach Zeilen, dann nach Spalten. Die Link-Nummern sind nicht bit-packed, weil sie schnell durchsuchbar sein sollen, etwa wenn Touch Queries bearbeitet werden.

* "primFillList" enthält bit-packed Integer, die den Status der einzelnen Faces auf den Prims enthalten. "Der Status" bedeutet hier, ob die Faces momenten ein Leerzeichen anzeigen oder nicht. Diese Information wird als Cache benutzt um unnötige SetPrimitiveParams-Aufrufe zu vermeiden.

* "primLayerList" enthält bit-packed Integer, die die Zuordnung von Faces zu Layern beinhaltet. Die 32 Bits des Integers sind dabei in je 4 Bits für jedes Face geteilt und somit kann jedem Face eine von 16 Layer-IDs zugeteilt werden. Diese Information wird während des Renderns verwendet um schnell feststellen zu können, welcher Layer an der Position dieses Faces gerade im Vordergrund liegt.

== Grundlegender Ablauf der Events ==

Das folgende Bild ist ein Versuch, die grundlegenden Zusammenhänge von Events und Funktionen im FURWARE text-Skript darzustellen, wenn ein Befehl empfangen wird, der den Inhalt oder das Layout des Displays verändert (eine deutsche Übersetzung folgt).

[[File:FURWARE_text_basic_event_flow.png]]

== Die Initialisierungs-Routine ==

''To do''

== Der [[link_message]](...)-Handler ==

''To do''

== Die setDirty(...)-Funktion ==

Diese Funktion steht zwischen dem Entgegennehmen von Befehlen in [[link_message]](...) und dem tatsächlichen (Neu-)Zeichnen in refresh(...). Sie besitzt folgende Parameter:

=== ''[[integer]]'' action ===

Kann einen der Werte der Konstanten ACTION_CONTENT, ACTION_ADD_BOX oder ACTION_DEL_BOX annehmen. Dieser Wert gibt an, welche ''Art'' von Kommando ausgeführt werden soll (beispielsweise ist das Setzen von neuem Text von der Art ACTION_CONTENT). Der übergebene Wert wird als globale Variable gespeichert und beim nächsten Aufruf von refresh(...) wieder zurückgesetzt.

Der Grund dafür, dass wir uns diesen Wert merken, ist das ''zeitverzögerte Aktualisieren'' des Displays (welches im Übrigen einer der Gründe ist, weshalb setDirty(...) als Puffer zwischen Parsen und Refreshen überhaupt eingebaut wurde). Am Ende von setDirty(...) wird ein Timer mit einem recht kurzen Intervall gestartet. Das [[timer]]()-Event ruft dann lediglich refresh() auf. Allerdings können in dieser kurzen Zeit noch weitere [[link_message]](...)-Events empfangen und verarbeitet werden, was uns erlaubt, mehrere Befehle zu sammeln bevor wir das Display tatsächlich aktualisieren (beispielsweise das Setzen von Text mehrerer verschiedener Boxen). Dies kann in manchen Situationen einen großen Geschwindigkeitsvorteil bringen. Beachte, dass der Timer nicht neugestartet wird, wenn die letzte Aktion bereits auf etwas anderes als [[FALSE|0]] gesetzt ist. Das "garantiert" uns, dass das [[timer]]()-Event irgendwann ausgeführt wird, selbst wenn wir einen konstanten Strom von Befehlen empfangen.

''Es gibt allerdings einen Haken an der Sache.'' Wenn wir alle verschiedenen Arten von Befehlen wie das Setzen von Text, Stilen, Variablen, das Hinzufügen und Entfernen von Boxen sammeln würden ohne zu geeigneten Zeitpunkten zu aktualisieren, würden wir irgendwann ein Durcheinander und kaputte Datenstrukturen haben (du darfst gerne über die Details nachdenken, aber es verursacht Kopfschmerzen). Hier kommt die Unterscheidung zwischen den verschiedenen Arten von Aktionen ins Spiel.

Operationen, die lediglich den "Inhalt" von Boxen verändern sind gewissermaßen "kompatibel" zueinander und können gesammelt werden, da die Indizes der Listen mit Box-Informationen und der Layer während der Änderungen ''konstant'' bleiben. Operationen, die ''Boxen hinzufügen'' können ebenfalls gesammelt werden, da die Informationen lediglich zu einigen [[list|Listen]] hinzugefügt werden und wir dann die neuen Boxen auf einmal aktualisieren können. Operationen, die ''Boxen löschen'' können gesammelt werden, da wir uns im Grunde nur merken müssen, welche Layer wieder freigeworden sind. Anschließend können wir durch die verbliebenen Boxen gehen und diese entsprechend neu zeichnen.

Da das ''Mischen'' der verschiedenen Arten von Operationen ''ungut'' ist, prüft der Handler wenn ein neuer Befehl hereinkommt, ob die neue Operation mit der vorherigen kompatibel ist (das heißt, "Art der letzten Operation" == "Art der neuen Operation") und wenn sie dies nicht ist, wird ein ''sofortiges'' Aktualisieren erzwungen bevor der Befehl verarbeitet wird. Beachte, dass nur die ''Art'' der Operation gleich sein muss, nicht der genaue Befehl; beispielsweise sind die Befehle fw_data und fw_conf zueinander kompatibel, da beide den Typ ACTION_CONTENT besitzen.

Beachte weiterhin, dass die Art der Operation die Arbeitsweise der refresh()-Funktion beeinflusst; bitte siehe den entsprechenden Abschnitt für Einzelheiten.

=== ''[[integer]]'' first / last ===

Das Intervall von Box-Indizes, auf denen gearbeitet werden soll. Dies erlaubt uns direkt auf einer ganzen Reihe von Boxen auf einmal zu arbeiten.

=== ''[[integer]]'' isConf ===

Kann entweder [[FALSE|0]] oder [[TRUE|1]] sein. Dieser Wert wird dazu benutzt um festzustellen, ob etwaig übergebene Daten als data oder conf der Box(en) gespeichert werden sollen. Außerdem wird das (Neu-)Zeichnen der Rahmen von Boxen erzwungen, wenn isConf [[TRUE|1]] ist, da sich dieser geändert haben könnte.

=== ''[[integer]]'' newLayerOverrideBits ===

An dieser Stelle wird es ein wenig knifflig. :) Bevor wir uns um den Sinn dieses Wertes kümmern, hier einige Fakten: Dieser Parameter sollte nur Nicht-Null sein, wenn Boxen hinzugefügt oder entfernt werden. Der Wert wird bit-packed als Teil des Status der Boxen in boxDataList gespeichert und am Ende von refresh() wieder gelöscht. Der Wert selbst ist 16 Bits lang und jedes Bit steht für einen der 16 möglichen Layer innerhalb eines Sets. Beispielsweise bedeutet ein Wert von 0xFFFF (binär 1111111111111111) "alle Layer" während ein Wert von 0x4 (binär 0000000000000100) "Layer 2" bedeutet (von 0 beginnend gezählt).

Der Wert wird in der draw(...)-Funktion verwendet, welche an verschiedenen Stellen in refresh() benutzt wird um ein Zeichen auf eine Face zu zeichnen. Normalerweise holt sich draw(...) die ID des Layers, der sich an der Position des Face gerade im Vordergrund befindet, sowie die ID des Layers der Box, die gerade gezeichnet werden soll. Wenn diese Layer-IDs ungleich sind, dann wird die Face nicht verändert, da die zu zeichnende Box an der Stelle nicht im Vordergrund ist.

Wenn wir jetzt aber eine Box hinzufügen oder entfernen, dann kann sich die Information, welche Layer an welchen Stellen im Vordergrund sind, für einige Faces ändern. Das ist genau die Information, die uns die newLayerOverrideBits liefern. Wenn beispielsweise eine neue Box hinzugefügt wird, sind deren Override-Bits auf 0xFFFF gesetzt. Wenn diese Box nun gezeichnet wird, dann merkt die draw(...)-Funktion, dass sie alle anderen Layer überschreiben und die neue Box darüber zeichnen soll. Wenn eine Box entfernt wird ist die Logik ähnlich, allerdings werden nur bestimmte Bits gesetzt und die Reihenfolge des Refreshs wird umgedreht; siehe dazu auch den Abschnitt über die refresh()-Funktion.

=== ''[[integer]]'' setIndex ===

Erlaubt uns, das (Über-)Schreiben von Informationen auf Boxen eines bestimmten Sets einzuschränken. Ein Wert von -1 bedeutet, dass auf allen Sets gearbeitet werden soll.

=== ''[[integer]]'' withData ===

Gibt an, ob der "data"-Parameter (siehe unten) Daten enthält. Das erlaubt eine Unterscheidung zwischen dem leeren String und "keine Daten angegeben".

=== ''[[string]]'' data ===

Enthält entweder neuen Text oder neue Stil-Einstellungen zur Speicherung in boxDataList.

== Die refresh()-Funktion ==

Die refresh()-Funktion kann als das "Herz" des Text-Skripts angesehen werden. Sie wird entweder aufgerufen nachdem einige Änderungen gesammelt wurden oder wenn eine Aktualisierung während des Abarbeitens eines Befehls erzwungen werden muss.

Sie besteht hauptsächlich aus einer großen Schleife, die über alle Boxen iteriert und deren "Dirty"-Bit prüft. Wenn eine Box als dirty markiert ist, werden ihre Informationen (Text, Stil, Geometrie) geladen und zum Zeichnen vorbereitet.

'''Ein paar Worte zur Reihenfolge der Schleife:''' Normalerweise werden die Boxen in der ''umgekehrten'' Reihenfolge, in der sie hinzugefügt wurden, durchgegangen. Das bedeutet, dass die Boxen "von oben nach unten" aktualisiert werden (bezüglich der Layer). Allerdings gibt es eine Ausnahme: Wenn die Art des letzten Befehls ACTION_ADD_BOX war (siehe auch den "action"-Parameter von setDirty(...)), dann werden die Boxen ''in'' der Reihenfolge, in der sie hinzugefügt wurden, durchgegangen ("von unten nach oben"). Dies ist nötig um die Information, welche Layer auf welchen Faces gerade im Vordergrund sind, korrekt zu aktualisieren (siehe auch den "newLayerOverrideBits"-Parameter von setDirty(...)).

Zurück zur Schleife und dem "Dirty"-Bit. Genauergesagt gibt es zwei "Dirty"-Bits: Eines sagt uns, ob die Box überhaupt aktualisiert werden soll und ein zweites, ob außerdem die Rahmen der Box u.U. aktualisiert werden müssen. Wenn etwa lediglich der Text einer Box geändert wurde – aber nicht die Stileinstellungen – dann gibt es keinen Grund, den Rahmen neuzuzeichnen.

Der Text der Box wird dann in Teile zerlegt (an den Stellen wo Leerzeichen, Umbrüche, Stil-Markup auftreten) und eine innere Schleife iteriert durch diese Teile, welche wiederum Listen von einzelnen Zeichen und Stilinformationen, die direkt im Text gegeben sind, vorbereitet. Sobald eine Zeile an Daten vorbereitet ist (eine Zeile bedeutet hier eine Zeile von Prims), kümmert sich eine weitere kleine Schleife um das eigentliche Zeichnen auf die Faces. Anschließend wird mit der nächsten Zeile fortgefahren.

Nachdem eine Box aktualisiert wurde, werden ihre "Dirty"-Bits zurückgesetzt. Sobald alle Boxen fertig sind, wird die global gespeicherte Art der letzten Aktion zurückgesetzt und (falls die "Notification"-Option aktiviert ist) eine "fw_done"-Nachricht an das Linkset gesendet.

== Caching-Strategien ==

''To do''

FURWARE text/Developers

2013-07-20T12:00:02Z

Ochi Wolfe: Updated to reflect changes in v2.0.1

{{Multi-lang}}

This page contains technical information about [[FURWARE_text]] and is intended for developers and interested users.

{{KBtip|If you would like to get more info on specific topics, please leave a note on the discussion page. :)}}

== Terminology and hierarchy of entities ==

A "'''set'''" is a part of a text display consisting of display prims arranged in rows and columns. Each set has a name, usually assigned using the display creator tool. A linkset may contain multiple sets.

A "'''box'''" is a virtual text box within a set. Each set always has a (root) box of the size of the set. Each box has a name which is assigned via a parameter to the ''fw_addbox'' command. Additional boxes may be added to a set which are then stacked in layers, depending on the order in which the boxes were added.

This yields the following relations:

* A box is always part of (and fully contained within) a set.
* A set consists of one or more prims.
* A prim may have multiple faces.
* Each face shows one character of text.

The textual content of a box is often referred to as the box's "'''data'''" (note that "data" is sometimes also used with a more general meaning).

The text style configuration of a box (or parts of text) is often referred to as (the box's) "'''conf'''".

== The main data structure for box, set and prim data ==

Most of the information about the geometry and contents of the displays is stored in a few [[list|lists]]. Some [[list|lists]] contain indices ("pointers") to data in other [[list|lists]].

=== Box data ===

* "boxNameList" is a [[list]] containing the names of the boxes one after another. The reason for having the box names in a separate [[list]] (i.e. not part of "boxDataList", see below) is that the names shall be quickly searchable. For instance, when new text is received, the index of a box given its name must be retrieved.

* "boxDataList" is a [[:Category:LSL_List#Strided_lists|strided list]] containing more information about each box. One stride contains:
** The box's text content ([[string]]).
** The box's style configuration ([[string]]).
** A bit-packed [[integer]] containing the box's layer (4 bits), the index of the set the box is part of (8 bits), dirty flags (2 bits), two reserved bits and the layer override bits (16 bits).
** The box's geometry (column offset, row offset, width, height) ([[rotation]]).

=== Set data ===

* "setDataList" is a [[:Category:LSL_List#Strided_lists|strided list]] containing information about each set. One stride contains:
** The set's geometry (number of prim columns and rows, face count) ([[vector]]).
** A pointer to the start of the prim data stored in the "prim*List"-lists ([[integer]]).

=== Prim data ===

* "primLinkList" contains the link numbers of the prims, ordered by sets, rows and columns. The link numbers are not bit-packed because they shall be quickly searchable, e.g. when performing touch queries.

* "primFillList" contains bit-packed integers storing the state of each face on the respective prim. "The state" of a face means whether it is currently known to be showing whitespace or non-whitespace. This information is used as a cache to avoid SetPrimitiveParams-calls when not necessary.

* "primLayerList" contains bit-packed integers that store the assignment of faces to layers. The 32 bits of the integer are split into 4 bits for each face and thus each face may be assigned one of 16 different layer IDs. This information is used during rendering to quickly determine which layer a given face of a given prim belongs to.

== Basic flow of events ==

This images is an attempt to visualize the basic flow of events and functions inside FURWARE text when a command that modifies the layout or contents of the display is received.

[[File:FURWARE_text_basic_event_flow.png]]

== The initialization routine ==

''To do''

== The [[link_message]](...)-handler ==

''To do''

== The setDirty(...)-function ==

This functions stands between the parsing of commands in [[link_message]](...) and the actual rendering in refresh(...). The parameters are as follows:

=== ''[[integer]]'' action ===

One of the [[integer]] constants ACTION_CONTENT, ACTION_ADD_BOX or ACTION_DEL_BOX. This tells us what basic type of action shall be performed (for instance, setting new text is of type ACTION_CONTENT). This type is stored in a global variable and is reset in a call to refresh(...).

The reason for storing this information is the ''delayed refresh mechanism'' (which is in turn one of the reasons why setDirty(...) was introduced as a buffer between parsing and refreshing in the first place). At the end of setDirty(...), a timer is started with a quite short interval. The [[timer]]()-event merely calls refresh() once it fires. However, until then, more [[link_message]](...)-events may be received and parsed which basically allows us to aggregate multiple commands (for instance, setting text for different boxes) before starting an actual refresh. This can yield a huge performance gain in some situations. Note that the timer is not restarted if the last action is already set to something else than [[FALSE|0]] which "guarantees" that the timer will fire at some point, even if a constant stream of commands is received.

''However, there's a catch.'' If we would just go and postpone all kinds of actions like setting text, styles, variables, adding and deleting boxes, we would end up with a mess and destroyed data structures (think about the details if you like, but it will make your head hurt). This is where the distinction between the different types of operations comes into play.

Operations that merely modify the ''contents'' of boxes are in some sense ''compatible'' to each other and allow us to aggregate them because the indices of the box data lists and layers remain ''constant'' during any content modifications and refreshes. Operations that ''add boxes'' may also be aggregated, broadly speaking because data will only be appended to some data [[list|lists]] and we can then refresh a batch of newly added boxes at once. Operations that ''delete boxes'' may be aggregated and we basically remember which layers have been freed during these operations. After that, we can just sweep through the remaining boxes and refresh the display accordingly.

Because ''mixing'' these types operations is a ''bad thing'', each time a command is received, the handler checks whether the new operation is compatible with the last type of operation (that is, "last action type == new action type") and if it is not, an ''immediate'' refresh is forced before handling the command. Note that only the ''type'' of operation needs to be the same, not the exact command; for instance, fw_data and a fw_conf commands are compatible because they are both of type ACTION_CONTENT.

Note that the kind of action may also change the operation of the refresh()-function; please see the according section for details.

=== ''[[integer]]'' first / last ===

The interval of box indices to work on. This way we can operate on a whole range of boxes at once.

=== ''[[integer]]'' isConf ===

May be either [[FALSE|0]] or [[TRUE|1]]. Used for determining whether to store given data (if any) as the data or conf of the box(es). Also, if isConf is true, drawing of the border of the box(es) is forced on next refresh because the border style may have changed.

=== ''[[integer]]'' newLayerOverrideBits ===

This is where it gets a little tricky. :) Before we talk about how this value is used, a few facts: This parameter shall only be non-zero when adding or deleting boxes. It is stored bit-packed as part of the status of the box(es) in the boxDataList and is cleared after a refresh() is completed. The value itself is 16 bits long and each bit stands for one of the 16 layers available within a set. A value of 0xFFFF (binary 1111111111111111) thus means "all layers" and a value of 0x4 (binary 0000000000000100) means "layer 2" (counted from 0).

The value is used in the draw(...)-function which is called at several places in refresh() to draw a character to a face. Normally, draw(...) fetches the index of the layer that is currently in the foreground at the specified face as well as the layer of the box whose contents shall be drawn. If these two values are not equal, it will reject to update that face because the box to be drawn is not in the foreground.

Now if we added or removed a box, the stored information about which layers are in the foreground may change for some faces. This is just what the value of the newLayerOverrideBits tells us. For instance, when a box was added, the bits are set to 0xFFFF. Now when the newly added box is being drawn, the draw(...)-function will see that it is supposed to override any other layer and draw the new box on top. When deleting a box, the logic is similar, however only specific bits will be set and the order of the refresh routine is reversed; also see the section about the refresh()-function.

=== ''[[integer]]'' setIndex ===

Allows us to restrict writing data to boxes that are part of a certain set. A value of -1 means to operate on boxes belonging to any set.

=== ''[[integer]]'' withData ===

Tells us whether the data-parameter (see below) contains data to be stored. This allows us to differentiate between the empty string and "no data given".

=== ''[[string]]'' data ===

Contains either new text content or a new style config string that is to be stored in the boxDataList.

== The refresh()-function ==

The refresh()-function may be seen as the "heart" of the text script. It is either called after some changes have been aggregated or when a refresh needs to be forced during command handling.

It basically consists of a loop that iterates through all boxes and checks their "dirty" bit. If a box is marked dirty, its current data (text, style, geometry) is loaded and prepared for drawing.

'''A word on the order of iteration of this outer loop:''' Normally, the boxes are iterated in the ''reverse'' order in which they have been added. That means that boxes will be refreshed "top-to-bottom" (with respect to the layers). However, there is an exception: When the type of the last command(s) was ACTION_ADD_BOX (see the "action" parameter of setDirty(...)), the boxes are iterated ''in'' the order in which they were added to the board (bottom-to-top). This is necessary to correctly update the information which faces currently show what layer (also see the "newLayerOverrideBits" parameter of setDirty(...)).

Back to the main loop and the dirty bit. There are actually two dirty bits: One telling us that the box needs to be refreshed at all and one that the border of the box also needs to be refreshed. For instance, if only the text content of the box was changed – but not its style settings – then there is no need to bother with re-drawing the border.

The text of the box is split into parts (at whitespaces, newlines, style markup tags) and an inner loop iterates through these tokens which prepares lists of character indices and style information given right within the text as markup. Once a row worth of data has been prepared (row = a row of primitives), another small loop renders the text to the faces before data preparation for the next row begins.

After a box has been refreshed, its dirty bits are reset. When all boxes are done, the last action is also reset and (if the notification option is enabled) a "fw_done" message is emitted to the linkset.

== Caching strategies ==

''To do''

FURWARE text/de

2013-07-20T11:54:16Z

Ochi Wolfe:

{{LSL Header|ml=*}}

Diese Seite ist auch [[FURWARE_text|auf englisch]] verfügbar. / This page is also available [[FURWARE_text|in English]].

== Übersicht ==

FURWARE text ist ein '''Skript zur Darstellung von Text''' mittels Texturen auf Prims. Es ist zum '''Einbau in deine Objekte''' gedacht in denen es von '''deinen eigenen Skripten''' gesteuert wird.

FURWARE text '''ist keine''' vorgefertigte Anzeigetafel sondern ist für '''Skripter''' gedacht, die es in ihre eigene Kreationen integrieren.

Das Skript war von 2010 bis Juli 2013 proprietär bis ich ({{User|Ochi Wolfe}}) mich dazu entschieden habe, es Open Source unter der MIT-Lizenz zu machen. Dies ist mein erster Versuch eines vollständig offenen Produkts in Second Life.

== Merkmale ==

* '''Open source''' (MIT license)
* '''Nur ein Skript''' für eine ganze Gruppe ("sets") von Anzeigetafeln
* '''Formatierung''' (Farbe, Alpha, Ausrichtung, Umbruch, Trimming, Font, Rahmen)
* '''Mesh prims''' mit 1-8 Zeichen, die je nur 0.5 Prims belegen
* '''Virtuelle Text-Boxen''' um Text beliebig zu Positionieren
* '''Style templates''' um mehrere Stileinstellungen zusammenzufassen

== Wo du das Skript bekommst ==

Du kannst dir ein komplettes Paket inklusive dem Display Creator, Meshes und Schrift-Texturen auf [http://marketplace.secondlife.com/p/FURWARE-text/141379 dem Marketplace] holen.

Für Entwickler und interessierte Benutzer habe ich für die Skripte außerdem einen Account auf [http://github.com/furware/text GitHub] erstellt.

== Dokumentation ==

Unter den folgenden Unterseiten findest du eine Bedienungsanleitung sowie Dokumentation für Entwickler:

[[FURWARE_text/Tutorial/de|Erste Schritte & ausführliches Tutorial]]

[[FURWARE_text/Reference/de|Kurzreferenz & Versionsgeschichte]]

[[FURWARE_text/Snippets/de|Hilfsfunktionen für einfachere Verwendung]]

[[FURWARE_text/Developers/de|Dokumentation für Entwickler]]

== Wie du helfen kannst ==

'''Für Anwender:''' Eine wichtige Hilfe bei der Entwicklung dieses Skripts ist das Berichten von Problemen bei seiner Verwendung sowie Vorschläge, wie man die Benutzung noch besser machen kann. Momentan sind die wahrscheinlich besten Möglichkeiten hierfür {{User|Ochi Wolfe}} eine Notecard zu schreiben oder deine Kommentare zur Diskussion dieser Wiki-Seite hinzuzufügen.

'''Für Entwickler:''' Wenn du Vorschläge für die Verbesserung des Skripts hast kannst du diese gerne auf dieselbe Weise kundtun. Alternativ kannst du aber auch gerne einen Branch des Projekts auf [http://github.com/furware/text GitHub] erstellen und Pull-Requests senden. Bitte stelle sicher, dass die Änderungen von sehr guter Qualität sind und sie das Skript nicht weiter aufblähen als es sowieso schon ist. Genauergesagt sind Vorschläge zur Verbesserung der Performance und Senkung des Speicherverbrauchs '''äußerst''' gern gesehen.

== Bekannte Probleme ==

Für die aktuelle Version sind keine Probleme bekannt. Falls welche auftreten, melde dies bitte.

== To do ==

Siehe bitte die [[FURWARE_text|englische Version dieser Seite]].

FURWARE text

2013-07-20T11:51:03Z

Ochi Wolfe:

{{LSL Header|ml=*}}

This page is also available [[FURWARE_text/de|in German]]. / Diese Seite ist auch [[FURWARE_text/de|auf deutsch]] verfügbar.

== Overview ==

FURWARE text is a '''script for displaying text''' on prims using textures. It is intended to be '''integrated in your objects''' in which it will be controlled by '''your own scripts'''.

FURWARE text '''is not''' a ready-made display board but is intented for '''scripters''' who wish to integrate it in their own creations.

The script was proprietary from 2010 to July 2013 until I ({{User|Ochi Wolfe}}) have decided to make it open source under the MIT license. It is my first attempt to make a fully open sourced product in Second Life.

== Features ==

* '''Open source''' (MIT license)
* '''Only one script''' for a whole group ("sets") of displays
* '''Formatting''' (color, alpha, alignment, wrapping, trimming, font, borders)
* '''Mesh prims''' with 1 to 8 chars, only occupying 0.5 prims each
* '''Virtual text boxes''' to position text arbitrarily
* '''Style templates''' for encapsulating multiple style settings

== How to obtain the script ==

You can obtain a complete package containing the script, the display creator, display meshes and font textures at [http://marketplace.secondlife.com/p/FURWARE-text/141379 the Marketplace].

For developers and interested users, I have also set up a [http://github.com/furware/text GitHub] account for the core scripts.

== Documentation ==

Please see the following subpages for the user's manual and developer documentation:

[[FURWARE_text/Tutorial|First steps & extensive tutorial]]

[[FURWARE_text/Reference|Short reference & version history]]

[[FURWARE_text/Snippets|Helper functions for more convenient usage]]

[[FURWARE_text/Developers|Developer documentation]]

== How to contribute ==

'''For users:''' A very important part of contribution to the development of this script is to report any problems you experience while using it as well as suggestions how to make using it even more awesome. For the time being, feel free to write a notecard to {{User|Ochi Wolfe}} or add your comments to the discussion of this wiki-page.

'''For developers:''' If you have any suggestions for improvements to the script itself, you can either post them in the same way or you can branch the project on [http://github.com/furware/text GitHub] and send your pull requests. Just make sure that they are, of course, of awesome quality and that they don't bloat the script more than it already is bloated. In fact, any suggestions to improve performance and decrease memory consumption are '''very''' welcome.

== Known issues ==

No issues are known for the current release, but please report any problems you find.

== To do ==

There are still some things to do for the conversion into an open source project:

* Check the documentation for errors.
* <s>Migrate the German documentation to the SL Wiki.</s>
* Create developer documentation explaining concepts and ideas of the script. ''(in progress)''
* Improve the font overview in the manual; make UUIDs copyable.
* I think there is a small bug in one of the images in the tutorial, I'll have to check that.
* Publish texture specifications.
* Publish mesh specifications.
* Add more useful comments to the scripts themselves.
* Clean up the scripts of the display creator and element initializer.
* <s>Migrate internal bug tracker, possibly to GitHub.</s>
* Update the "FURWARE info board" to use the open source version of text.
* Make more open source example (controller) scripts.

FURWARE text/de

2013-07-19T23:41:16Z

Ochi Wolfe:

{{LSL Header|ml=*}}

Diese Seite ist auch [[FURWARE_text|auf englisch]] verfügbar. / This page is also available [[FURWARE_text|in English]].

== Übersicht ==

FURWARE text ist ein '''Skript zur Darstellung von Text''' mittels Texturen auf Prims. Es ist zum '''Einbau in deine Objekte''' gedacht in denen es von '''deinen eigenen Skripten''' gesteuert wird.

FURWARE text '''ist keine''' vorgefertigte Anzeigetafel sondern ist für '''Skripter''' gedacht, die es in ihre eigene Kreationen integrieren.

Das Skript war von 2010 bis Juli 2013 proprietär bis ich ({{User|Ochi Wolfe}}) mich dazu entschieden habe, es Open Source unter der MIT-Lizenz zu machen. Dies ist mein erster Versuch eines vollständig offenen Produkts in Second Life.

== Merkmale ==

* '''Open source''' (MIT license)
* '''Nur ein Skript''' für eine ganze Gruppe ("sets") von Anzeigetafeln
* '''Formatierung''' (Farbe, Alpha, Ausrichtung, Umbruch, Trimming, Font, Rahmen)
* '''Mesh prims''' mit 1-8 Zeichen, die je nur 0.5 Prims belegen
* '''Virtuelle Text-Boxen''' um Text beliebig zu Positionieren
* '''Style templates''' um mehrere Stileinstellungen zusammenzufassen

== Wo du das Skript bekommst ==

Du kannst dir ein komplettes Paket inklusive dem Display Creator, Meshes und Schrift-Texturen auf [http://marketplace.secondlife.com/p/FURWARE-text/141379 dem Marketplace] holen.

Für Entwickler und interessierte Benutzer habe ich für die Skripte außerdem einen Account auf [http://github.com/furware/text GitHub] erstellt.

== Dokumentation ==

Unter den folgenden Unterseiten findest du eine Bedienungsanleitung sowie Dokumentation für Entwickler:

[[FURWARE_text/Tutorial/de|Erste Schritte & ausführliches Tutorial]]

[[FURWARE_text/Reference/de|Kurzreferenz & Versionsgeschichte]]

[[FURWARE_text/Snippets/de|Hilfsfunktionen für einfachere Verwendung]]

[[FURWARE_text/Developers/de|Dokumentation für Entwickler]]

== Wie du helfen kannst ==

'''Für Anwender:''' Eine wichtige Hilfe bei der Entwicklung dieses Skripts ist das Berichten von Problemen bei seiner Verwendung sowie Vorschläge, wie man die Benutzung noch besser machen kann. Momentan sind die wahrscheinlich besten Möglichkeiten hierfür {{User|Ochi Wolfe}} eine Notecard zu schreiben oder deine Kommentare zur Diskussion dieser Wiki-Seite hinzuzufügen.

'''Für Entwickler:''' Wenn du Vorschläge für die Verbesserung des Skripts hast kannst du diese gerne auf dieselbe Weise kundtun. Alternativ kannst du aber auch gerne einen Branch des Projekts auf [http://github.com/furware/text GitHub] erstellen und Pull-Requests senden. Bitte stelle sicher, dass die Änderungen von sehr guter Qualität sind und sie das Skript nicht weiter aufblähen als es sowieso schon ist. Genauergesagt sind Vorschläge zur Verbesserung der Performance und Senkung des Speicherverbrauchs '''äußerst''' gern gesehen.

== Bekannte Probleme ==

* Es gibt momentan ein Problem wenn Zeichen verwendet werden, die nicht Teil der Schrift-Textur sind; dies kann zu unerwartetem Verhalten führen. Ich habe diesen Fehler versehentlich eingebaut als ich das Open-Source-Release vorbereitet habe (der Fehler ist in der 2.0-Beta1-Version nicht vorhanden). Ich arbeite zurzeit an einer Lösung und werde diese bald zusammen mit anderen Änderungen veröffentlichen.

== To do ==

Siehe bitte die [[FURWARE_text|englische Version dieser Seite]].

FURWARE text

2013-07-19T23:39:27Z

Ochi Wolfe:

{{LSL Header|ml=*}}

This page is also available [[FURWARE_text/de|in German]]. / Diese Seite ist auch [[FURWARE_text/de|auf deutsch]] verfügbar.

== Overview ==

FURWARE text is a '''script for displaying text''' on prims using textures. It is intended to be '''integrated in your objects''' in which it will be controlled by '''your own scripts'''.

FURWARE text '''is not''' a ready-made display board but is intented for '''scripters''' who wish to integrate it in their own creations.

The script was proprietary from 2010 to July 2013 until I ({{User|Ochi Wolfe}}) have decided to make it open source under the MIT license. It is my first attempt to make a fully open sourced product in Second Life.

== Features ==

* '''Open source''' (MIT license)
* '''Only one script''' for a whole group ("sets") of displays
* '''Formatting''' (color, alpha, alignment, wrapping, trimming, font, borders)
* '''Mesh prims''' with 1 to 8 chars, only occupying 0.5 prims each
* '''Virtual text boxes''' to position text arbitrarily
* '''Style templates''' for encapsulating multiple style settings

== How to obtain the script ==

You can obtain a complete package containing the script, the display creator, display meshes and font textures at [http://marketplace.secondlife.com/p/FURWARE-text/141379 the Marketplace].

For developers and interested users, I have also set up a [http://github.com/furware/text GitHub] account for the core scripts.

== Documentation ==

Please see the following subpages for the user's manual and developer documentation:

[[FURWARE_text/Tutorial|First steps & extensive tutorial]]

[[FURWARE_text/Reference|Short reference & version history]]

[[FURWARE_text/Snippets|Helper functions for more convenient usage]]

[[FURWARE_text/Developers|Developer documentation]]

== How to contribute ==

'''For users:''' A very important part of contribution to the development of this script is to report any problems you experience while using it as well as suggestions how to make using it even more awesome. For the time being, feel free to write a notecard to {{User|Ochi Wolfe}} or add your comments to the discussion of this wiki-page.

'''For developers:''' If you have any suggestions for improvements to the script itself, you can either post them in the same way or you can branch the project on [http://github.com/furware/text GitHub] and send your pull requests. Just make sure that they are, of course, of awesome quality and that they don't bloat the script more than it already is bloated. In fact, any suggestions to improve performance and decrease memory consumption are '''very''' welcome.

== Known issues ==

* There is currently an issue where sending characters that are not part of the font texture may cause unexpected behavior. I accidentally introduced this bug when preparing the open source release of the script (the error is not present in 2.0-Beta1). I'm working on a fix and will release it together with some other changes soon.

== To do ==

There are still some things to do for the conversion into an open source project:

* Check the documentation for errors.
* <s>Migrate the German documentation to the SL Wiki.</s>
* Create developer documentation explaining concepts and ideas of the script. ''(in progress)''
* Improve the font overview in the manual; make UUIDs copyable.
* I think there is a small bug in one of the images in the tutorial, I'll have to check that.
* Publish texture specifications.
* Publish mesh specifications.
* Add more useful comments to the scripts themselves.
* Clean up the scripts of the display creator and element initializer.
* <s>Migrate internal bug tracker, possibly to GitHub.</s>
* Update the "FURWARE info board" to use the open source version of text.
* Make more open source example (controller) scripts.

FURWARE text/de

2013-07-19T21:14:47Z

Ochi Wolfe: Added "known issues" section

{{LSL Header|ml=*}}

Diese Seite ist auch [[FURWARE_text|auf englisch]] verfügbar. / This page is also available [[FURWARE_text|in English]].

== Übersicht ==

FURWARE text ist ein '''Skript zur Darstellung von Text''' mittels Texturen auf Prims. Es ist zum '''Einbau in deine Objekte''' gedacht in denen es von '''deinen eigenen Skripten''' gesteuert wird.

FURWARE text '''ist keine''' vorgefertigte Anzeigetafel sondern ist für '''Skripter''' gedacht, die es in ihre eigene Kreationen integrieren.

Das Skript war von 2010 bis Juli 2013 proprietär bis ich ({{User|Ochi Wolfe}}) mich dazu entschieden habe, es Open Source unter der MIT-Lizenz zu machen. Dies ist mein erster Versuch eines vollständig offenen Produkts in Second Life.

== Merkmake ==

* '''Open source''' (MIT license)
* '''Nur ein Skript''' für eine ganze Gruppe ("sets") von Anzeigetafeln
* '''Formatierung''' (Farbe, Alpha, Ausrichtung, Umbruch, Trimming, Font, Rahmen)
* '''Mesh prims''' mit 1-8 Zeichen, die je nur 0.5 Prims belegen
* '''Virtuelle Text-Boxen''' um Text beliebig zu Positionieren
* '''Style templates''' um mehrere Stileinstellungen zusammenzufassen

== Wo du das Skript bekommst ==

Du kannst dir ein komplettes Paket inklusive dem Display Creator, Meshes und Schrift-Texturen auf [http://marketplace.secondlife.com/p/FURWARE-text/141379 dem Marketplace] holen.

Für Entwickler und interessierte Benutzer habe ich für die Skripte außerdem einen Account auf [http://github.com/furware/text GitHub] erstellt.

== Dokumentation ==

Unter den folgenden Unterseiten findest du eine Bedienungsanleitung sowie Dokumentation für Entwickler:

[[FURWARE_text/Tutorial/de|Erste Schritte & ausführliches Tutorial]]

[[FURWARE_text/Reference/de|Kurzreferenz & Versionsgeschichte]]

[[FURWARE_text/Snippets/de|Hilfsfunktionen für einfachere Verwendung]]

[[FURWARE_text/Developers/de|Dokumentation für Entwickler]]

== Wie du helfen kannst ==

'''Für Anwender:''' Eine wichtige Hilfe bei der Entwicklung dieses Skripts ist das Berichten von Problemen bei seiner Verwendung sowie Vorschläge, wie man die Benutzung noch besser machen kann. Momentan sind die wahrscheinlich besten Möglichkeiten hierfür {{User|Ochi Wolfe}} eine Notecard zu schreiben oder deine Kommentare zur Diskussion dieser Wiki-Seite hinzuzufügen.

'''Für Entwickler:''' Wenn du Vorschläge für die Verbesserung des Skripts hast kannst du diese gerne auf dieselbe Weise kundtun. Alternativ kannst du aber auch gerne einen Branch des Projekts auf [http://github.com/furware/text GitHub] erstellen und Pull-Requests senden. Bitte stelle sicher, dass die Änderungen von sehr guter Qualität sind und sie das Skript nicht weiter aufblähen als es sowieso schon ist. Genauergesagt sind Vorschläge zur Verbesserung der Performance und Senkung des Speicherverbrauchs '''äußerst''' gern gesehen.

== Bekannte Probleme ==

* Es gibt momentan ein Problem wenn Zeichen verwendet werden, die nicht Teil der Schrift-Textur sind; dies kann zu unerwartetem Verhalten führen. Ich habe diesen Fehler versehentlich eingebaut als ich das Open-Source-Release vorbereitet habe (der Fehler ist in der 2.0-Beta1-Version nicht vorhanden). Ich arbeite zurzeit an einer Lösung und werde diese bald zusammen mit anderen Änderungen veröffentlichen.

== To do ==

Siehe bitte die [[FURWARE_text|englische Version dieser Seite]].

FURWARE text

2013-07-19T21:12:20Z

Ochi Wolfe: Added "known issues" section

{{LSL Header|ml=*}}

This page is also available [[FURWARE_text/de|in German]]. / Diese Seite ist auch [[FURWARE_text/de|auf deutsch]] verfügbar.

== Overview ==

FURWARE text is a '''script for displaying text''' on prims using textures. It is intended to be '''integrated in your objects''' in which it will be controlled by '''your own scripts'''.

FURWARE text '''is not''' a ready-made display board but is intented for '''scripters''' who wish to integrate it in their own creations.

The script was proprietary from 2010 to July 2013 until I ({{User|Ochi Wolfe}}) have decided to make it open source under the MIT license. It is my first attempt to make a fully open sourced product in Second Life.

== Features ==

* '''Open source''' (MIT license)
* '''Only one script''' for a whole group ("sets") of displays
* '''Formatting''' (color, alpha, alignment, wrapping, trimming, font, borders)
* '''Mesh prims''' with 1 to 8 chars, only occupying 0.5 prims each
* '''Virtual text boxes''' to position text arbitrarily
* '''Style templates''' for encapsulating multiple style settings

== How to obtain the script ==

You can obtain a complete package containing the script, the display creator, display meshes and font textures at [http://marketplace.secondlife.com/p/FURWARE-text/141379 the Marketplace].

For developers and interested users, I have also set up a [http://github.com/furware/text GitHub] account for the core scripts.

== Documentation ==

Please see the following subpages for the user's manual and developer documentation:

[[FURWARE_text/Tutorial|First steps & extensive tutorial]]

[[FURWARE_text/Reference|Short reference & version history]]

[[FURWARE_text/Snippets|Helper functions for more convenient usage]]

[[FURWARE_text/Developers|Developer documentation]]

== How to contribute ==

'''For users:''' A very important part of contribution to the development of this script is to report any problems you experience while using it as well as suggestions how to make using it even more awesome. For the time being, feel free to write a notecard to {{User|Ochi Wolfe}} or add your comments to the discussion of this wiki-page.

'''For developers:''' If you have any suggestions for improvements to the script itself, you can either post them in the same way or you can branch the project on [http://github.com/furware/text GitHub] and send your pull requests. Just make sure that they are, of course, of awesome quality and that they don't bloat the script more than it already is bloated. In fact, any suggestions to improve performance and decrease memory consumption are '''very''' welcome.

== Known issues ==

* There is currently an issue where sending characters that are not part of the font texture may cause unexpected behavior. I accidentally introduced this bug when preparing the open source release of the script (the error is not present in the 2.0-Beta1 developer version). I'm working on a fix and will release it together with some other changes soon.

== To do ==

There are still some things to do for the conversion into an open source project:

* Check the documentation for errors.
* <s>Migrate the German documentation to the SL Wiki.</s>
* Create developer documentation explaining concepts and ideas of the script. ''(in progress)''
* Improve the font overview in the manual; make UUIDs copyable.
* I think there is a small bug in one of the images in the tutorial, I'll have to check that.
* Publish texture specifications.
* Publish mesh specifications.
* Add more useful comments to the scripts themselves.
* Clean up the scripts of the display creator and element initializer.
* <s>Migrate internal bug tracker, possibly to GitHub.</s>
* Update the "FURWARE info board" to use the open source version of text.
* Make more open source example (controller) scripts.

FURWARE text/Snippets/de

2013-07-12T23:50:23Z

Ochi Wolfe: Added fwStyle function

{{Multi-lang}}

Diese Seite beinhaltet verschiedene nützliche Code-Schnipsel (Funktionen, Konstanten), die die Arbeit mit [[FURWARE_text/de|FURWARE_text]] wesentlich angenehmer machen.

== Grundlegende Funktionen ==

Die Funktionen in diesem Abschnitt sind Wrapper um die einzelnen [[FURWARE_text/de|FURWARE_text]]-Befehle. Sie wurden so entworfen, dass sie den folgenden Anforderungen genügen:

* Die Funktionen sollen ''in sich abgeschlossen'' sein. Das heißt, dass du auch nur diejenigen Funktionen kopieren kannst, die du wirklich benötigst und sie werden funktionieren.
* Die Funktionen (und deren Parameter) sollen ''selbsterklärend'' sein. Das heißt, dass sie auch direkt als eine Kurzreferenz für den Befehl dienen sollen, den sie ausführen.

Dass die Funktionen in sich abgeschlossen sind bedeutet auch, dass jede der Funktionen einen [[llMessageLinked]](...)-Aufruf enthält. Das Ziel dieser Aufrufe ist hier auf [[LINK_SET]] (also das gesamte Linkset) gesetzt. Falls nötig, ändere dieses Ziel bitte in deinen Skripten.

<lsl>
fwSetText(string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data");
}

fwSetBoxText(string box, string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data:" + box);
}

fwSetStyle(string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf");
}

fwSetBoxStyle(string box, string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf:" + box);
}

fwSetDefaultStyle(string target, string style) {
// "target" darf leer, "root" oder "nonroot" sein.
llMessageLinked(LINK_SET, 0, style, "fw_defaultconf:" + target);
}

fwSetVariable(string name, string value) {
llMessageLinked(LINK_SET, 0, value, "fw_var:" + name);
}

fwAddBox(string name, string parent, integer x, integer y, integer w, integer h, string text, string style) {
llMessageLinked(LINK_SET, 0, text, "fw_addbox: " +name + ":" + parent + ":"+
(string)x + "," + (string)y + "," + (string)w + "," + (string)h + ":" + style);
}

fwDelBox(string name) {
llMessageLinked(LINK_SET, 0, "", "fw_delbox:" + name);
}

fwTouchQuery(integer linkNumber, integer faceNumber, string userData) {
llMessageLinked(LINK_SET, 0, userData, "fw_touchquery:" + (string)linkNumber + ":" + (string)faceNumber);
}

list fwTouchReply(string replyString) {
list tokens = llParseStringKeepNulls(replyString, [":"], []);
return [
llList2String(tokens, 0), llList2Integer(tokens, 1), llList2Integer(tokens, 2),
llList2String(tokens, 3), llList2Integer(tokens, 4), llList2Integer(tokens, 5),
llDumpList2String(llDeleteSubList(tokens, 0, 5), ":")
];
}

fwSetNotify(integer enabled) {
string s = "off"; if (enabled) s = "on";
llMessageLinked(LINK_SET, 0, s, "fw_notify");
}

fwMemory() {
llMessageLinked(LINK_SET, 0, "", "fw_memory");
}

fwReset() {
llMessageLinked(LINK_SET, 0, "", "fw_reset");
}
</lsl>

=== Beispiele ===

Die oben aufgeführen Funktionen erlauben dir zwar die meisten Befehle einfacher zu verwenden, aber einige Details müssen dennoch von Hand erledigt werden, beispielsweise das Angeben von Textstil-Konfigurationen. Die folgenden Zeilen geben dir ein paar Beispiele für die Verwendung der Funktionen.

<lsl>
// Setzt den Text aller Boxen in allen Sets.
fwSetText("Hello world!");

// Setzt den Text der Box "SomeBox".
fwSetBoxText("SomeBox", "This is some box!");

// Setzt den Standard-Stil aller Boxen auf color=red, align=center (der nächste Abschnitt zeigt, wie man dies schöner erledigen kann).
fwSetDefaultStyle("", "c=red;a=center");

// Füge eine Box "NewBox" mit "ExistingBox" als Parent hinzu.
fwAddBox("NewBox", "ExistingBox", 2, 2, 10, 5, "Some initial text", "");

// Lösche eine Box.
fwDelBox("NewBox");

// Sende eine Touch Query aus dem touch_start(...)-Event heraus.
touch_start(integer num) {
fwTouchQuery(llDetectedLinkNumber(0), llDetectedTouchFace(0), "Arbitrary user data goes here");
}

// Verarbeite eine "Touch Reply"-Antwort im link_message(...)-Event.
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_touchreply") {
list result = fwTouchReply(str);
// Die Liste "result" enthält jetzt die Antwort als [boxName, boxRelativeX, boxRelativeY, rootName, absoluteX, absoluteY, userData].
// "boxName" ist leer, wenn die Touch Query ungültig war.
}
}
</lsl>

== Noch angenehmere Verwendung ==

Die Funktionen im letzten Abschnitt sind lediglich Wrapper um die [[FURWARE_text/de|FURWARE_text]]-Befehle, allerdings muss du weiterhin Dinge wie Stileinstellungen selber schreiben und dir die verschiedenen Optionen und deren Werte merken. Die folgenden Konstanten und Funktionen nehmen dir einen Teil dieser Arbeit ab (auch hier gilt, dass du nur die Teile kopieren musst, die du tatsächlich benötigst – auch um Speicher zu sparen!).

{{KBtip|Beachte, dass die folgenden Zeilen die Funktionen im vorigen Abschnitt ergänzen, d.h. du musst die entsprechenden Funktionen zusätzlich mitkopieren.}}

<lsl>
// === Farben (colors) ===

string COLOR_DEFAULT = "c=def;";

// Graustufen.
string COLOR_WHITE = "c=white;";
string COLOR_SILVER = "c=silver;";
string COLOR_GRAY = "c=gray;";
string COLOR_BLACK = "c=black;";

// Standardfarben.
string COLOR_RED = "c=red;";
string COLOR_GREEN = "c=green;";
string COLOR_BLUE = "c=blue;";
string COLOR_CYAN = "c=cyan;";
string COLOR_MAGENTA = "c=magenta;";
string COLOR_YELLOW = "c=yellow;";

// Dunkle Farben.
string COLOR_DARKRED = "c=darkred;";
string COLOR_DARKGREEN = "c=darkgreen;";
string COLOR_DARKBLUE = "c=darkblue;";
string COLOR_DARKCYAN = "c=darkcyan;";
string COLOR_DARKMAGENTA = "c=darkmagenta;";
string COLOR_DARKYELLOW = "c=darkyellow;";

// Beliebige RGB- (Rot, Grün, Blau) Farben.
string fwColorRGB(float red, float green, float blue) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + ",1" + ";";
}

// Beliebige RGBA- (Rot, Grün, Blau, Alpha/Deckkraft) Farben.
string fwColorRGBA(float red, float green, float blue, float alpha) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + "," + (string)alpha + ";";
}

// === Ausrichtung (alignment) ===

string ALIGN_DEFAULT = "a=def;";
string ALIGN_LEFT = "a=left;";
string ALIGN_CENTER = "a=center;";
string ALIGN_RIGHT = "a=right;";

// === Umbruch (wrapping) ===

string WRAP_DEFAULT = "w=def;";
string WRAP_WORD = "w=word;";
string WRAP_CHAR = "w=char;";
string WRAP_NONE = "w=none;";

// === Abschneiden von Leerzeichen am Anfang/Ende (trimming) ===

string TRIM_DEFAULT = "t=def;";
string TRIM_ON = "t=on;";
string TRIM_OFF = "t=off;";

// === Schriftarten (fonts) ===

string FONT_DEFAULT = "f=def;";
string FONT_ANDALE = "f=e31ce6e8-4117-7073-6aac-e6503034b4c5;";
string FONT_ANONYMOUS_PRO = "f=24c4ead5-04cd-1831-5fd9-ec48882e00b1;";
string FONT_ANONYMOUS_PRO_BOLD = "f=82c4fcac-3990-223c-286d-5bc92a258fbc;";
string FONT_DEJAVU = "f=f974fdfc-8fbd-2f29-2b38-3c34411c1fcc;";
string FONT_DEJAVU_BOLD = "f=5054fec3-1465-af8f-2fe5-e9507795c82a;";
string FONT_ENVYCODER = "f=a2ec2cf0-b207-db51-d4a1-f3f8d6684c07;";
string FONT_FREEFONT = "f=05f6f69e-8bdf-a824-a2cf-d91c9e371c23;";
string FONT_INCONSOLATA = "f=867288f9-940e-a7cf-ac7d-5596ea7fb2c5;";
string FONT_LIBERATION = "f=c992dfc4-0aca-02c8-bc01-8330e6db6f87;";
string FONT_LIBERATION_BOLD = "f=1494337d-5296-3c43-8f7c-45617448ec9a;";
string FONT_LUXI = "f=2d8f52d7-2220-2d7a-15b5-e685a9449e5c;";
string FONT_LUXI_BOLD = "f=03812794-535b-f546-6171-6bec5bf399be;";
string FONT_MONOFUR = "f=8fc63e35-a18f-e335-3936-e2ca196a944d;";
string FONT_NOVA = "f=2df8e09d-e1bd-d17f-6bec-b8d713790380;";
string FONT_PROFONT = "f=45a8e6f6-90e4-299d-d3bc-0bf4dbf170db;";

// === Rahmen (borders) ===

string BORDER_DEFAULT = "border=def;";

// Einige Beispiele für oft benutzte Rahmenstile.
string BORDER_ALL_SIDES = "border=tblr;";
string BORDER_ALL_SIDES_THICK = "border=tblr1;";
string BORDER_ALL_SIDES_DOUBLE = "border=tblr2;";
string BORDER_BOTTOM = "border=b;";
string BORDER_LEFT_RIGHT = "border=lr;";

// Eine allgemeinere Hilfsfunktion für Rahmen. Die Seiten-Parameter sind von oben beginnend im Uhrzeigersinn angeordnet.
string fwBorder(integer top, integer right, integer bottom, integer left, integer style) {
string result = "border=";
if (top) result += "t"; if (right) result += "r";
if (bottom) result += "b"; if (left) result += "l";
if (style) result += (string)style;
return result + ";";
}

// === Stil-Variablen ===

// Lädt einen in einer fw_var(iable) gespeicherten Stil.
string fwStyle(string styleVariableName) {
return "style=" + styleVariableName + ";";
}
</lsl>

=== Beispiele ===

Jeder Wert der Konstanten endet mit einem ";". Das erlaubt dir, die Konstanten einfach mit "+" zu verbinden und trotzdem gültige Strings für Stileinstellungen zu erhalten. Damit kannst du so etwas schreiben wie:

<lsl>
// Setzt die Farbe (color), den Umbruch (wrapping) und die Schriftart (font) für alle Boxen.
fwSetStyle(COLOR_YELLOW + WRAP_NONE + FONT_MONOFUR);

// Setzt die Standard-Stileinstellung für alle Boxen.
fwSetDefaultStyle("", COLOR_RED + ALIGN_CENTER);

// Füge eine Box mit einer Stileinstellung hinzu. Wir benutzen hier eine selbstspezifizierte RGB-Farbe.
fwAddBox("SomeBox", "ParentBox", 2, 2, 10, 5, "Some initial text", FONT_LUXI + fwColorRGB(0.5, 0.75, 0.0) + BORDER_ALL_SIDES);

// Speichere einen Stil-String in einer Variablen und benutze diesen.
fwSetVariable("MyStyle", FONT_MONOFUR + ALIGN_CENTER + BORDER_ALL_SIDES);
fwSetBoxStyle("BoxA", fwStyle("MyStyle"));
fwSetBoxStyle("BoxB", fwStyle("MyStyle"));
</lsl>

FURWARE text/Snippets

2013-07-12T23:47:49Z

Ochi Wolfe: Added fwStyle function

{{Multi-lang}}

This page contains several useful code snippets (functions, constants) that can make the usage of [[FURWARE_text]] a lot more convenient.

== Basic convenience functions ==

The functions in this section are wrappers around each of the FURWARE text commands. They were designed to follow these rules:

* The functions shall be ''self-contained''. That is, you may copy any subset of the functions that you need and they will work.
* The functions (and their parameters) shall be ''self-explanatory''. That is, they also serve as a quick reference guide to the parameters of the commands they execute.

The fact that the functions are self-contained also means that each of them contains a [[llMessageLinked]](...)-call. The target of this call is set to [[LINK_SET]] (the whole linkset). Please change this target accordingly in your scripts, if needed.

<lsl>
fwSetText(string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data");
}

fwSetBoxText(string box, string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data:" + box);
}

fwSetStyle(string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf");
}

fwSetBoxStyle(string box, string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf:" + box);
}

fwSetDefaultStyle(string target, string style) {
// "target" may be empty, "root" or "nonroot".
llMessageLinked(LINK_SET, 0, style, "fw_defaultconf:" + target);
}

fwSetVariable(string name, string value) {
llMessageLinked(LINK_SET, 0, value, "fw_var:" + name);
}

fwAddBox(string name, string parent, integer x, integer y, integer w, integer h, string text, string style) {
llMessageLinked(LINK_SET, 0, text, "fw_addbox: " +name + ":" + parent + ":"+
(string)x + "," + (string)y + "," + (string)w + "," + (string)h + ":" + style);
}

fwDelBox(string name) {
llMessageLinked(LINK_SET, 0, "", "fw_delbox:" + name);
}

fwTouchQuery(integer linkNumber, integer faceNumber, string userData) {
llMessageLinked(LINK_SET, 0, userData, "fw_touchquery:" + (string)linkNumber + ":" + (string)faceNumber);
}

list fwTouchReply(string replyString) {
list tokens = llParseStringKeepNulls(replyString, [":"], []);
return [
llList2String(tokens, 0), llList2Integer(tokens, 1), llList2Integer(tokens, 2),
llList2String(tokens, 3), llList2Integer(tokens, 4), llList2Integer(tokens, 5),
llDumpList2String(llDeleteSubList(tokens, 0, 5), ":")
];
}

fwSetNotify(integer enabled) {
string s = "off"; if (enabled) s = "on";
llMessageLinked(LINK_SET, 0, s, "fw_notify");
}

fwMemory() {
llMessageLinked(LINK_SET, 0, "", "fw_memory");
}

fwReset() {
llMessageLinked(LINK_SET, 0, "", "fw_reset");
}
</lsl>

=== Examples ===

The above snippets allow you to use the basic commands more easily, but you may still need to do some manual work, for example when specifying style configuration strings. The following lines give a few assorted examples of calls using the functions.

<lsl>
// Set the text of all boxes in all sets.
fwSetText("Hello world!");

// Set the text of the box "SomeBox".
fwSetBoxText("SomeBox", "This is some box!");

// Set the default style of all boxes to color=red, align=center (see the next section how to make this much nicer).
fwSetDefaultStyle("", "c=red;a=center");

// Add a box "NewBox" using "ExistingBox" as its parent.
fwAddBox("NewBox", "ExistingBox", 2, 2, 10, 5, "Some initial text", "");

// Delete a box.
fwDelBox("NewBox");

// Send a touch query from the touch_start(...)-event.
touch_start(integer num) {
fwTouchQuery(llDetectedLinkNumber(0), llDetectedTouchFace(0), "Arbitrary user data goes here");
}

// Parse a touch reply in the link_message(...)-event.
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_touchreply") {
list result = fwTouchReply(str);
// The list "result" now contains the reply as [boxName, boxRelativeX, boxRelativeY, rootName, absoluteX, absoluteY, userData].
// "boxName" is empty if the touch query was invalid.
}
}
</lsl>

== Additional awesomeness ==

The functions in the previous section are wrappers around the [[FURWARE_text]] commands, but you still need to write, for instance, style configuration strings yourself and remember the style options and values. The following set of constants and functions help you with that (again, you don't have to copy all of them but just the ones you need to save script memory!).

{{KBtip|Note that these constants complement the functions defined above, so make sure to copy the functions you need as well.}}

<lsl>
// === Colors ===

string COLOR_DEFAULT = "c=def;";

// Grayscales.
string COLOR_WHITE = "c=white;";
string COLOR_SILVER = "c=silver;";
string COLOR_GRAY = "c=gray;";
string COLOR_BLACK = "c=black;";

// Standard colors.
string COLOR_RED = "c=red;";
string COLOR_GREEN = "c=green;";
string COLOR_BLUE = "c=blue;";
string COLOR_CYAN = "c=cyan;";
string COLOR_MAGENTA = "c=magenta;";
string COLOR_YELLOW = "c=yellow;";

// Dark colors.
string COLOR_DARKRED = "c=darkred;";
string COLOR_DARKGREEN = "c=darkgreen;";
string COLOR_DARKBLUE = "c=darkblue;";
string COLOR_DARKCYAN = "c=darkcyan;";
string COLOR_DARKMAGENTA = "c=darkmagenta;";
string COLOR_DARKYELLOW = "c=darkyellow;";

// Arbitrary RGB (red, green, blue) color.
string fwColorRGB(float red, float green, float blue) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + ",1" + ";";
}

// Arbitrary RGBA (red, green, blue, alpha/opacity) color.
string fwColorRGBA(float red, float green, float blue, float alpha) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + "," + (string)alpha + ";";
}

// === Alignment ===

string ALIGN_DEFAULT = "a=def;";
string ALIGN_LEFT = "a=left;";
string ALIGN_CENTER = "a=center;";
string ALIGN_RIGHT = "a=right;";

// === Wrapping ===

string WRAP_DEFAULT = "w=def;";
string WRAP_WORD = "w=word;";
string WRAP_CHAR = "w=char;";
string WRAP_NONE = "w=none;";

// === Trimming ===

string TRIM_DEFAULT = "t=def;";
string TRIM_ON = "t=on;";
string TRIM_OFF = "t=off;";

// === Fonts ===

string FONT_DEFAULT = "f=def;";
string FONT_ANDALE = "f=e31ce6e8-4117-7073-6aac-e6503034b4c5;";
string FONT_ANONYMOUS_PRO = "f=24c4ead5-04cd-1831-5fd9-ec48882e00b1;";
string FONT_ANONYMOUS_PRO_BOLD = "f=82c4fcac-3990-223c-286d-5bc92a258fbc;";
string FONT_DEJAVU = "f=f974fdfc-8fbd-2f29-2b38-3c34411c1fcc;";
string FONT_DEJAVU_BOLD = "f=5054fec3-1465-af8f-2fe5-e9507795c82a;";
string FONT_ENVYCODER = "f=a2ec2cf0-b207-db51-d4a1-f3f8d6684c07;";
string FONT_FREEFONT = "f=05f6f69e-8bdf-a824-a2cf-d91c9e371c23;";
string FONT_INCONSOLATA = "f=867288f9-940e-a7cf-ac7d-5596ea7fb2c5;";
string FONT_LIBERATION = "f=c992dfc4-0aca-02c8-bc01-8330e6db6f87;";
string FONT_LIBERATION_BOLD = "f=1494337d-5296-3c43-8f7c-45617448ec9a;";
string FONT_LUXI = "f=2d8f52d7-2220-2d7a-15b5-e685a9449e5c;";
string FONT_LUXI_BOLD = "f=03812794-535b-f546-6171-6bec5bf399be;";
string FONT_MONOFUR = "f=8fc63e35-a18f-e335-3936-e2ca196a944d;";
string FONT_NOVA = "f=2df8e09d-e1bd-d17f-6bec-b8d713790380;";
string FONT_PROFONT = "f=45a8e6f6-90e4-299d-d3bc-0bf4dbf170db;";

// === Borders ===

string BORDER_DEFAULT = "border=def;";

// These are just some examples for common border styles.
string BORDER_ALL_SIDES = "border=tblr;";
string BORDER_ALL_SIDES_THICK = "border=tblr1;";
string BORDER_ALL_SIDES_DOUBLE = "border=tblr2;";
string BORDER_BOTTOM = "border=b;";
string BORDER_LEFT_RIGHT = "border=lr;";

// A more general helper function for borders. The side parameters are ordered clockwise, starting on top.
string fwBorder(integer top, integer right, integer bottom, integer left, integer style) {
string result = "border=";
if (top) result += "t"; if (right) result += "r";
if (bottom) result += "b"; if (left) result += "l";
if (style) result += (string)style;
return result + ";";
}

// === Style variables ===

// Loads a style stored in a fw_var(iable).
string fwStyle(string styleVariableName) {
return "style=" + styleVariableName + ";";
}
</lsl>

=== Examples ===

Note that the value of each constant ends with ";". This allows you to simply "+" them together and you still get valid style strings which you may then use wherever you need a style config string. This allows you to write things like this:

<lsl>
// Set the color, wrapping and font of all boxes.
fwSetStyle(COLOR_YELLOW + WRAP_NONE + FONT_MONOFUR);

// Set the default style for all boxes.
fwSetDefaultStyle("", COLOR_RED + ALIGN_CENTER);

// Add a box with some style config. We will use a custom RGB color here.
fwAddBox("SomeBox", "ParentBox", 2, 2, 10, 5, "Some initial text", FONT_LUXI + fwColorRGB(0.5, 0.75, 0.0) + BORDER_ALL_SIDES);

// Store a style string in a variable and use it.
fwSetVariable("MyStyle", FONT_MONOFUR + ALIGN_CENTER + BORDER_ALL_SIDES);
fwSetBoxStyle("BoxA", fwStyle("MyStyle"));
fwSetBoxStyle("BoxB", fwStyle("MyStyle"));
</lsl>

FURWARE text/Developers/de

2013-07-11T20:07:48Z

Ochi Wolfe: Initial German translation

{{Multi-lang}}

Diese Seite beinhaltet technische Informationen zu [[FURWARE text]] und richtet sich an Entwickler und interessierte Benutzer.

{{KBtip|Wenn du mehr zu einem bestimmten Thema wissen möchtest, hinterlasse bitte eine Notiz auf der Diskussionsseite. :)}}

== Terminologie und Hierarchien ==

Ein "'''Set'''" bezeichnet ein Text-Display, das aus in Zeilen und Spalten angeordneten Prims besteht. Jedes Set hat einen Namen, der in der Regel mithilfe des Display Creators gesetzt wird. Ein Linkset kann mehrere Sets enthalten.

Eine "'''Box'''" ist eine virtuelle Text-Box innerhalb eines Sets. Jedes Set hat immer eine (Root-)Box mit derselben Größe und demselben Namen wie das Set. Jeder Box wird beim Erstellen ein Name zugewiesen (per Parameter des ''fw_addbox''-Befehls). Zu einem Set können mehrere Boxen hinzugefügt werden, die dann in Layern übereinandergelegt dargestellt werden (in der Reihenfolge, in der sie hinzugefügt wurden).

Daraus folgen einige Zusammenhänge:

* Eine Box ist immer Teil von einem Set und liegt vollständig innerhalb von diesem.
* Ein Set besteht aus einem oder mehreren Prims.
* Ein Prim kann mehrere Faces haben.
* Jedes Face stellt ein Zeichen des Texts dar.

Der Text-Inhalt einer Box wird oft als "'''data'''" der Box bezeichnet ("data" wird aber auch in allgemeinerem Zusammenhang verwendet).

Der Text-Stil einer Box (oder Textabschnitten) wird oft als "'''conf'''" (der Box) bezeichnet.

== Datenstrukturen für Box-, Set- und Prim-Informationen ==

Die meisten Informationen zur Geometrie und zum Inhalt des Displays werden in einigen [[list|Listen]] gespeichert. Einige [[list|Listen]] enthalten auch Indizes ("Pointer") zu Daten in anderen [[list|Listen]].

=== Box-Informationen ===

* "boxNameList" ist eine einfache [[list|Liste]] der Namen aller Boxen. Der Grund dafür, dass die Namen in einer separaten [[list|Liste]] vorgehalten werden (und nicht als Teil von "boxDataList", siehe unten) ist, dass die Namen schnell durchsuchbar sein sollen. Das ist beispielsweise nötig wenn neuer Text gesetzt werden soll und der Index einer Box ermittelt werden muss anhand ihres Namens.

* "boxDataList" ist eine [[:Category:LSL_List#Strided_lists|Strided List]], die mehr Informationen zu jeder Box enthält. Ein Stride enthält:
** Den Text der Box ([[string]]).
** Die Textstil-Einstellung der Box ([[string]]).
** Einen Pointer auf den Beginn des Sets in der "setDataList" zu dem diese Box gehört ([[integer]]).
** Den Status der Box (u.A. ob die box "dirty" ist und neu gezeichnet werden muss) (bit-packed [[integer]]).
** Die Geometrie der box (Spalten-Offset, Zeilen-Offset, Breite, Höhe) ([[rotation]]).

=== Set-Informationen ===

* "setDataList" ist eine [[:Category:LSL_List#Strided_lists|Strided List]], die Informationen zu jedem Set enthält. Ein Stride enthält:
** Die Geometrie des Sets (Anzahl von Prim-Spalten und -Zeilen, Anzahl der Faces) ([[vector]]).
** Einen Pointer zum Beginn der Prim-Informationen in den "prim*List"-Listen ([[integer]]).

=== Prim-Informationen ===

* "primLinkList" enthält die Link-Nummern der einzelnen Prims, sortiert zuerst nach Set, dann nach Zeilen, dann nach Spalten. Die Link-Nummern sind nicht bit-packed, weil sie schnell durchsuchbar sein sollen, etwa wenn Touch Queries bearbeitet werden.

* "primFillList" enthält bit-packed Integer, die den Status der einzelnen Faces auf den Prims enthalten. "Der Status" bedeutet hier, ob die Faces momenten ein Leerzeichen anzeigen oder nicht. Diese Information wird als Cache benutzt um unnötige SetPrimitiveParams-Aufrufe zu vermeiden.

* "primLayerList" enthält bit-packed Integer, die die Zuordnung von Faces zu Layern beinhaltet. Die 32 Bits des Integers sind dabei in je 4 Bits für jedes Face geteilt und somit kann jedem Face eine von 16 Layer-IDs zugeteilt werden. Diese Information wird während des Renderns verwendet um schnell feststellen zu können, welcher Layer an der Position dieses Faces gerade im Vordergrund liegt.

== Grundlegender Ablauf der Events ==

Das folgende Bild ist ein Versuch, die grundlegenden Zusammenhänge von Events und Funktionen im FURWARE text-Skript darzustellen, wenn ein Befehl empfangen wird, der den Inhalt oder das Layout des Displays verändert (eine deutsche Übersetzung folgt).

[[File:FURWARE_text_basic_event_flow.png]]

== Die Initialisierungs-Routine ==

''To do''

== Der [[link_message]](...)-Handler ==

''To do''

== Die setDirty(...)-Funktion ==

Diese Funktion steht zwischen dem Entgegennehmen von Befehlen in [[link_message]](...) und dem tatsächlichen (Neu-)Zeichnen in refresh(...). Sie besitzt folgende Parameter:

=== ''[[integer]]'' action ===

Kann einen der Werte der Konstanten ACTION_CONTENT, ACTION_ADD_BOX oder ACTION_DEL_BOX annehmen. Dieser Wert gibt an, welche ''Art'' von Kommando ausgeführt werden soll (beispielsweise ist das Setzen von neuem Text von der Art ACTION_CONTENT). Der übergebene Wert wird als globale Variable gespeichert und beim nächsten Aufruf von refresh(...) wieder zurückgesetzt.

Der Grund dafür, dass wir uns diesen Wert merken, ist das ''zeitverzögerte Aktualisieren'' des Displays (welches im Übrigen einer der Gründe ist, weshalb setDirty(...) als Puffer zwischen Parsen und Refreshen überhaupt eingebaut wurde). Am Ende von setDirty(...) wird ein Timer mit einem recht kurzen Intervall gestartet. Das [[timer]]()-Event ruft dann lediglich refresh() auf. Allerdings können in dieser kurzen Zeit noch weitere [[link_message]](...)-Events empfangen und verarbeitet werden, was uns erlaubt, mehrere Befehle zu sammeln bevor wir das Display tatsächlich aktualisieren (beispielsweise das Setzen von Text mehrerer verschiedener Boxen). Dies kann in manchen Situationen einen großen Geschwindigkeitsvorteil bringen. Beachte, dass der Timer nicht neugestartet wird, wenn die letzte Aktion bereits auf etwas anderes als [[FALSE|0]] gesetzt ist. Das "garantiert" uns, dass das [[timer]]()-Event irgendwann ausgeführt wird, selbst wenn wir einen konstanten Strom von Befehlen empfangen.

''Es gibt allerdings einen Haken an der Sache.'' Wenn wir alle verschiedenen Arten von Befehlen wie das Setzen von Text, Stilen, Variablen, das Hinzufügen und Entfernen von Boxen sammeln würden ohne zu geeigneten Zeitpunkten zu aktualisieren, würden wir irgendwann ein Durcheinander und kaputte Datenstrukturen haben (du darfst gerne über die Details nachdenken, aber es verursacht Kopfschmerzen). Hier kommt die Unterscheidung zwischen den verschiedenen Arten von Aktionen ins Spiel.

Operationen, die lediglich den "Inhalt" von Boxen verändern sind gewissermaßen "kompatibel" zueinander und können gesammelt werden, da die Indizes der Listen mit Box-Informationen und der Layer während der Änderungen ''konstant'' bleiben. Operationen, die ''Boxen hinzufügen'' können ebenfalls gesammelt werden, da die Informationen lediglich zu einigen [[list|Listen]] hinzugefügt werden und wir dann die neuen Boxen auf einmal aktualisieren können. Operationen, die ''Boxen löschen'' können gesammelt werden, da wir uns im Grunde nur merken müssen, welche Layer wieder freigeworden sind. Anschließend können wir durch die verbliebenen Boxen gehen und diese entsprechend neu zeichnen.

Da das ''Mischen'' der verschiedenen Arten von Operationen ''ungut'' ist, prüft der Handler wenn ein neuer Befehl hereinkommt, ob die neue Operation mit der vorherigen kompatibel ist (das heißt, "Art der letzten Operation" == "Art der neuen Operation") und wenn sie dies nicht ist, wird ein ''sofortiges'' Aktualisieren erzwungen bevor der Befehl verarbeitet wird. Beachte, dass nur die ''Art'' der Operation gleich sein muss, nicht der genaue Befehl; beispielsweise sind die Befehle fw_data und fw_conf zueinander kompatibel, da beide den Typ ACTION_CONTENT besitzen.

Beachte weiterhin, dass die Art der Operation die Arbeitsweise der refresh()-Funktion beeinflusst; bitte siehe den entsprechenden Abschnitt für Einzelheiten.

=== ''[[integer]]'' first / last ===

Das Intervall von Box-Indizes, auf denen gearbeitet werden soll. Dies erlaubt uns direkt auf einer ganzen Reihe von Boxen auf einmal zu arbeiten.

=== ''[[integer]]'' isConf ===

Kann entweder [[FALSE|0]] oder [[TRUE|1]] sein. Dieser Wert wird dazu benutzt um festzustellen, ob etwaig übergebene Daten als data oder conf der Box(en) gespeichert werden sollen. Außerdem wird das (Neu-)Zeichnen der Rahmen von Boxen erzwungen, wenn isConf [[TRUE|1]] ist, da sich dieser geändert haben könnte.

=== ''[[integer]]'' newLayerOverrideBits ===

An dieser Stelle wird es ein wenig knifflig. :) Bevor wir uns um den Sinn dieses Wertes kümmern, hier einige Fakten: Dieser Parameter sollte nur Nicht-Null sein, wenn Boxen hinzugefügt oder entfernt werden. Der Wert wird bit-packed als Teil des Status der Boxen in boxDataList gespeichert und am Ende von refresh() wieder gelöscht. Der Wert selbst ist 16 Bits lang und jedes Bit steht für einen der 16 möglichen Layer innerhalb eines Sets. Beispielsweise bedeutet ein Wert von 0xFFFF (binär 1111111111111111) "alle Layer" während ein Wert von 0x4 (binär 0000000000000100) "Layer 2" bedeutet (von 0 beginnend gezählt).

Der Wert wird in der draw(...)-Funktion verwendet, welche an verschiedenen Stellen in refresh() benutzt wird um ein Zeichen auf eine Face zu zeichnen. Normalerweise holt sich draw(...) die ID des Layers, der sich an der Position des Face gerade im Vordergrund befindet, sowie die ID des Layers der Box, die gerade gezeichnet werden soll. Wenn diese Layer-IDs ungleich sind, dann wird die Face nicht verändert, da die zu zeichnende Box an der Stelle nicht im Vordergrund ist.

Wenn wir jetzt aber eine Box hinzufügen oder entfernen, dann kann sich die Information, welche Layer an welchen Stellen im Vordergrund sind, für einige Faces ändern. Das ist genau die Information, die uns die newLayerOverrideBits liefern. Wenn beispielsweise eine neue Box hinzugefügt wird, sind deren Override-Bits auf 0xFFFF gesetzt. Wenn diese Box nun gezeichnet wird, dann merkt die draw(...)-Funktion, dass sie alle anderen Layer überschreiben und die neue Box darüber zeichnen soll. Wenn eine Box entfernt wird ist die Logik ähnlich, allerdings werden nur bestimmte Bits gesetzt und die Reihenfolge des Refreshs wird umgedreht; siehe dazu auch den Abschnitt über die refresh()-Funktion.

=== ''[[integer]]'' setIndex ===

Erlaubt uns, das (Über-)Schreiben von Informationen auf Boxen eines bestimmten Sets einzuschränken. Ein Wert von -1 bedeutet, dass auf allen Sets gearbeitet werden soll.

=== ''[[integer]]'' withData ===

Gibt an, ob der "data"-Parameter (siehe unten) Daten enthält. Das erlaubt eine Unterscheidung zwischen dem leeren String und "keine Daten angegeben".

=== ''[[string]]'' data ===

Enthält entweder neuen Text oder neue Stil-Einstellungen zur Speicherung in boxDataList.

== Die refresh()-Funktion ==

Die refresh()-Funktion kann als das "Herz" des Text-Skripts angesehen werden. Sie wird entweder aufgerufen nachdem einige Änderungen gesammelt wurden oder wenn eine Aktualisierung während des Abarbeitens eines Befehls erzwungen werden muss.

Sie besteht hauptsächlich aus einer großen Schleife, die über alle Boxen iteriert und deren "Dirty"-Bit prüft. Wenn eine Box als dirty markiert ist, werden ihre Informationen (Text, Stil, Geometrie) geladen und zum Zeichnen vorbereitet.

'''Ein paar Worte zur Reihenfolge der Schleife:''' Normalerweise werden die Boxen in der ''umgekehrten'' Reihenfolge, in der sie hinzugefügt wurden, durchgegangen. Das bedeutet, dass die Boxen "von oben nach unten" aktualisiert werden (bezüglich der Layer). Allerdings gibt es eine Ausnahme: Wenn die Art des letzten Befehls ACTION_ADD_BOX war (siehe auch den "action"-Parameter von setDirty(...)), dann werden die Boxen ''in'' der Reihenfolge, in der sie hinzugefügt wurden, durchgegangen ("von unten nach oben"). Dies ist nötig um die Information, welche Layer auf welchen Faces gerade im Vordergrund sind, korrekt zu aktualisieren (siehe auch den "newLayerOverrideBits"-Parameter von setDirty(...)).

Zurück zur Schleife und dem "Dirty"-Bit. Genauergesagt gibt es zwei "Dirty"-Bits: Eines sagt uns, ob die Box überhaupt aktualisiert werden soll und ein zweites, ob außerdem die Rahmen der Box u.U. aktualisiert werden müssen. Wenn etwa lediglich der Text einer Box geändert wurde – aber nicht die Stileinstellungen – dann gibt es keinen Grund, den Rahmen neuzuzeichnen.

Der Text der Box wird dann in Teile zerlegt (an den Stellen wo Leerzeichen, Umbrüche, Stil-Markup auftreten) und eine innere Schleife iteriert durch diese Teile, welche wiederum Listen von einzelnen Zeichen und Stilinformationen, die direkt im Text gegeben sind, vorbereitet. Sobald eine Zeile an Daten vorbereitet ist (eine Zeile bedeutet hier eine Zeile von Prims), kümmert sich eine weitere kleine Schleife um das eigentliche Zeichnen auf die Faces. Anschließend wird mit der nächsten Zeile fortgefahren.

Nachdem eine Box aktualisiert wurde, werden ihre "Dirty"-Bits zurückgesetzt. Sobald alle Boxen fertig sind, wird die global gespeicherte Art der letzten Aktion zurückgesetzt und (falls die "Notification"-Option aktiviert ist) eine "fw_done"-Nachricht an das Linkset gesendet.

== Caching-Strategien ==

''To do''

FURWARE text/Snippets/de

2013-07-10T23:33:49Z

Ochi Wolfe:

{{Multi-lang}}

Diese Seite beinhaltet verschiedene nützliche Code-Schnipsel (Funktionen, Konstanten), die die Arbeit mit [[FURWARE_text/de|FURWARE_text]] wesentlich angenehmer machen.

== Grundlegende Funktionen ==

Die Funktionen in diesem Abschnitt sind Wrapper um die einzelnen [[FURWARE_text/de|FURWARE_text]]-Befehle. Sie wurden so entworfen, dass sie den folgenden Anforderungen genügen:

* Die Funktionen sollen ''in sich abgeschlossen'' sein. Das heißt, dass du auch nur diejenigen Funktionen kopieren kannst, die du wirklich benötigst und sie werden funktionieren.
* Die Funktionen (und deren Parameter) sollen ''selbsterklärend'' sein. Das heißt, dass sie auch direkt als eine Kurzreferenz für den Befehl dienen sollen, den sie ausführen.

Dass die Funktionen in sich abgeschlossen sind bedeutet auch, dass jede der Funktionen einen [[llMessageLinked]](...)-Aufruf enthält. Das Ziel dieser Aufrufe ist hier auf [[LINK_SET]] (also das gesamte Linkset) gesetzt. Falls nötig, ändere dieses Ziel bitte in deinen Skripten.

<lsl>
fwSetText(string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data");
}

fwSetBoxText(string box, string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data:" + box);
}

fwSetStyle(string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf");
}

fwSetBoxStyle(string box, string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf:" + box);
}

fwSetDefaultStyle(string target, string style) {
// "target" darf leer, "root" oder "nonroot" sein.
llMessageLinked(LINK_SET, 0, style, "fw_defaultconf:" + target);
}

fwSetVariable(string name, string value) {
llMessageLinked(LINK_SET, 0, value, "fw_var:" + name);
}

fwAddBox(string name, string parent, integer x, integer y, integer w, integer h, string text, string style) {
llMessageLinked(LINK_SET, 0, text, "fw_addbox: " +name + ":" + parent + ":"+
(string)x + "," + (string)y + "," + (string)w + "," + (string)h + ":" + style);
}

fwDelBox(string name) {
llMessageLinked(LINK_SET, 0, "", "fw_delbox:" + name);
}

fwTouchQuery(integer linkNumber, integer faceNumber, string userData) {
llMessageLinked(LINK_SET, 0, userData, "fw_touchquery:" + (string)linkNumber + ":" + (string)faceNumber);
}

list fwTouchReply(string replyString) {
list tokens = llParseStringKeepNulls(replyString, [":"], []);
return [
llList2String(tokens, 0), llList2Integer(tokens, 1), llList2Integer(tokens, 2),
llList2String(tokens, 3), llList2Integer(tokens, 4), llList2Integer(tokens, 5),
llDumpList2String(llDeleteSubList(tokens, 0, 5), ":")
];
}

fwSetNotify(integer enabled) {
string s = "off"; if (enabled) s = "on";
llMessageLinked(LINK_SET, 0, s, "fw_notify");
}

fwMemory() {
llMessageLinked(LINK_SET, 0, "", "fw_memory");
}

fwReset() {
llMessageLinked(LINK_SET, 0, "", "fw_reset");
}
</lsl>

=== Beispiele ===

Die oben aufgeführen Funktionen erlauben dir zwar die meisten Befehle einfacher zu verwenden, aber einige Details müssen dennoch von Hand erledigt werden, beispielsweise das Angeben von Textstil-Konfigurationen. Die folgenden Zeilen geben dir ein paar Beispiele für die Verwendung der Funktionen.

<lsl>
// Setzt den Text aller Boxen in allen Sets.
fwSetText("Hello world!");

// Setzt den Text der Box "SomeBox".
fwSetBoxText("SomeBox", "This is some box!");

// Setzt den Standard-Stil aller Boxen auf color=red, align=center (der nächste Abschnitt zeigt, wie man dies schöner erledigen kann).
fwSetDefaultStyle("", "c=red;a=center");

// Füge eine Box "NewBox" mit "ExistingBox" als Parent hinzu.
fwAddBox("NewBox", "ExistingBox", 2, 2, 10, 5, "Some initial text", "");

// Lösche eine Box.
fwDelBox("NewBox");

// Sende eine Touch Query aus dem touch_start(...)-Event heraus.
touch_start(integer num) {
fwTouchQuery(llDetectedLinkNumber(0), llDetectedTouchFace(0), "Arbitrary user data goes here");
}

// Verarbeite eine "Touch Reply"-Antwort im link_message(...)-Event.
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_touchreply") {
list result = fwTouchReply(str);
// Die Liste "result" enthält jetzt die Antwort als [boxName, boxRelativeX, boxRelativeY, rootName, absoluteX, absoluteY, userData].
// "boxName" ist leer, wenn die Touch Query ungültig war.
}
}
</lsl>

== Noch angenehmere Verwendung ==

Die Funktionen im letzten Abschnitt sind lediglich Wrapper um die [[FURWARE_text/de|FURWARE_text]]-Befehle, allerdings muss du weiterhin Dinge wie Stileinstellungen selber schreiben und dir die verschiedenen Optionen und deren Werte merken. Die folgenden Konstanten und Funktionen nehmen dir einen Teil dieser Arbeit ab (auch hier gilt, dass du nur die Teile kopieren musst, die du tatsächlich benötigst – auch um Speicher zu sparen!).

{{KBtip|Beachte, dass die folgenden Zeilen die Funktionen im vorigen Abschnitt ergänzen, d.h. du musst die entsprechenden Funktionen zusätzlich mitkopieren.}}

<lsl>
// === Farben (colors) ===

string COLOR_DEFAULT = "c=def;";

// Graustufen.
string COLOR_WHITE = "c=white;";
string COLOR_SILVER = "c=silver;";
string COLOR_GRAY = "c=gray;";
string COLOR_BLACK = "c=black;";

// Standardfarben.
string COLOR_RED = "c=red;";
string COLOR_GREEN = "c=green;";
string COLOR_BLUE = "c=blue;";
string COLOR_CYAN = "c=cyan;";
string COLOR_MAGENTA = "c=magenta;";
string COLOR_YELLOW = "c=yellow;";

// Dunkle Farben.
string COLOR_DARKRED = "c=darkred;";
string COLOR_DARKGREEN = "c=darkgreen;";
string COLOR_DARKBLUE = "c=darkblue;";
string COLOR_DARKCYAN = "c=darkcyan;";
string COLOR_DARKMAGENTA = "c=darkmagenta;";
string COLOR_DARKYELLOW = "c=darkyellow;";

// Beliebige RGB- (Rot, Grün, Blau) Farben.
string fwColorRGB(float red, float green, float blue) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + ",1" + ";";
}

// Beliebige RGBA- (Rot, Grün, Blau, Alpha/Deckkraft) Farben.
string fwColorRGBA(float red, float green, float blue, float alpha) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + "," + (string)alpha + ";";
}

// === Ausrichtung (alignment) ===

string ALIGN_DEFAULT = "a=def;";
string ALIGN_LEFT = "a=left;";
string ALIGN_CENTER = "a=center;";
string ALIGN_RIGHT = "a=right;";

// === Umbruch (wrapping) ===

string WRAP_DEFAULT = "w=def;";
string WRAP_WORD = "w=word;";
string WRAP_CHAR = "w=char;";
string WRAP_NONE = "w=none;";

// === Abschneiden von Leerzeichen am Anfang/Ende (trimming) ===

string TRIM_DEFAULT = "t=def;";
string TRIM_ON = "t=on;";
string TRIM_OFF = "t=off;";

// === Schriftarten (fonts) ===

string FONT_DEFAULT = "f=def;";
string FONT_ANDALE = "f=e31ce6e8-4117-7073-6aac-e6503034b4c5;";
string FONT_ANONYMOUS_PRO = "f=24c4ead5-04cd-1831-5fd9-ec48882e00b1;";
string FONT_ANONYMOUS_PRO_BOLD = "f=82c4fcac-3990-223c-286d-5bc92a258fbc;";
string FONT_DEJAVU = "f=f974fdfc-8fbd-2f29-2b38-3c34411c1fcc;";
string FONT_DEJAVU_BOLD = "f=5054fec3-1465-af8f-2fe5-e9507795c82a;";
string FONT_ENVYCODER = "f=a2ec2cf0-b207-db51-d4a1-f3f8d6684c07;";
string FONT_FREEFONT = "f=05f6f69e-8bdf-a824-a2cf-d91c9e371c23;";
string FONT_INCONSOLATA = "f=867288f9-940e-a7cf-ac7d-5596ea7fb2c5;";
string FONT_LIBERATION = "f=c992dfc4-0aca-02c8-bc01-8330e6db6f87;";
string FONT_LIBERATION_BOLD = "f=1494337d-5296-3c43-8f7c-45617448ec9a;";
string FONT_LUXI = "f=2d8f52d7-2220-2d7a-15b5-e685a9449e5c;";
string FONT_LUXI_BOLD = "f=03812794-535b-f546-6171-6bec5bf399be;";
string FONT_MONOFUR = "f=8fc63e35-a18f-e335-3936-e2ca196a944d;";
string FONT_NOVA = "f=2df8e09d-e1bd-d17f-6bec-b8d713790380;";
string FONT_PROFONT = "f=45a8e6f6-90e4-299d-d3bc-0bf4dbf170db;";

// === Rahmen (borders) ===

string BORDER_DEFAULT = "border=def;";

// Einige Beispiele für oft benutzte Rahmenstile.
string BORDER_ALL_SIDES = "border=tblr;";
string BORDER_ALL_SIDES_THICK = "border=tblr1;";
string BORDER_ALL_SIDES_DOUBLE = "border=tblr2;";
string BORDER_BOTTOM = "border=b;";
string BORDER_LEFT_RIGHT = "border=lr;";

// Eine allgemeinere Hilfsfunktion für Rahmen. Die Seiten-Parameter sind von oben beginnend im Uhrzeigersinn angeordnet.
string fwBorder(integer top, integer right, integer bottom, integer left, integer style) {
string result = "border=";
if (top) result += "t"; if (right) result += "r";
if (bottom) result += "b"; if (left) result += "l";
if (style) result += (string)style;
return result + ";";
}
</lsl>

=== Beispiele ===

Jeder Wert der Konstanten endet mit einem ";". Das erlaubt dir, die Konstanten einfach mit "+" zu verbinden und trotzdem gültige Strings für Stileinstellungen zu erhalten. Damit kannst du so etwas schreiben wie:

<lsl>
// Setzt die Farbe (color), den Umbruch (wrapping) und die Schriftart (font) für alle Boxen.
fwSetStyle(COLOR_YELLOW + WRAP_NONE + FONT_MONOFUR);

// Setzt die Standard-Stileinstellung für alle Boxen.
fwSetDefaultStyle("", COLOR_RED + ALIGN_CENTER);

// Füge eine Box mit einer Stileinstellung hinzu. Wir benutzen hier eine selbstspezifizierte RGB-Farbe.
fwAddBox("SomeBox", "ParentBox", 2, 2, 10, 5, "Some initial text", FONT_LUXI + fwColorRGB(0.5, 0.75, 0.0) + BORDER_ALL_SIDES);
</lsl>

User talk:Ochi Wolfe

2013-07-10T23:19:04Z

Ochi Wolfe:

== Moin ==

Ich war so frei und hab mal deinen Projektseiten ein paar wiki-interne Links verpasst. Schönen Abend noch! -- [[User:Kireji Haiku|Kireji Haiku]] 15:18, 10 July 2013 (PDT)
:Sehr cool, danke. :) -- [[User:Ochi Wolfe|Ochi Wolfe]] 16:19, 10 July 2013 (PDT)

FURWARE text/Snippets/de

2013-07-10T22:00:43Z

Ochi Wolfe:

{{Multi-lang}}

Diese Seite beinhaltet verschiedene nützliche Code-Schnipsel (Funktionen, Konstanten), die die Arbeit mit FURWARE text wesentlich angenehmer machen.

== Grundlegende Funktionen ==

Die Funktionen in diesem Abschnitt sind Wrapper um die einzelnen FURWARE text-Befehle. Sie wurden so entworfen, dass sie den folgenden Anforderungen genügen:

* Die Funktionen sollen ''in sich abgeschlossen'' sein. Das heißt, dass du auch nur diejenigen Funktionen kopieren kannst, die du wirklich benötigst und sie werden funktionieren.
* Die Funktionen (und deren Parameter) sollen ''selbsterklärend'' sein. Das heißt, dass sie auch direkt als eine Kurzreferenz für den Befehl dienen sollen, den sie ausführen.

Dass die Funktionen in sich abgeschlossen sind bedeutet auch, dass jede der Funktionen einen ''llMessageLinked(...)''-Aufruf enthält. Das Ziel dieser Aufrufe ist hier auf ''LINK_SET'' (also das gesamte Linkset) gesetzt. Falls nötig, ändere dieses Ziel bitte in deinen Skripten.

<lsl>
fwSetText(string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data");
}

fwSetBoxText(string box, string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data:" + box);
}

fwSetStyle(string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf");
}

fwSetBoxStyle(string box, string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf:" + box);
}

fwSetDefaultStyle(string target, string style) {
// "target" darf leer, "root" oder "nonroot" sein.
llMessageLinked(LINK_SET, 0, style, "fw_defaultconf:" + target);
}

fwSetVariable(string name, string value) {
llMessageLinked(LINK_SET, 0, value, "fw_var:" + name);
}

fwAddBox(string name, string parent, integer x, integer y, integer w, integer h, string text, string style) {
llMessageLinked(LINK_SET, 0, text, "fw_addbox: " +name + ":" + parent + ":"+
(string)x + "," + (string)y + "," + (string)w + "," + (string)h + ":" + style);
}

fwDelBox(string name) {
llMessageLinked(LINK_SET, 0, "", "fw_delbox:" + name);
}

fwTouchQuery(integer linkNumber, integer faceNumber, string userData) {
llMessageLinked(LINK_SET, 0, userData, "fw_touchquery:" + (string)linkNumber + ":" + (string)faceNumber);
}

list fwTouchReply(string replyString) {
list tokens = llParseStringKeepNulls(replyString, [":"], []);
return [
llList2String(tokens, 0), llList2Integer(tokens, 1), llList2Integer(tokens, 2),
llList2String(tokens, 3), llList2Integer(tokens, 4), llList2Integer(tokens, 5),
llDumpList2String(llDeleteSubList(tokens, 0, 5), ":")
];
}

fwSetNotify(integer enabled) {
string s = "off"; if (enabled) s = "on";
llMessageLinked(LINK_SET, 0, s, "fw_notify");
}

fwMemory() {
llMessageLinked(LINK_SET, 0, "", "fw_memory");
}

fwReset() {
llMessageLinked(LINK_SET, 0, "", "fw_reset");
}
</lsl>

=== Beispiele ===

Die oben aufgeführen Funktionen erlauben dir zwar die meisten Befehle einfacher zu verwenden, aber einige Details müssen dennoch von Hand erledigt werden, beispielsweise das Angeben von Textstil-Konfigurationen. Die folgenden Zeilen geben dir ein paar Beispiele für die Verwendung der Funktionen.

<lsl>
// Setzt den Text aller Boxen in allen Sets.
fwSetText("Hello world!");

// Setzt den Text der Box "SomeBox".
fwSetBoxText("SomeBox", "This is some box!");

// Setzt den Standard-Stil aller Boxen auf color=red, align=center (der nächste Abschnitt zeigt, wie man dies schöner erledigen kann).
fwSetDefaultStyle("", "c=red;a=center");

// Füge eine Box "NewBox" mit "ExistingBox" als Parent hinzu.
fwAddBox("NewBox", "ExistingBox", 2, 2, 10, 5, "Some initial text", "");

// Lösche eine Box.
fwDelBox("NewBox");

// Sende eine Touch Query aus dem touch_start(...)-Event heraus.
touch_start(integer num) {
fwTouchQuery(llDetectedLinkNumber(0), llDetectedTouchFace(0), "Arbitrary user data goes here");
}

// Verarbeite eine "Touch Reply"-Antwort im link_message(...)-Event.
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_touchreply") {
list result = fwTouchReply(str);
// Die Liste "result" enthält jetzt die Antwort als [boxName, boxRelativeX, boxRelativeY, rootName, absoluteX, absoluteY, userData].
// "boxName" ist leer, wenn die Touch Query ungültig war.
}
}
</lsl>

== Noch angenehmere Verwendung ==

Die Funktionen im letzten Abschnitt sind lediglich Wrapper um die FURWARE text-Befehle, allerdings muss du weiterhin Dinge wie Stileinstellungen selber schreiben und dir die verschiedenen Optionen und deren Werte merken. Die folgenden Konstanten und Funktionen nehmen dir einen Teil dieser Arbeit ab (auch hier gilt, dass du nur die Teile kopieren musst, die du tatsächlich benötigst – auch um Speicher zu sparen!).

{{KBtip|Beachte, dass die folgenden Zeilen die Funktionen im vorigen Abschnitt ergänzen, d.h. du musst die entsprechenden Funktionen zusätzlich mitkopieren.}}

<lsl>
// === Farben (colors) ===

string COLOR_DEFAULT = "c=def;";

// Graustufen.
string COLOR_WHITE = "c=white;";
string COLOR_SILVER = "c=silver;";
string COLOR_GRAY = "c=gray;";
string COLOR_BLACK = "c=black;";

// Standardfarben.
string COLOR_RED = "c=red;";
string COLOR_GREEN = "c=green;";
string COLOR_BLUE = "c=blue;";
string COLOR_CYAN = "c=cyan;";
string COLOR_MAGENTA = "c=magenta;";
string COLOR_YELLOW = "c=yellow;";

// Dunkle Farben.
string COLOR_DARKRED = "c=darkred;";
string COLOR_DARKGREEN = "c=darkgreen;";
string COLOR_DARKBLUE = "c=darkblue;";
string COLOR_DARKCYAN = "c=darkcyan;";
string COLOR_DARKMAGENTA = "c=darkmagenta;";
string COLOR_DARKYELLOW = "c=darkyellow;";

// Beliebige RGB- (Rot, Grün, Blau) Farben.
string fwColorRGB(float red, float green, float blue) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + ",1" + ";";
}

// Beliebige RGBA- (Rot, Grün, Blau, Alpha/Deckkraft) Farben.
string fwColorRGBA(float red, float green, float blue, float alpha) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + "," + (string)alpha + ";";
}

// === Ausrichtung (alignment) ===

string ALIGN_DEFAULT = "a=def;";
string ALIGN_LEFT = "a=left;";
string ALIGN_CENTER = "a=center;";
string ALIGN_RIGHT = "a=right;";

// === Umbruch (wrapping) ===

string WRAP_DEFAULT = "w=def;";
string WRAP_WORD = "w=word;";
string WRAP_CHAR = "w=char;";
string WRAP_NONE = "w=none;";

// === Abschneiden von Leerzeichen am Anfang/Ende (trimming) ===

string TRIM_DEFAULT = "t=def;";
string TRIM_ON = "t=on;";
string TRIM_OFF = "t=off;";

// === Schriftarten (fonts) ===

string FONT_DEFAULT = "f=def;";
string FONT_ANDALE = "f=e31ce6e8-4117-7073-6aac-e6503034b4c5;";
string FONT_ANONYMOUS_PRO = "f=24c4ead5-04cd-1831-5fd9-ec48882e00b1;";
string FONT_ANONYMOUS_PRO_BOLD = "f=82c4fcac-3990-223c-286d-5bc92a258fbc;";
string FONT_DEJAVU = "f=f974fdfc-8fbd-2f29-2b38-3c34411c1fcc;";
string FONT_DEJAVU_BOLD = "f=5054fec3-1465-af8f-2fe5-e9507795c82a;";
string FONT_ENVYCODER = "f=a2ec2cf0-b207-db51-d4a1-f3f8d6684c07;";
string FONT_FREEFONT = "f=05f6f69e-8bdf-a824-a2cf-d91c9e371c23;";
string FONT_INCONSOLATA = "f=867288f9-940e-a7cf-ac7d-5596ea7fb2c5;";
string FONT_LIBERATION = "f=c992dfc4-0aca-02c8-bc01-8330e6db6f87;";
string FONT_LIBERATION_BOLD = "f=1494337d-5296-3c43-8f7c-45617448ec9a;";
string FONT_LUXI = "f=2d8f52d7-2220-2d7a-15b5-e685a9449e5c;";
string FONT_LUXI_BOLD = "f=03812794-535b-f546-6171-6bec5bf399be;";
string FONT_MONOFUR = "f=8fc63e35-a18f-e335-3936-e2ca196a944d;";
string FONT_NOVA = "f=2df8e09d-e1bd-d17f-6bec-b8d713790380;";
string FONT_PROFONT = "f=45a8e6f6-90e4-299d-d3bc-0bf4dbf170db;";

// === Rahmen (borders) ===

string BORDER_DEFAULT = "border=def;";

// Einige Beispiele für oft benutzte Rahmenstile.
string BORDER_ALL_SIDES = "border=tblr;";
string BORDER_ALL_SIDES_THICK = "border=tblr1;";
string BORDER_ALL_SIDES_DOUBLE = "border=tblr2;";
string BORDER_BOTTOM = "border=b;";
string BORDER_LEFT_RIGHT = "border=lr;";

// Eine allgemeinere Hilfsfunktion für Rahmen. Die Seiten-Parameter sind von oben beginnend im Uhrzeigersinn angeordnet.
string fwBorder(integer top, integer right, integer bottom, integer left, integer style) {
string result = "border=";
if (top) result += "t"; if (right) result += "r";
if (bottom) result += "b"; if (left) result += "l";
if (style) result += (string)style;
return result + ";";
}
</lsl>

=== Examples ===

Jeder Wert der Konstanten endet mit einem ";". Das erlaubt dir, die Konstanten einfach mit "+" zu verbinden und trotzdem gültige Strings für Stileinstellungen zu erhalten. Damit kannst du so etwas schreiben wie:

<lsl>
// Setzt die Farbe (color), den Umbruch (wrapping) und die Schriftart (font) für alle Boxen.
fwSetStyle(COLOR_YELLOW + WRAP_NONE + FONT_MONOFUR);

// Setzt die Standard-Stileinstellung für alle Boxen.
fwSetDefaultStyle("", COLOR_RED + ALIGN_CENTER);

// Füge eine Box mit einer Stileinstellung hinzu. Wir benutzen hier eine selbstspezifizierte RGB-Farbe.
fwAddBox("SomeBox", "ParentBox", 2, 2, 10, 5, "Some initial text", FONT_LUXI + fwColorRGB(0.5, 0.75, 0.0) + BORDER_ALL_SIDES);
</lsl>

FURWARE text/Snippets

2013-07-10T21:49:30Z

Ochi Wolfe:

{{Multi-lang}}

This page contains several useful code snippets (functions, constants) that can make the usage of FURWARE text a lot more convenient.

== Basic convenience functions ==

The functions in this section are wrappers around each of the FURWARE text commands. They were designed to follow these rules:

* The functions shall be ''self-contained''. That is, you may copy any subset of the functions that you need and they will work.
* The functions (and their parameters) shall be ''self-explanatory''. That is, they also serve as a quick reference guide to the parameters of the commands they execute.

The fact that the functions are self-contained also means that each of them contains a ''llMessageLinked(...)''-call. The target of this call is set to ''LINK_SET'' (the whole linkset). Please change this target accordingly in your scripts, if needed.

<lsl>
fwSetText(string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data");
}

fwSetBoxText(string box, string text) {
llMessageLinked(LINK_SET, 0, text, "fw_data:" + box);
}

fwSetStyle(string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf");
}

fwSetBoxStyle(string box, string style) {
llMessageLinked(LINK_SET, 0, style, "fw_conf:" + box);
}

fwSetDefaultStyle(string target, string style) {
// "target" may be empty, "root" or "nonroot".
llMessageLinked(LINK_SET, 0, style, "fw_defaultconf:" + target);
}

fwSetVariable(string name, string value) {
llMessageLinked(LINK_SET, 0, value, "fw_var:" + name);
}

fwAddBox(string name, string parent, integer x, integer y, integer w, integer h, string text, string style) {
llMessageLinked(LINK_SET, 0, text, "fw_addbox: " +name + ":" + parent + ":"+
(string)x + "," + (string)y + "," + (string)w + "," + (string)h + ":" + style);
}

fwDelBox(string name) {
llMessageLinked(LINK_SET, 0, "", "fw_delbox:" + name);
}

fwTouchQuery(integer linkNumber, integer faceNumber, string userData) {
llMessageLinked(LINK_SET, 0, userData, "fw_touchquery:" + (string)linkNumber + ":" + (string)faceNumber);
}

list fwTouchReply(string replyString) {
list tokens = llParseStringKeepNulls(replyString, [":"], []);
return [
llList2String(tokens, 0), llList2Integer(tokens, 1), llList2Integer(tokens, 2),
llList2String(tokens, 3), llList2Integer(tokens, 4), llList2Integer(tokens, 5),
llDumpList2String(llDeleteSubList(tokens, 0, 5), ":")
];
}

fwSetNotify(integer enabled) {
string s = "off"; if (enabled) s = "on";
llMessageLinked(LINK_SET, 0, s, "fw_notify");
}

fwMemory() {
llMessageLinked(LINK_SET, 0, "", "fw_memory");
}

fwReset() {
llMessageLinked(LINK_SET, 0, "", "fw_reset");
}
</lsl>

=== Examples ===

The above snippets allow you to use the basic commands more easily, but you may still need to do some manual work, for example when specifying style configuration strings. The following lines give a few assorted examples of calls using the functions.

<lsl>
// Set the text of all boxes in all sets.
fwSetText("Hello world!");

// Set the text of the box "SomeBox".
fwSetBoxText("SomeBox", "This is some box!");

// Set the default style of all boxes to color=red, align=center (see the next section how to make this much nicer).
fwSetDefaultStyle("", "c=red;a=center");

// Add a box "NewBox" using "ExistingBox" as its parent.
fwAddBox("NewBox", "ExistingBox", 2, 2, 10, 5, "Some initial text", "");

// Delete a box.
fwDelBox("NewBox");

// Send a touch query from the touch_start(...)-event.
touch_start(integer num) {
fwTouchQuery(llDetectedLinkNumber(0), llDetectedTouchFace(0), "Arbitrary user data goes here");
}

// Parse a touch reply in the link_message(...)-event.
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_touchreply") {
list result = fwTouchReply(str);
// The list "result" now contains the reply as [boxName, boxRelativeX, boxRelativeY, rootName, absoluteX, absoluteY, userData].
// "boxName" is empty if the touch query was invalid.
}
}
</lsl>

== Additional awesomeness ==

The functions in the previous section are wrappers around the FURWARE text commands, but you still need to write, for instance, style configuration strings yourself and remember the style options and values. The following set of constants and functions help you with that (again, you don't have to copy all of them but just the ones you need to save script memory!).

{{KBtip|Note that these constants complement the functions defined above, so make sure to copy the functions you need as well.}}

<lsl>
// === Colors ===

string COLOR_DEFAULT = "c=def;";

// Grayscales.
string COLOR_WHITE = "c=white;";
string COLOR_SILVER = "c=silver;";
string COLOR_GRAY = "c=gray;";
string COLOR_BLACK = "c=black;";

// Standard colors.
string COLOR_RED = "c=red;";
string COLOR_GREEN = "c=green;";
string COLOR_BLUE = "c=blue;";
string COLOR_CYAN = "c=cyan;";
string COLOR_MAGENTA = "c=magenta;";
string COLOR_YELLOW = "c=yellow;";

// Dark colors.
string COLOR_DARKRED = "c=darkred;";
string COLOR_DARKGREEN = "c=darkgreen;";
string COLOR_DARKBLUE = "c=darkblue;";
string COLOR_DARKCYAN = "c=darkcyan;";
string COLOR_DARKMAGENTA = "c=darkmagenta;";
string COLOR_DARKYELLOW = "c=darkyellow;";

// Arbitrary RGB (red, green, blue) color.
string fwColorRGB(float red, float green, float blue) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + ",1" + ";";
}

// Arbitrary RGBA (red, green, blue, alpha/opacity) color.
string fwColorRGBA(float red, float green, float blue, float alpha) {
return "c=" + (string)red + "," + (string)green + "," + (string)blue + "," + (string)alpha + ";";
}

// === Alignment ===

string ALIGN_DEFAULT = "a=def;";
string ALIGN_LEFT = "a=left;";
string ALIGN_CENTER = "a=center;";
string ALIGN_RIGHT = "a=right;";

// === Wrapping ===

string WRAP_DEFAULT = "w=def;";
string WRAP_WORD = "w=word;";
string WRAP_CHAR = "w=char;";
string WRAP_NONE = "w=none;";

// === Trimming ===

string TRIM_DEFAULT = "t=def;";
string TRIM_ON = "t=on;";
string TRIM_OFF = "t=off;";

// === Fonts ===

string FONT_DEFAULT = "f=def;";
string FONT_ANDALE = "f=e31ce6e8-4117-7073-6aac-e6503034b4c5;";
string FONT_ANONYMOUS_PRO = "f=24c4ead5-04cd-1831-5fd9-ec48882e00b1;";
string FONT_ANONYMOUS_PRO_BOLD = "f=82c4fcac-3990-223c-286d-5bc92a258fbc;";
string FONT_DEJAVU = "f=f974fdfc-8fbd-2f29-2b38-3c34411c1fcc;";
string FONT_DEJAVU_BOLD = "f=5054fec3-1465-af8f-2fe5-e9507795c82a;";
string FONT_ENVYCODER = "f=a2ec2cf0-b207-db51-d4a1-f3f8d6684c07;";
string FONT_FREEFONT = "f=05f6f69e-8bdf-a824-a2cf-d91c9e371c23;";
string FONT_INCONSOLATA = "f=867288f9-940e-a7cf-ac7d-5596ea7fb2c5;";
string FONT_LIBERATION = "f=c992dfc4-0aca-02c8-bc01-8330e6db6f87;";
string FONT_LIBERATION_BOLD = "f=1494337d-5296-3c43-8f7c-45617448ec9a;";
string FONT_LUXI = "f=2d8f52d7-2220-2d7a-15b5-e685a9449e5c;";
string FONT_LUXI_BOLD = "f=03812794-535b-f546-6171-6bec5bf399be;";
string FONT_MONOFUR = "f=8fc63e35-a18f-e335-3936-e2ca196a944d;";
string FONT_NOVA = "f=2df8e09d-e1bd-d17f-6bec-b8d713790380;";
string FONT_PROFONT = "f=45a8e6f6-90e4-299d-d3bc-0bf4dbf170db;";

// === Borders ===

string BORDER_DEFAULT = "border=def;";

// These are just some examples for common border styles.
string BORDER_ALL_SIDES = "border=tblr;";
string BORDER_ALL_SIDES_THICK = "border=tblr1;";
string BORDER_ALL_SIDES_DOUBLE = "border=tblr2;";
string BORDER_BOTTOM = "border=b;";
string BORDER_LEFT_RIGHT = "border=lr;";

// A more general helper function for borders. The side parameters are ordered clockwise, starting on top.
string fwBorder(integer top, integer right, integer bottom, integer left, integer style) {
string result = "border=";
if (top) result += "t"; if (right) result += "r";
if (bottom) result += "b"; if (left) result += "l";
if (style) result += (string)style;
return result + ";";
}
</lsl>

=== Examples ===

Note that the value of each constant ends with ";". This allows you to simply "+" them together and you still get valid style strings which you may then use wherever you need a style config string. This allows you to write things like this:

<lsl>
// Set the color, wrapping and font of all boxes.
fwSetStyle(COLOR_YELLOW + WRAP_NONE + FONT_MONOFUR);

// Set the default style for all boxes.
fwSetDefaultStyle("", COLOR_RED + ALIGN_CENTER);

// Add a box with some style config. We will use a custom RGB color here.
fwAddBox("SomeBox", "ParentBox", 2, 2, 10, 5, "Some initial text", FONT_LUXI + fwColorRGB(0.5, 0.75, 0.0) + BORDER_ALL_SIDES);
</lsl>