Reference

CL_LuaValue(3)

Lua value

NAME

CL_LuaValue - Lua value

DESCRIPTION

Represents a value that can be passed to Lua. When calling Lua functions or indexing Lua tables, objects of this class are expected. However, they are implicitly constructed from C++ primitive types. Thus, in general, there is no need to directly create objects of this class. * Copying from LuaObject To convert a LuaValue from a LuaObject is _not_ allowed.

CLASS MEMBERS

CL_LuaValue(
void)

CL_LuaValue(
int v)

CL_LuaValue(
float v)

CL_LuaValue(
double v)

CL_LuaValue(
char* v)

CL_LuaValue(
const CL_LuaValue& v)

CL_LuaValue(
lua_CFunction v)

CL_LuaValue(
void* v,
int tag=LUA_PP_USERDATA)

CL_LuaValue(
const void* v,
int tag=LUA_PP_USERDATA)

CL_LuaValue(
const CL_LuaValue& v)

CL_LuaValue& operator= (
const CL_LuaValue& v)

virtual ~CL_LuaValue(
void)

virtual void push(
void)

void store(
char* varname)

virtual int isNil(
void)

virtual int isNumber(
void)

virtual int isString(
void)

virtual int isTable(
void)

virtual int isFunction(
void)

virtual int isUserData(
void)

virtual int type(
void)

virtual operator float()
virtual operator const char*()
virtual operator const char*()
virtual operator const void*()
virtual operator const void*()

MEMBERS WITH DESCRIPTIONS

CL_LuaValue(
void)

Description:

Create a nil object

CL_LuaValue(
int v)

Description:

Create a number from an int

CL_LuaValue(
float v)

Description:

Create a number from a float

CL_LuaValue(
double v)

Description:

Create a number from a double

CL_LuaValue(
char* v)

Description:

Create a string from a char*

CL_LuaValue(
const CL_LuaValue& v)

Description:

Create a string from a const char*Copy and assignment not implemented * Assigning a LuaObject Assigning a LuaObject is _not_ allowed.

CL_LuaValue(
lua_CFunction v)

Description:

Create a cfunction from a 'lua_CFunction}

CL_LuaValue(
void* v,
int tag=LUA_PP_USERDATA)

Description:

Create a userdata from a void*

CL_LuaValue(
const void* v,
int tag=LUA_PP_USERDATA)

Description:

Create a userdata from a const void*

CL_LuaValue(
const CL_LuaValue& v)

Description:

Create a string from a const char*Copy and assignment not implemented * Assigning a LuaObject Assigning a LuaObject is _not_ allowed.

CL_LuaValue& operator= (
const CL_LuaValue& v)

Description:

not implemented

virtual ~CL_LuaValue(
void)

Description:

* MANIPULATORS

virtual void push(
void)

Description:

Push Pushs the value onto Lua stack.

void store(
char* varname)

Description:

Store Stores the value in a given Lua global variable. * ACCESSORS

virtual int isNil(
void)

Description:

Query if nil

virtual int isNumber(
void)

Description:

Query if number

virtual int isString(
void)

Description:

Query if string

virtual int isTable(
void)

Description:

Query if table never happens

virtual int isFunction(
void)

Description:

Query if function

virtual int isUserData(
void)

Description:

Query if userdata

virtual int type(
void)

Description:

Return the corresponding Lua type * CONVERSORS Allow conversion to C++ primitive types.

virtual operator float()
Description:

Convert to float

virtual operator const char*()
Description:

Convert to {char*}Convert to {const char*}

virtual operator const char*()
Description:

Convert to {char*}Convert to {const char*}

virtual operator const void*()
Description:

Convert to {void*} Convert to {const void*}

virtual operator const void*()
Description:

Convert to {void*} Convert to {const void*}

SEE ALSO

All ClanLib API classes can be found in clanlib (3).

AUTHORS

Originally written by Magnus Norddahl <[email protected]> and Martin Starch <[email protected]>. ClanLib is now developed by the ClanLib Development team as an Open Source project.

The ClanLib man pages was created using the Perceps documentation system (another excellent piece of Open Source software, available at http://somewhere.in.the.world.org).

See clanlib (3) to find out how to get a full list of contributors and details on how to submit bug reports, comments etc.