Capricorn 76

ScriptENGINE Namespace Reference


Detailed Description

ScriptENGINE interfaces and data types.

These interfaces are all pre-loaded and available directly from any script.


Classes

class  CPointScript
 2D Point class available in Lua scripts to store X,Y components as a Lua object. More...
class  CVectorScript
 3D Vector class available in Lua scripts to store X,Y,Z components as a Lua object. More...
class  CRectScript
 2D Rectangle class available in Lua scripts to store a rectangle as a Lua object. More...
class  CColorScript
 Color class available in Lua scripts to store RED,GREEN,BLUE,ALPHA components as a Lua object. More...
interface  IApp
 Application interface. More...
interface  IEvents
 Event interface. More...
interface  IGraphics
 Graphics Interface. More...
interface  ISkin
 GUI Skin interface. More...
interface  IKey
 Key interface. More...
interface  ILog
 Logger interface. More...
interface  IMisc
 Miscellaneous interface. More...
interface  IMouse
 Mouse interface. More...
interface  IPhysics
 Physics interface. More...
interface  ISound
 Sound interface. More...
interface  IState
 State interface. More...
interface  IWorld
 World interface. More...

Typedefs

typedef const wchar_t * STRINGW_IN
 A UNICODE compatible lua string.
typedef LuaPlus::LuaObject STRINGW_OUT
 A UNICODE compatible lua string or nil.
typedef const char * STRING_IN
 A NON-UNICODE lua string.
typedef LuaPlus::LuaObject STRING_OUT
 A NON-UNICODE lua string or nil.
typedef const char * ENTITY_IN
 A NON-UNICODE lua string representing an entity identifier.
typedef LuaPlus::LuaObject ENTITY_OUT
 A NON-UNICODE lua string or nil representing an entity identifier.
typedef const wchar_t * GUI_IN
 A UNICODE lua string or nil representing a GUI control identifier.
typedef LuaPlus::LuaObject GUI_OUT
 A UNICODE lua string or nil representing a GUI control identifier.
typedef LuaPlus::LuaObject LUAOBJECT_IN
 Any lua object.
typedef LuaPlus::LuaObject LUAOBJECT_OUT
 Any lua object.
typedef bool BOOLEAN_IN
 true, false, or nil.
typedef bool BOOLEAN_OUT
 true or false.
typedef unsigned int UNSIGNED_INTEGER_IN
 An unsigned integer without decimals (zero or positive) (range 0 to 65535).
typedef unsigned int UNSIGNED_INTEGER_OUT
 An unsigned integer without decimals (zero or positive) (range 0 to 65535).
typedef char CHARACTER_IN
 A lua integer without decimals (negative, zero or positive) (range 0 to 255).
typedef char CHARACTER_OUT
 A lua integer without decimals (negative, zero or positive) (range 0 to 255).
typedef short SMALL_INTEGER_IN
 A lua integer without decimals (negative, zero or positive) (range –32768 to 32767).
typedef short SMALL_INTEGER_OUT
 A lua integer without decimals (negative, zero or positive) (range –32768 to 32767).
typedef int INTEGER_IN
 A lua integer without decimals (negative, zero or positive) (range –2147483647 to 2147483647, lua may limit these values).
typedef int INTEGER_OUT
 A lua integer without decimals (negative, zero or positive) (range –2147483647 to 2147483647, lua may limit these values).
typedef long LARGE_INTEGER_IN
 A lua integer without decimals (negative, zero or positive) (range –2147483647 to 2147483647, lua may limit these values).
typedef long LARGE_INTEGER_OUT
 A lua integer without decimals (negative, zero or positive) (range –2147483647 to 2147483647, lua may limit these values).
typedef float DECIMAL_IN
 A lua decimal number (negative, zero or positive) (range 1.175494351e-38F to 3.402823466e+38F, lua may limit these values).
typedef float DECIMAL_OUT
 A lua decimal number (negative, zero or positive) (range 1.175494351e-38F to 3.402823466e+38F, lua may limit these values).
typedef double LARGE_DECIMAL_IN
 A lua decimal number (negative, zero or positive) (range 2.2250738585072014e-308 to 1.7976931348623158e+308, lua may limit these values).
typedef double LARGE_DECIMAL_OUT
 A lua decimal number (negative, zero or positive) (range 2.2250738585072014e-308 to 1.7976931348623158e+308, lua may limit these values).
typedef LuaPlus::LuaStackObject POINT_IN
 A lua object representing a 2D point as X,Y components.
typedef LuaPlus::LuaObject POINT_OUT
 A lua object representing a 2D point as X,Y components.
typedef LuaPlus::LuaStackObject VECTOR_IN
 A lua object representing a 3D vector as X,Y,Z components.
typedef LuaPlus::LuaObject VECTOR_OUT
 A lua object representing a 3D vector as X,Y,Z components.
typedef LuaPlus::LuaStackObject RECTANGLE_IN
 A lua object representing a 2D rectangle with X1,Y1 (top-left) and X1,Y2 (bottom-right) components.
typedef LuaPlus::LuaObject RECTANGLE_OUT
 A lua object representing a 2D rectangle with X1,Y1 (top-left) and X1,Y2 (bottom-right) components.
typedef LuaPlus::LuaStackObject COLOR_IN
 A lua object representing a color with Red,Green,Blue,Alpha components.
typedef LuaPlus::LuaObject COLOR_OUT
 A lua object representing a color with Red,Green,Blue,Alpha components.
typedef LuaPlus::LuaObject TABLE_IN
 A lua table.
typedef LuaPlus::LuaObject TABLE_OUT
 A lua table.
typedef LuaPlus::LuaObject LINE_IN
 A lua table consisting of two points, formatted as 3D vectors: line['start'] and line['end'].
typedef LuaPlus::LuaObject LINE_OUT
 A lua table consisting of two points, formatted as 3D vectors: line['start'] and line['end'].
typedef LuaPlus::LuaObject BBOX_IN
 A lua table consisting of two points, formatted as 3D vectors: box['min'] and box['max'] Passed in to ScriptENGINE interface functions.
typedef LuaPlus::LuaObject BBOX_OUT
 A lua table consisting of two points, formatted as 3D vectors: box['min'] and box['max'] Returned from ScriptENGINE interface functions.
typedef unsigned int SUBSCRIBER_IN
 A number representing a subscriber identifier from the IEvents interface.
typedef unsigned int SUBSCRIBER_OUT
 A number representing a subscriber identifier from the IEvents interface.


Typedef Documentation

true, false, or nil.

Passed in to ScriptENGINE interface functions.

true or false.

Returned from ScriptENGINE interface functions.

A lua integer without decimals (negative, zero or positive) (range 0 to 255).

Passed in to ScriptENGINE interface functions.

A lua integer without decimals (negative, zero or positive) (range 0 to 255).

Returned from ScriptENGINE interface functions.

A lua object representing a color with Red,Green,Blue,Alpha components.

The CColorScript class defines the public color functions. You can also use a Lua string representing a color in the format 'RED GREEN BLUE ALPHA'. The Red/Green/Blue components control the color, and the Alpha component controls the opacity. Color components can either be in the range (0 - 1 decimals) or (0 - 255 integers). Passed in to ScriptENGINE interface functions.

Note:
eg. Red at 100% opacity = '1 0 0 1' or '255 0 0 255'

eg. Green at 50% opacity = '0 1 0 0.5' or '0 255 0 127'

eg. White at 100% opacity = '1 1 1 1' or '255 255 255 255'

A lua object representing a color with Red,Green,Blue,Alpha components.

The CColorScript class defines the public color functions. You can also use a Lua string representing a color in the format 'RED GREEN BLUE ALPHA'. The Red/Green/Blue components control the color, and the Alpha component controls the opacity. Color components can either be in the range (0 - 1 decimals) or (0 - 255 integers). Returned from ScriptENGINE interface functions.

Note:
eg. Red at 100% opacity = '1 0 0 1' or '255 0 0 255'

eg. Green at 50% opacity = '0 1 0 0.5' or '0 255 0 127'

eg. White at 100% opacity = '1 1 1 1' or '255 255 255 255'

A lua decimal number (negative, zero or positive) (range 1.175494351e-38F to 3.402823466e+38F, lua may limit these values).

Passed in to ScriptENGINE interface functions.

A lua decimal number (negative, zero or positive) (range 1.175494351e-38F to 3.402823466e+38F, lua may limit these values).

Returned from ScriptENGINE interface functions.

A NON-UNICODE lua string representing an entity identifier.

Passed in to ScriptENGINE interface functions.

A NON-UNICODE lua string or nil representing an entity identifier.

Returned from ScriptENGINE interface functions.

A UNICODE lua string or nil representing a GUI control identifier.

Passed in to ScriptENGINE interface functions.

A UNICODE lua string or nil representing a GUI control identifier.

Returned from ScriptENGINE interface functions.

A lua integer without decimals (negative, zero or positive) (range –2147483647 to 2147483647, lua may limit these values).

Passed in to ScriptENGINE interface functions.

A lua integer without decimals (negative, zero or positive) (range –2147483647 to 2147483647, lua may limit these values).

Returned from ScriptENGINE interface functions.

A lua decimal number (negative, zero or positive) (range 2.2250738585072014e-308 to 1.7976931348623158e+308, lua may limit these values).

Passed in to ScriptENGINE interface functions.

A lua decimal number (negative, zero or positive) (range 2.2250738585072014e-308 to 1.7976931348623158e+308, lua may limit these values).

Returned from ScriptENGINE interface functions.

A lua integer without decimals (negative, zero or positive) (range –2147483647 to 2147483647, lua may limit these values).

Passed in to ScriptENGINE interface functions.

A lua integer without decimals (negative, zero or positive) (range –2147483647 to 2147483647, lua may limit these values).

Returned from ScriptENGINE interface functions.

A lua table consisting of two points, formatted as 3D vectors: line['start'] and line['end'].

Passed in to ScriptENGINE interface functions.

A lua table consisting of two points, formatted as 3D vectors: line['start'] and line['end'].

Returned from ScriptENGINE interface functions.

Any lua object.

Passed in to ScriptENGINE interface functions.

Any lua object.

Returned from ScriptENGINE interface functions.

A lua object representing a 2D point as X,Y components.

The CPointScript class defines the public point functions. You can also use a Lua string representing a point in the format 'X Y'. 2D points support many Lua operators (eg +-*), and are automatically converted to strings (if required). Passed in to ScriptENGINE interface functions.

A lua object representing a 2D point as X,Y components.

The CPointScript class defines the public point functions. Returned from ScriptENGINE interface functions.

A lua object representing a 2D rectangle with X1,Y1 (top-left) and X1,Y2 (bottom-right) components.

The CRectScript class defines the public color functions. You can also use a Lua string representing a rectangle in the format 'X1 Y1 X2 Y2'. 'X1 Y1' represents the top-left corner. 'X2 Y2' represents the bottom-right corner. Passed in to ScriptENGINE interface functions.

A lua object representing a 2D rectangle with X1,Y1 (top-left) and X1,Y2 (bottom-right) components.

The CRectScript class defines the public color functions. Returned from ScriptENGINE interface functions.

A lua integer without decimals (negative, zero or positive) (range –32768 to 32767).

Passed in to ScriptENGINE interface functions.

A lua integer without decimals (negative, zero or positive) (range –32768 to 32767).

Returned from ScriptENGINE interface functions.

A NON-UNICODE lua string.

Passed in to ScriptENGINE interface functions.

A NON-UNICODE lua string or nil.

Returned from ScriptENGINE interface functions.

A UNICODE compatible lua string.

Passed in to ScriptENGINE interface functions.

A UNICODE compatible lua string or nil.

Returned from ScriptENGINE interface functions.

A number representing a subscriber identifier from the IEvents interface.

Returned from ScriptENGINE interface functions.

A number representing a subscriber identifier from the IEvents interface.

Returned from ScriptENGINE interface functions.

A lua table.

Passed in to ScriptENGINE interface functions.

A lua table.

Returned from ScriptENGINE interface functions.

An unsigned integer without decimals (zero or positive) (range 0 to 65535).

Passed in to ScriptENGINE interface functions.

An unsigned integer without decimals (zero or positive) (range 0 to 65535).

Returned from ScriptENGINE interface functions.

A lua object representing a 3D vector as X,Y,Z components.

The CVectorScript class defines the public vector functions. You can also use a Lua string representing a vector in the format 'X Y Z'. 3D vectors support many Lua operators (eg +-*), and are automatically converted to strings (if required). Passed in to ScriptENGINE interface functions.

A lua object representing a 3D vector as X,Y,Z components.

The CVectorScript class defines the public vector functions. Returned from ScriptENGINE interface functions.

Copyright © 2006-23 Sep 2009 Capricorn 76 Pty. Ltd. (created on Wed Sep 23 16:49:13 2009)