Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

Basic Components
[LUA extensions]


Detailed Description

LUA low level tool-kit.

Author:
benjamin gerard

vincent penne


Files

file  basic.lua
 basic things used into other library (evt, keyboard_emu, gui)

file  init.lua
 Fundamental lua stuff.


Modules

group Doubly Linked List
 doubly linked list support

group Table Operators
 table operators

group Color operations
 color operations

group LUA libraries
 LUA libraries.

group Help system
 Dynamic help for shell commands.

group Driver Support
 driver support

group Playlist
 loading and saving playlist file.

group Zed, The Ziggy's Editor
 zed, the ziggy's editor


Functions

 dup (var v)
 Duplicate any type.

 type_dump (var v, var name, var indent)
 Get a lua compatible string describing this object.

 dump (var v, var name, var indent)
 Print a lua compatible string describing this object.

 clip_value (var v, var min, var max)
 Clip a value.

 set_vertex (var vect, var from)
 Set a vextex.

 printf (...)
 printf like function.

 clearconsole ()
 Console clear.

 doshellcommand (string)
 Simple doshellcommand (reimplemented in shell.lua).


Function Documentation

dup var  v  ) 
 

Duplicate any type.

Parameters:
v anything to duplicate
Returns:
duplication of v

type_dump var  v,
var  name,
var  indent
 

Get a lua compatible string describing this object.

Parameters:
v Object to dump
name Optional name of v
indent Indent level
Returns:
string
Warning:
This is a recursive "dangerous" function.

dump var  v,
var  name,
var  indent
 

Print a lua compatible string describing this object.

See also:
type_dump()

clip_value var  v,
var  min,
var  max
 

Clip a value.

Parameters:
v Value to clip
min Optional minimum clip value.
max Optional maximum clip value.
Returns:
clipped value
Warning:
if respectively min / max is not nil, v<min / v>max must be a valid operation

set_vertex var  vect,
var  from
 

Set a vextex.

Parameters:
vect Vector (matrix line)
from Table containing vector components

printf ...   ) 
 

printf like function.

Parameters:
... format string and arguments needed by format string.
Warning:
Add a trailing newline.

clearconsole  ) 
 

Console clear.

The clearconsole() function send a "\027E" string to the console with the rawprint() function. That will clear the console.

function clearconsole() if type(rawprint) == "function" then rawprint("\027E") end end

See also:
dcplaya_mutermdef_devel for other terminal escape codes.

doshellcommand string   ) 
 

Simple doshellcommand (reimplemented in shell.lua).

Parameters:
string lua command
function doshellcommand(string) return dostring(string) end


dcplaya documentation version 2.0 Generated on November 2004 by doxygen 1.3.6