LScript Documentation

[Matt]

A big one for me, and I don't think I'm alone here, would be better LScript documentation.

Essentially every command that is available, fully documented with the inputs (if any) it needs and the outputs the command gives, written in an easy to understand (non-coder speak) format, along with an example for each one.

Cheers
Matt

[JohnMarchant]

I would second that matt. I for one would love to get into LScript, but there is poor documentation for an LScript newbie and like you said preferably in non techie speak.

Reagrds, John

[masterchief]

Still waiting for copy of LSIDE macros referenced in LScript v2.6 release notes

LSIDE Editor v1.3 Release notes


Name Type Description
------------------ -------------- --------------------------------------------
autosave.els filter saves the current document after a specified
number of keystrokes
a_to_A.els filter uses the replaceKey() function to capatilize
all typed lower-case 'a' characters
cf_template.els run-once simple script that creates a new document and
places a Channel Filter template into it
changecase.els run-once alters the case of the characters in the document.
adheres to any current selection. employs the
LScript requester mechanism.
color_e.els run-once changes the color of all the 'e' or 'E' characters
on the current line
disablecode.els run-once places a single-line comment operator (//) at
the start of every line in the current selection
enablecode.els run-once removes any single-line comment operators from
the start of every line in the selection
keycomplete.els filter completes the keyword from a partial entry when
the tab key is pressed
reformat.els run-once re-formats a script to make it more readable
smartindent.els filter automates code-based indentation in a smart
fashion
sort.els run-once sorts selected document lines in ascending order

[Chuck]

The LScripts are indeed being completely revised, and there is already a section for discussion of the LScript Documentation -

LScript Documentation Forum (http://vbulletin.newtek.com/forumdisplay.php?f=169)

Please post your requests and comments on LScript Documentation there. I've cloned the thread to this forum, and locked the version in the General Docs forum off.

[joshs]

I've been programming for a few years but I'm new to Lightwave, and I'm not sure if there's some piece of documentation that I'm missing, or if there's just a big hole in the docs.

I found the .pdf User Guide and Command Reference at http://www.newtek.com/products/lightwave/developer/LW80/8lwsdk/docs/lscript/index.html but these still seem to have gaps.

For example, I've seen the CommandInput() function mentioned a lot in board postings, but it's nowhere in those documents. Neither is the ApplyServer() command. There's also the whole class of commands that cause Lightwave to activate parts of its UI or set preferences... like calling RenderOptions to display settings or SaveRGBPrefix to set an output directory.

Have I missed some key documentation? There's got to be a better way to figure out commands than sniffing the name of every command sent to a Master Class script.

[Dodgy]

In the SDK there's the Lscript release notes, which are a series of additions to the documentation. The docs include stuff up to release 2 I think, the newer stuff is in the release notes..