Linden Scripting Language: Difference between revisions

Linden Scripting Language (LSL)

Typing discipline	strong
OS	cross-platform
Website	wiki.secondlife.com/wiki/LSL_Portal
Influenced by
C

Linden Scripting Language, or LSL, is the programming language used by residents of Second Life (SL), a virtual world by Linden Lab and similar virtual worlds.

LSL has a syntax similar to C and allows objects to control the behavior of in-world objects of Second Life from the Internet via email, XML-RPC, and most recently, HTTP requests.

LSL design

Linden Scripting Language is a state-event driven scripting language, in the sense of a finite state machine. A script consists of variables, function definitions, and one or more named states. Each state contains a description of how to react to events that occur while the program is within that state. The system sends to the script, such as timers, movement, chat (from other agents), email, and collisions (with objects in the virtual world). Scripts can change most aspects of the state of the object and communicate with other objects and agents. As soon as a script is added to an object, and turned on, it begins to execute.

A script is tightly bound to the concept of virtual-world objects (in the 3D modeling sense rather than in the object-oriented sense) called primitives. An object in Second Life represents something like a chair or a wall, or possibly something invisible. Multiple scripts may be placed inside an object, where they all execute simultaneously.

There are over 300 library functions available. Users can also define additional functions. LSL is a strongly typed language that is compiled to bytecode before runtime execution in a virtual machine (VM) on one of Linden Lab's servers.

LSL's native data structures includes integers, floating point numbers, strings, keys (UUID), vectors (used for 3D coordinates and RGB color expression), and rotations (quaternions). There are also heterogeneous lists. There are no arrays; multiple list functions are used to adapt programs requiring array structures. There is no built-in persistent data storage, such as a file or database (though users have found various workarounds for this like storing data in various data fields of the items containing scripts). On the other hand, scripts continue to run even when a user is not logged in, and if an object is saved (taken into inventory), and then re-introduced into the World later, it still maintains its previous state. In addition, the mechanisms for communicating via HTTP can be used to store a state externally.

Some functions in LSL have built-in delays, which range from a 0.1-second delay when (for example) requesting string data from a notecard; to a 20-second script pause after sending an e-mail message. The delays help prevent developers from writing LSL scripts that could overtax system resources. Memory available to LSL scripts (when compiled as mono) is capped at about 64 KiB, which places a practical limit on how much a single script can do, however the ability to use multiple scripts and to call scripts from another script allows the user to pragmatically work around this 64 KiB cap.

Permission system

Certain actions in LSL require permissions:

• take money from agent's account
• take agent's controls
• start or stop Animations on agent
• attach/detach from agent
• change links
• track the agent's camera position and rotation
• control the agent's camera

The permission system, however, is an issue for scripts owned by the land owner: those scripts can modify the parcel settings without requiring permissions. A malicious script can unsit avatars, ban and unban avatars, destroy the terrain that includes returning of objects by letting them fall out of the World, and gather the ip addresses of avatars by manipulating the media settings for that avatar.

Default LSL script

The default script, "Hello, Avatar", a hello world program that speaks (streams message to local chat ("heard" (printed) by all viewers (clients) within 20 meters ^{(3D virtual environment)} of the task)) when the script is first saved, initialized or reset (in this case, since the command is in the default "state", the first to be run on initialization) or 'touched' (a simple user interaction usually initiated using a mouse click), looks like:

default 
{ 
	state_entry() 
	{ 
		llSay(0, "Hello, Avatar!"); 
	} 

	touch_start(integer total_number) 
	{ 
		llSay(0, "Touched."); 
	} 
}

Mono

The revised version of Second Life's scripting virtual machine is based on Mono, the open source implementation of the Microsoft.NET framework. The Mono VM was introduced to several simulators (sims) on the Second Life Beta grid for compatibility testing on 29 January 2008 and later that year on 20 August 2008 Linden Lab started deploying it on the production grid - with the entire production grid updated to use it on 29 August 2008.

While the LSL scripting language remained the same, scripts executed on the Mono underpinnings were up to 220 times faster in execution, but at the cost of a somewhat higher overhead when creating (rezzing) scripted objects and moving them from sim to sim.

More complex example script

Below is an example of a relatively simple LSL script, that when placed in a primitive along with a selection of .wav sound files, users may select the sound files to be played in series. This scripting is required to play full length songs in Second Life, as the sound file length is limited to a maximum of 10 seconds per clip at upload to SL.

// Global variables must be declared above any functions created and above the first "default" state.
// Many LSL scripts are open source, and can be edited by their owners.
// Often scripts have settings variables with instructions for editing written as comments around them.

 // This list of sound file names would be populated by the owner.
list songs = ["Box_Of_Rain", 9.2, "Servant", 9.8];

integer volume = 10; // All variables (global or local) must have their type declared on creation.
integer lis_count;
integer playing;
integer busy; // Values need not be applied to variable at creation.
integer part;
integer lis;
integer sl;
float delay;
list cancel = ["CANCEL"];
list playlist;
list waiting;
list song;
string vol_str = "Volume";
string song_str = "Songs";
string song_name;

// Variable names (as well as function names and state names) must begin with a letter (upper or lower case) or any number of underscores.
// Variable names cannot begin with a numeral, but they may contain numerals as any other character.

// User created functions can be created by simply naming the function.
// Functions that return a value, must have the value type declared as the type for the function.
// Arguments passed to the function must have their types declared. the type of data passed to the function must match the argument type.
list StrideOfList(list src, integer stride, integer start, integer end) {
	list l = [];
	integer ll = llGetListLength(src);
	if(start < 0)start += ll;
	if(end < 0)end += ll;
	if(end < start) return llList2List(src, start, start);
	while(start <= end) {
		l += llList2List(src, start, start);
		start += stride;
	}
	return l;
}
list Volumes(integer vol) {
	integer v = 0;
	list l = [];
	do {
		if(v != vol) // Single instruction conditional blocks need not be wrapped in braces.
		l += [((string)v)];
	}
	while((++v) <= 10);
	return l;
}
PageOne(key k, integer c) {
	llDialog(k, "\nAdjust the volume or select a song to play?", [vol_str, song_str] + cancel, c);
}
PlaySong(string n) {
	song = [];
	integer c = -1;
	string name = "";
	do { // Functions may be nested and used inline where values are returned (the values need not be stored to a variable for use).
		if(llSubStringIndex((name = llGetInventoryName(INVENTORY_SOUND, (++c))), n) != -1)
		song += [name];
	}
	while(name);
	delay = llList2Float(songs, (llListFindList(songs, [n]) + 1));
	if((sl = llGetListLength(song))) {
		llPreloadSound(llList2String(song, (part = 0)));
		if(sl > 1)
		llPreloadSound(llList2String(song, 1));
		playing = FALSE;
		llSetTimerEvent(0.01);
	}
}
integer Chan() {
	return llRound((llFrand(-5000000.0) + -500000.0));
}
float ScaleVol(integer v) {
	return (v * 0.1);
}
Listen(integer c, key a) {
	lis = llListen(c, "", a, "");
}
RemoveListen(integer b) {
	llListenRemove(lis);
	lis_count = 0;
	if(b)
	busy = FALSE;
	lis = 0;
}
SetListenTimer(integer p) {
	if(p)
	while(((++lis_count) * llRound(delay)) < 30);
	else {
		lis_count = 1;
		llSetTimerEvent(30.0);
	}
}
integer CheckWaitingRoom(integer c) {
	if(waiting) {
		key a = llList2Key(waiting, 0);
		if(!c) {
			RemoveListen(0);
			Listen((c = Chan()), a);
			SetListenTimer(playing);
		}
		PageOne(a, c);
		waiting = llDeleteSubList(waiting, 0, 0);
		return 1;
	}
	return 0;
}

// All scripts must have a default state.
// However many other states a script may have, the default state must be uppermost in the script (below global vars and functions).
default {
	// Event names are written in all lower case letters. Some contain underscores.
	on_rez(integer param) {
		// If an event is passed any values as it is triggered, those values will be of specific types.
		// Writers can choose the name for the variable, but not the type.
		// Even if the data contained in the variables passed to the event are not used, the event must contain reference to that data.
		llStopSound();
		llResetScript();
	}
	changed(integer change) {
		if(change & CHANGED_INVENTORY) // Bitwise comparison
		llResetScript();
	}
	touch_start(integer nd) {
 		while(nd) {
			key agent = llDetectedKey(--nd);
			if(!busy) {
 				busy = TRUE;
				integer channel = Chan();
				SetListenTimer(playing);
				Listen(channel, agent);
				PageOne(agent, channel);
			} else {
				list a = [agent];
				if(llListFindList(waiting, a) == -1)
				waiting += a;
			}
		}
	}
	listen(integer chan, string name, key id, string msg) {
		if(msg != llList2String(cancel, 0)) {
			SetListenTimer(playing);
			if(msg == vol_str) {
				llDialog(id, "\nChange the volume?\nThe current volume is set at \"" + ((string)volume) +
					"\"", cancel + Volumes(volume), chan);
				return;
			}
			if(msg == song_str) {
				string current = "";
				if(playlist) {
					current = "\n\nThe songs currently queued are\n\"" + llList2String(playlist, 0) +
						"\" (currently playing)";
					if(llGetListLength(playlist) > 1)
					current += "\n\"" + llDumpList2String(llList2List(playlist, 1, -1), "\"\n\"") + "\"";
				}
				llDialog(id, llGetSubString(("\nSelect a song to play?" + current), 0, 500), cancel +
					StrideOfList(songs, 2, 0, -1), chan);
				return;
			}
			if(llListFindList(Volumes(volume), [msg]) != -1) {
				llAdjustSoundVolume(ScaleVol((volume = ((integer)msg))));
 				PageOne(id, chan);
				return;
			}
			if(llGetListLength((playlist += [msg])) == 1)
			PlaySong((song_name = msg));
		}
		if(CheckWaitingRoom(chan))
		return;
		RemoveListen(1);
	}
	timer() {
		if(playlist) {
			if(!playing) {
				llSetTimerEvent(delay);
				playing = TRUE;
			}
			llPlaySound(llList2String(song, part), ScaleVol(volume));
			if((++part) == sl) {
				if(llGetListLength(playlist) > 1) {
					song_name = llList2String((playlist = llDeleteSubList(playlist, 0, 0)), 0);
					llSleep(delay);
					PlaySong(song_name);
				} else {
					llSetTimerEvent(0.0);
					song_name = "";
					playing = FALSE;
					playlist = [];
				}
			}
			else if(part == (sl - 1))
			llPreloadSound(llList2String(song, 0));
			else
			llPreloadSound(llList2String(song, (part + 1)));
		}
		if(lis && (!(--lis_count))) {
			if(!(CheckWaitingRoom(0)))
			RemoveListen(1);
		}
	}
}

External links

• LSL forum—Second Life LSL forum
• Extensive Tutorial on LSL—Dr. Dobb's
• LSL Wiki—A community effort to supplement the available LSL documentation
• LSL Portal—A new Wiki hosted by Second Life
• Mono for Second Life—Information regarding the move to Mono
• Linden Scripting Language Problems—Criticism by Xah Lee
• Linden Scripting Language Script Repository—Privately maintained library of LSL Scripts.