LitDev Extension API

LD3DView LDArray LDBits LDBlueTooth LDCall
LDChart LDClient LDClipboard LDColours LDCommPort
LDController LDControls LDCursors LDDataBase LDDateTime
LDDebug LDDialogs LDDictionary LDEffect LDEmail
LDEncryption LDEvents LDFastArray LDFastShapes LDFigures
LDFile LDFocus LDftp LDGraph LDGraphicsWindow
LDHID LDIcon LDImage LDInline LDIOWarrior
LDList LDLogic LDMath LDMathX LDMatrix
LDMusic LDNetwork LDPhysics LDProcess LDQueue
LDRegex LDResources LDScrollBars LDSearch LDServer
LDSettings LDShapes LDShell LDSort LDSound
LDSpeech LDStatistics LDStopwatch LDText LDTextWindow
LDTimer LDTranslate LDUnits LDUtilities LDVector
LDWaveForm LDWebCam LDWindows LDxml LDZip

LDUtilities
General

CleanTemp ColourList CSVDeliminator
CurrentCulture DPIX DPIY
FixFlickr FontList ForceInvoke
GetCultureInvariantNumber GetCurrentCultureNumber GetNextMapIndex
IsNumber KeyDown NetworkURL
Priority SendClick ShowErrors
ShowFileErrors ShowNoShapeErrors ShowPrintPreview
UseDispatcher UseExpression Version

CleanTemp()
Delete all Small Basic related files from the temp folder.
These are files with extensions tmp, pdb and dll.
Other applications may also use these, so best to use with no other apps running.

returns The number of files deleted.

ColourList()
Get an array of available colour names.
returns An array of colour names.

CSVDeliminator
A single character deliminator for reading and writing CSV files
Default ","


CurrentCulture
Get or set the current culture.

DPIX
Get the display device X DPI (dots per inch) resolution.

DPIY
Get the display device Y DPI (dots per inch) resolution.

FixFlickr()
Fix the Flickr object (Version 1.0).

FontList()
Get an array of available font names.
returns An array of font names.

ForceInvoke
Experimental option to speed some interactions with SmallBasicLibrary objects.
0 no force (default), 1 force Invoke (serial), 2 force BeginInvoke (async)


GetCultureInvariantNumber(input)
Get a number expressed in the culture invariant form.
A number must be culture invariant in order to be treated as a number in calculations.
A current culture number is how it is input or output.
For example "3.14" is culture invariant, while "3,14" is French culture.

input A number expressed in the current culture.
returns The number expressed in culture invariant form or input on failure.

GetCurrentCultureNumber(input)
Get a number expressed in the current culture.
A number must be culture invariant in order to be treated as a number in calculations.
A current culture number is how it is input or output.
For example "3.14" is culture invariant, while "3,14" is French culture.

input A culture invariant number.
returns The number expressed in the current culture or input on failure.

GetNextMapIndex(listName)
Get the next integer for object names.
For example Buttons are labeled "Button1", "Button2" etc.
This method returns the integer index that would be used for the next object added.

listName The map (list) type, valid listNames (Case sensitive) are:
"Button"
"TextBox"
"ImageList"
"Ellipse"
"Image"
"Line"
"Rectangle"
"Text"
"Triangle"
"Polygon"
"Control"

returns The next object index to be used (0 on failure).

IsNumber(input)
Test if the input will be treated by SmallBasic as a number.
This is a culture invariant number, e.g. "3.14", but not "3,14" or "24x".

input The input to test.
returns "True" or "False"

KeyDown(key)
Get if a key is down.
Useful for simplified keyboard game control.

key The key to get down state, eg "Space".
returns The key down state ("True" or "False")

NetworkURL
Set the web address for use with LDNetwork if gamedata and highscore methods are handled on another server.

Priority
Experimental option to speed some dispatcher interactions with SmallBasicLibrary objects.
1 to 10, (default 7, Render)


SendClick(x,y,button)
Send a mouse click at the specified screen location. Note this is Mouse.MouseX/Y, not GraphicsWindow.MouseX/Y.
x The screen x position to click, -1 uses current mouse position.
y The screen y position to click, -1 uses current mouse position.
button The button to press ("Left", "Right" or "Middle")

ShowErrors
Report any detected errors to TextWindow "True" (default) or "False"

ShowFileErrors
Report any detected file not found errors to TextWindow "True" (default) or "False"

ShowNoShapeErrors
Report any detected shapeName not found in method "True" (default) or "False"

ShowPrintPreview
Show the print preview window when printing with LDGraphicsWindow.Print and LDTextWindow.Print ("True" or "False")
Default "True"


UseDispatcher
Experimental option to speed some interactions with SmallBasicLibrary objects.
"True" (default) or "False"


UseExpression
Experimental option to speed some interactions with SmallBasicLibrary objects.
"True" (default) or "False"


Version()
Gets the current version of the extension and displays a window with this information and a changelog.
returns The current version.