Scripting Documentation
From OpenSimulator
(→String type in OpenSimulator) |
JeffKelley (Talk | contribs) m (Breaking introduction in 2 parts) |
||
| (55 intermediate revisions by 4 users not shown) | |||
| Line 6: | Line 6: | ||
Since version 0.9.1.0, you can chose between old [[XEngine]] or new [[YEngine]] script engines.<br> | Since version 0.9.1.0, you can chose between old [[XEngine]] or new [[YEngine]] script engines.<br> | ||
Script engines do script compilation and control script execution.<br> | Script engines do script compilation and control script execution.<br> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
OpenSimulator script language supports a subset of the Linden Labs Second Life script language (LSL) plus its own extensions (OSSL). | OpenSimulator script language supports a subset of the Linden Labs Second Life script language (LSL) plus its own extensions (OSSL). | ||
| − | == | + | == LSL in a nutshell == |
| − | + | LSL is a event-driven language. A script is a collection of functions called event handlers. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | Events are generated by the environment (mouse clicks, collisions and many more). <u>Many of those events happen at time critical moments, so those event handlers should be small and fast to reduce impact on the rest of simulation.</u> YEngine may allow long processing to happen with less impact on the simulation, but that will happen at lower priority. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | (Hopefully), a script does nothing when there is no event to process. Is sits waiting for an event. Only events matching a event handler present in the script will be generated. If the script has no handler for mouse clicks, mouse clicks won't be reported. | |
| + | LSL functions may also generate events. For example, llRezObject will trigger a object_rez event. llMessageLinked, a link_message event. This makes your script asynchronous (request action in a handler, get result in another handler). Understanding the flow of events in your script is essential. | ||
| + | |||
| + | An event cannot interrupt another event. Processing of the previous event must be finished before accepting a new one. Events are queued up to the number of 300 (OpenSim.ini, MaxScriptEventQueue). Finally, LSL has states that implements the concept of [https://en.wikipedia.org/wiki/Finite-state_machine state machine]. A script can respond differently to a same event in different states, or to another set of events. | ||
| + | |||
| + | == String type in OpenSimulator == | ||
| + | <div style="background-color:#FFA500; padding:10px; padding-bottom:5px; border: 1px #FF544F solid"> | ||
| + | <b>Most OpenSimulator LSL/OSSL string functions are only safe with characters that can be represented by a single .net (UTF-16) char. This means strings with characters of the Basic Multilingual Plane excluding combining characters</b><br> | ||
| + | That is Unicode code points up to U+FFF0, except:<br> | ||
| + | *U+0300..U+036F (combining characters)<br> | ||
| + | *U+1AB0..U+1AFF (combining characters)<br> | ||
| + | *U+1DC0..U+1DFF (combining characters)<br> | ||
| + | *U+20D0..U+20FF (combining characters)<br> | ||
| + | *U+D800..U+DFFF (reserved for higher planes encode using 2 chars)<br> | ||
| + | *U+FE20..U+FE2F<br> | ||
| + | <b>Only in this case some compatibility with SL is possible.</b><br> | ||
| + | OpenSimulator strings are internally encoded as .net strings that are basically arrays of UTF-16 chars.<br> | ||
| + | A unicode character may be represented by more than one of those chars, but most .net and mono string functions ignore this and just assume all characters are single utf16 chars.<br> | ||
| + | For example llStringLength returns the number of .net chars on the string, not necessary the real number of its characters.<br> | ||
| + | Functions that take a index or in string position arguments use them as a index to the array of chars and so that may point to the middle of a complex character. In this case some of this functions may even create strings with invalid characters.<br> | ||
| + | SL string functions do support most cases of 2 char characters, so full compatibility is not possible without breaking compatibility with older OpenSimulator versions. Only in this case some compatibility with SL is possible. Multiple char characters support also has a high performance cost. | ||
</div><br> | </div><br> | ||
| Line 86: | Line 91: | ||
:* [http://sourceforge.net/projects/lsleditor/ LSLeditor SourceForge] | :* [http://sourceforge.net/projects/lsleditor/ LSLeditor SourceForge] | ||
:* [http://www.lsleditor.org/ Original Author's website with his latest LSLeditor version] | :* [http://www.lsleditor.org/ Original Author's website with his latest LSLeditor version] | ||
| − | |||
:Now an Open Source project. New release is February 2012 (Ver.2.44.2). A valuable tool and easy install. | :Now an Open Source project. New release is February 2012 (Ver.2.44.2). A valuable tool and easy install. | ||
---- | ---- | ||
| Line 95: | Line 99: | ||
'''Notepad++''' ''(osFunctions supported with add-on UDF)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]] | '''Notepad++''' ''(osFunctions supported with add-on UDF)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]] | ||
:* [http://notepad-plus-plus.org/ Notepad Plus Plus] | :* [http://notepad-plus-plus.org/ Notepad Plus Plus] | ||
| − | :* [https://github.com/ | + | :* [https://gist.github.com/Tampa/7e02383b5abf1813fb143594cd7bcbdd LSL and OS functions UDF] |
| − | + | ||
:Windows only Editor with enhanced capabilities & supports most languages. Very powerful & feature rich. | :Windows only Editor with enhanced capabilities & supports most languages. Very powerful & feature rich. | ||
---- | ---- | ||
| Line 109: | Line 112: | ||
:To use OSSL feature, use ".ossl" for your script file extension. | :To use OSSL feature, use ".ossl" for your script file extension. | ||
:It is currently compatible with LL v3.4.1 and OpenSimulator v0.7.4+ (master r/21068). | :It is currently compatible with LL v3.4.1 and OpenSimulator v0.7.4+ (master r/21068). | ||
| − | |||
| − | |||
| − | |||
| − | |||
---- | ---- | ||
More editors are listed at http://wiki.secondlife.com/wiki/LSL_Alternate_Editors | More editors are listed at http://wiki.secondlife.com/wiki/LSL_Alternate_Editors | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Miscellaneous: === | === Miscellaneous: === | ||
| − | |||
| − | |||
* [http://code.google.com/p/lslsnippets/ lslsnippets ] | * [http://code.google.com/p/lslsnippets/ lslsnippets ] | ||
| − | |||
| − | |||
| − | |||
* [http://inworks.ucdenver.edu/jkb/fs2lsl/ FS2LSL Flash Scratch to LSL (a feature-rich Scratch-like script code generator)] | * [http://inworks.ucdenver.edu/jkb/fs2lsl/ FS2LSL Flash Scratch to LSL (a feature-rich Scratch-like script code generator)] | ||
| − | |||
* [https://outworldz.com/cgi/freescripts.plx Freescripts] - More then 1000 open source/public domain scripts (library) | * [https://outworldz.com/cgi/freescripts.plx Freescripts] - More then 1000 open source/public domain scripts (library) | ||
| − | |||
| − | |||
* [https://www.conwylie.co.uk/ScriptGenerator/ Con Wylie's Script Generator] - Script Generator. | * [https://www.conwylie.co.uk/ScriptGenerator/ Con Wylie's Script Generator] - Script Generator. | ||
* [http://particles-lsl-generator.bashora.com/ Particles LSL Generator] - LSL Particles System script generator. | * [http://particles-lsl-generator.bashora.com/ Particles LSL Generator] - LSL Particles System script generator. | ||
Latest revision as of 04:05, 6 June 2023
[edit] About OpenSimulator scripting
An important ingredient in virtual worlds simulation is scripting.
Scripts allow the addition of actions to 'entities' in world, like making a door react to a touch and open.
Since version 0.9.1.0, you can chose between old XEngine or new YEngine script engines.
Script engines do script compilation and control script execution.
OpenSimulator script language supports a subset of the Linden Labs Second Life script language (LSL) plus its own extensions (OSSL).
[edit] LSL in a nutshell
LSL is a event-driven language. A script is a collection of functions called event handlers.
Events are generated by the environment (mouse clicks, collisions and many more). Many of those events happen at time critical moments, so those event handlers should be small and fast to reduce impact on the rest of simulation. YEngine may allow long processing to happen with less impact on the simulation, but that will happen at lower priority.
(Hopefully), a script does nothing when there is no event to process. Is sits waiting for an event. Only events matching a event handler present in the script will be generated. If the script has no handler for mouse clicks, mouse clicks won't be reported.
LSL functions may also generate events. For example, llRezObject will trigger a object_rez event. llMessageLinked, a link_message event. This makes your script asynchronous (request action in a handler, get result in another handler). Understanding the flow of events in your script is essential.
An event cannot interrupt another event. Processing of the previous event must be finished before accepting a new one. Events are queued up to the number of 300 (OpenSim.ini, MaxScriptEventQueue). Finally, LSL has states that implements the concept of state machine. A script can respond differently to a same event in different states, or to another set of events.
[edit] String type in OpenSimulator
Most OpenSimulator LSL/OSSL string functions are only safe with characters that can be represented by a single .net (UTF-16) char. This means strings with characters of the Basic Multilingual Plane excluding combining characters
That is Unicode code points up to U+FFF0, except:
- U+0300..U+036F (combining characters)
- U+1AB0..U+1AFF (combining characters)
- U+1DC0..U+1DFF (combining characters)
- U+20D0..U+20FF (combining characters)
- U+D800..U+DFFF (reserved for higher planes encode using 2 chars)
- U+FE20..U+FE2F
Only in this case some compatibility with SL is possible.
OpenSimulator strings are internally encoded as .net strings that are basically arrays of UTF-16 chars.
A unicode character may be represented by more than one of those chars, but most .net and mono string functions ignore this and just assume all characters are single utf16 chars.
For example llStringLength returns the number of .net chars on the string, not necessary the real number of its characters.
Functions that take a index or in string position arguments use them as a index to the array of chars and so that may point to the middle of a complex character. In this case some of this functions may even create strings with invalid characters.
SL string functions do support most cases of 2 char characters, so full compatibility is not possible without breaking compatibility with older OpenSimulator versions. Only in this case some compatibility with SL is possible. Multiple char characters support also has a high performance cost.
LSL (Linden Scripting Language)
OSSL (OpenSimulator Scripting Language)
[edit] Configuring scripting
There are a number of parameters that can be tweaked for scripting, such as those which enable OSSL commands or increase the limits on certain script facilities (e.g. listeners).
For standalone and small grid use, the default scripting settings should be fine. See Configuring Scripting for information on configuring these parameters.
[edit] How to use scripts in OpenSimulator
If you have never written a script in LSL before, then please have a look at the LSL wiki to learn the scripting basics. If you do have (some) experience with writing or editing LSL scripts, then the procedure is identical to the procedure on SL. Known problems:
- Error messages about scripting errors are often cryptic, and tend to be long.
- Script syntax and execution may depend on the engine used, old XEngine or YEngine
- On teleports or crossings from a region using YEngine to a region using XEngine, script state (like changed values on global variables) is lost. Should be okay on the inverse direction.
[edit] Scripting System Status
Status Tables / Charts related to LSL and OSSL functions, constants and related material.
OSSL
[edit] Additional Resources for Scripting (LSL)
There have been many questions regarding scripts and tools for scripting lately. Presented here are a variety of Links to Resources which will help most people with Scripting LSL.
[edit] OpenSimulator Specific Materials:
- OSSL Functions with examples - A good place to start reading about OSSL scripting.
- OSSL Script Library A library of scripts which utilize OSSL functions.
[edit] Suggested Links for LSL wikis:
Note the Tutorials, Examples & Script Libraries
[edit] Off-World Local LSL Editing Tools & Syntax Highlighters
Note: most do not support osFunctions
All EDITORS (no osFunctions) 
- In this repository you can find the syntax grammar, syntax highlighting and snippet files for the Linden Scripting Language (LSL) of Second Life for different kinds of software.
LSL EDITOR (no osFunctions)
- Now an Open Source project. New release is February 2012 (Ver.2.44.2). A valuable tool and easy install.
LSL Plus (no osFunctions)
- Open source Eclipse plugin. Regular updates. Not quite as quick to get installed as LSLEditor, but very good tool.
Notepad++ (osFunctions supported with add-on UDF)
- Windows only Editor with enhanced capabilities & supports most languages. Very powerful & feature rich.
KATE (no osFunctions)
- Free and open source text editor, supporting lots of scriptinmg and programming languages out of the box. This includes LSL.
Sublime Text 2 (os*/wl*/mod* functions supported with the bundle below)
- Completions & syntax coloring of LSL/OSSL functions/events/constants & in-world editor look-and-feel theme.
- To use OSSL feature, use ".ossl" for your script file extension.
- It is currently compatible with LL v3.4.1 and OpenSimulator v0.7.4+ (master r/21068).
More editors are listed at http://wiki.secondlife.com/wiki/LSL_Alternate_Editors
[edit] Miscellaneous:
- lslsnippets
- FS2LSL Flash Scratch to LSL (a feature-rich Scratch-like script code generator)
- Freescripts - More then 1000 open source/public domain scripts (library)
- Con Wylie's Script Generator - Script Generator.
- Particles LSL Generator - LSL Particles System script generator.
- MiceOnABeam - Scripting tools & componants for your virtual wolrd.
- Autoscript - Script Generator.
- Grid URL Persister - Designed to make work with http-in easier.
- Easy Free Database - Designed to easier to save persistent variables in Second Life and OpenSim scripts..
[edit] Additional Resources for Scripting (OSSL)
There have been many questions regarding scripts and tools for scripting lately. Presented here are a a few links to Resources which will help most people with OSSL scripting.
- OSSL Functions with examples - A good place to start reading about OSSL scripting.
- OSSL Script Library A library of scripts which utilize OSSL functions.
- OSSL Proposals - Suggestions for custom OSSL functions. Got a suggestion too? Add it!
- Drawing commands - How to use the texture draw functions supported in OSSL.
- OSSL TextureDrawing - Details of the OSSL texture drawing functions.
- Language Translation - A script which uses the JSON parsing function to call Google's Translation API
- OSGrid Forums - LSL/OSSL discussions, examples, tips, etc.
- OSSL example scripts for inventory - Allows adding the OSSL Functions examples scripts in the default inventory.
[edit] How to contribute
The ScriptEngine is being developed by many developers. New developers are always welcome. If you want to contribute, even just a tiny little bit, have a look at the OpenSim.Region.ScriptEngine page. There is a lot of developer activity on IRC (Support), feel free to drop in.
- OSSL Standards - A whitepaper concerning naming-standards for the OpenSimulator scripting language
- OpenSim.Region.ScriptEngine.Common - How to create your own script engine
- DotNet-Engine - Describes some of the esoteric parts of the DotNet-Engine
[edit] Example LSL Scripts
- An Opensim version for llHTTPResponse
- Changed_Event_Example
- SetScope - Example of using SetScope()
- DONTSITONME
- llParticleSystemExample
- ModSendCommand
- Rotating Prim
- Particles
- Public_Trampoline_Script
- Sit and position
- Sound loop
- Smooth rotate texture
- Presentation Board - Simple Presentation Board that slides through inventory textures.
[edit] See Also
- Scripting Engine - Xengine Script Engine Transition (By Melanie_T), YEngine
- Scripting Languages - Supported Scripting Languages
- LSL/OSSL Status - Status and news about LSL and OSSL
- OSSL Enabling Functions - How to enable OSSL functions.
- Threat level - Information about OSSL threat levels.
