LSL Style Guide

Effective programming in LSL requires that developers use a disciplined practice for applying formatting and convention to their scripts.

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.

Script Structure

LSL scripts are comprised of expressions, functions, statements, event handlers and states. A well formatted LSL script follows this structure:

script variables

user defined functions

states, beginning with default, then listed alphabetically

within states, event handlers, in this order

on_rez state_entry

touches / collisions touch, touch_start, touch_end, collision, collision_start, collision_end, land_collision, land_collision_start, land_collision_end

communications listen, link_message, dataserver, email, remote_data, http_response, no_sensor, sensor, run_time_permissions, control

inventory changed, object_rez, money, attach

movement moving_end, moving_start, at_rot_target, at_target, not_at_rot_target, not_at_target

other

timer, state_exit

Editor

One of the best text editors i have found is text pad ( textpad_site )

Syntax Highlighting

I have created a syntax file that works well syntax file To customize syntax highlighting for Second Life LSL:

1. Choose Preferences from the Configure menu, and the Preferences dialog box will be displayed.

2. Click the "+" next to Document Classes.

3. Click the "+" next to the document class you want to modify.

4. Select Syntax.

5. Check "Enable syntax highlighting".

6. Select a suitable syntax definition file from the list.( sim.syn )

7. Click Apply or OK.