LSL Style Guide

From Second Life Wiki
Revision as of 04:52, 12 June 2022 by Sei Lisa (talk | contribs) (→‎Script Structure: Variables do not need to come before UDFs; mention event handlers as a mandatory part of states)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Every major open-source project has its own style guide: a set of conventions (sometimes arbitrary) about how to write code for that project. It is much easier to understand a large codebase when all the code in it is in a consistent style. These guidelines, referred to collectively as a Style Guide, are not as rigid as the rules required by the language compiler but nonetheless are critical to creating maintainable code. The most critical aspect of a style is that you apply it consistently to the code you write.

Effective programming in LSL requires that developers use a disciplined approach towards formatting and other conventions in their scripts.

KBcaution.png Important: Applying a style guide to your code does not only help others read your code. It helps you as well, because in future when you return to the code you wrote before, you'll appreciate reading formatted and annotated code.

Use third party editors:

There are many third party editors with LSL syntax files available. See an example below of what your workflow would look like using an editor that has syntax highlighting and autocomplete and also applies an indent style to your code.

Using third party editors has a few advantages over using the editor in the viewers:

  • Autocompletion helps you avoid typos.
  • Autocompletion sometimes not only does a linear autocompletion as in autocompleting llS to llSay but sometimes works even with fuzzy search by autocompleting llslppf to llSetLinkPrimitiveParamsFast.
  • The syntax highlighting file colors the code exactly like the code you see in the official Linden Lab viewer making you not having to learn or adapt to a different coloring scheme.
  • Autocompletion might also preformat code with indent styles when autocompleting states, events, conditional clauses etc.

Indent styles:

Most people, when they start programming on their own, will have programs that are UGLY to look at - to put it nicely, sometimes mistakenly thinking that such scripts occupy less space when compiled. Such scripts typically look like the following:

unstyled source code
default {state_entry(){llSay(0,"Hello World.");}}

However, that code is difficult to read (or at least to follow) - even more so when one is writing a couple hundred lines program. There are several indent styles with the two most common styles being:

K&R style (used in Javascript based languages) Allman style (used in C based languages)
default {
    state_entry() {
        llSay(0, "Hello World.");
        llSay(0, "Hello World.");

The K&R style conserves space - IN THE SOURCE CODE ONLY, however the Allman style is easier to read and easier to visually bracket-match. Once a scripter is in the practice of using a particular style, reading code in that style will become easier.

Consistent indenting makes reading both styles easier that's why it really comes down to whatever works for you. In both methods, indenting is the key indicating factor of levels of scope.

Naming conventions:

There are many naming conventions in Second Life. Only the most used ones will be listed below.

Global Variables (variables used throughout the entire program) should be lowercase. For example:

integer index = 0;
string  name  = "Please set one";

Others prefer to distinguish between global and local variables by prefixing variable names with a character, defining globals in the following manner:

integer gIndex;
string  gName  = "Please set one";

Constant variables should be in ALL CAPS following the style guide used by Linden Labs. For example:

integer DIALOG_CHANNEL = -517265;
vector  RED            = <1.0, 0.0, 0.0>;

Arguments used within a or one of the standard events should be named with easily readable and meaningful names. When using events, please use the standard names as listed here on the official wiki. An overview of all events can be found here. Below is an example as can be found for the listen event:

//  ...

    listen(integer channel, string name, key id, string message)
        key OwnerKey = llGetOwner();
        if (channel == 1 && id == OwnerKey)
            llOwnerSay("Hello Avatar");

//  ...

Separating code:

Some people put too many function calls on one line. As shown in this example, too many function calls on a single line makes the code hard to read and almost impossible to debug.

list    lst;
integer NUM_DIGITS = 10;

default {
    touch_start(integer n) {
        string name = llToLower(llGetSubString(llList2String(llParseString2List(llDetectedName(0), [" "], []), 0), 0, NUM_DIGITS - 1));
        if (!~llListFindList(lst, (list)name))
            lst += name;
//      send a message to the owner, only reaches owner if online and within the same sim

Now here is the code, with the exact same features, in a simpler way. While hardly anyone could tell you what the above code did, almost everyone can figure out what the below code does.

list    listOfStrings;
integer NUM_DIGITS = 10;

    touch_start(integer n) 
        string  name       = llDetectedName(0);
        list    nameAsList = llParseString2List(name, [" "], []);
        string  firstName  = llList2String(nameAsList, 0);
        string  startPart  = llToLower(llGetSubString(firstName, 0, NUM_DIGITS - 1));
        integer index      = llListFindList(listOfStrings, [startPart]);

        if (index == -1)
            listOfStrings += startPart;

//      send a message to the owner, only reaches owner if online and within the same sim

LSL lacks an optimizing compiler. For this reason, it may be necessary to balance the two styles to get faster, more compact executable code. Line combination optimization should only be done after the code is working & bug free. Improper optimization can lead to wrong results. Always test optimized code thoroughly.

Script Structure

LSL scripts are comprised of expressions, functions, statements, event handlers and states. The LSL compiler mandates a certain structure to scripts:

  1. User Defined Variables and Functions (see LSL Variables and User-defined functions)
  2. default State (see State) with at least one Event Handler.
  3. User Defined States, each with at least one Event Handler.

LSL Portal Style

Here in the LSL Portal we expect consistent white-spacing, and it should look similar to either K&R or Allman. We do not require strict adherence to either. We do not use tabs (as they take up an exorbitant amount of screen space) but some number of spaces, usually between 2 and 6, 4 being the most popular value and the value you will see almost everywhere. Generally speaking, it's taboo to edit an article just to fix the white-spacing, unless it's inconsistent (the edit should make it consistent, it should not change the style). Generally speaking, it's taboo to edit an article to change the style. Exceptions do exist, if you are making substantial changes to most of the code in the article, and it makes sense to change the style of the rest of the code (such that it all matches), you may do so. The purpose of this restriction is to keep the peace, some people are really quite attached to their style. Considering that style is a personal preference of little consequence, nothing is gained by forcing one style onto the community, especially when they will go ahead and use whatever style they want disregarding what we mandate. When in doubt or conflict please use the discussion page, a majority are monitored and will be responded to.

If you find yourself desiring to make small changes to white-space despite it being frowned upon, we will ask you to first consider adding an example to one of the articles that needs an example or is missing some key content.