User:Monster Iestyn/Source Code Documentation/lua_script.h

From SRB2 Wiki
Jump to navigation Jump to search
This article or section is incomplete. It doesn't have all of the necessary core information on this topic. Please help the SRB2 Wiki by finishing this article.
Online link GitHub entry
File type C header file
#include guard none

Includes

Macros

Macro Defined as Description
lua_optboolean(L, i) 
(!lua_isnoneornil(L, i) && lua_toboolean(L, i))
lua_opttrueboolean(L, i) 
(lua_isnoneornil(L, i) || lua_toboolean(L, i))
luaL_checkfixed(L, i) luaL_checkinteger(L, i)
lua_pushfixed(L, f) lua_pushinteger(L, f)
luaL_checkangle(L, i) ((angle_t)luaL_checkinteger(L, i))
lua_pushangle(L, a) lua_pushinteger(L, a)
LUA_Call(L,a) 
{\
	if (lua_pcall(L, a, 0, 0)) {\
		CONS_Alert(CONS_WARNING,"%s\n",lua_tostring(L,-1));\
		lua_pop(L, 1);\
	}\
}
LUA_ErrInvalid(L, type) 
luaL_error(L, "accessed " type " doesn't exist anymore, please check 'valid' before using " type ".");
LUA_Deprecated(L,this_func,use_instead) 
{\
	static UINT8 seen = 0;\
	if (!seen) {\
		seen = 1;\
		CONS_Alert(CONS_WARNING,"\"%s\" is deprecated and will be removed.\nUse \"%s\" instead.\n", this_func, use_instead);\
	}\
}
LUA_UsageWarning(L, warningmsg) 
{\
	static UINT8 seen = 0;\
	if (!seen) {\
		seen = 1;\
		CONS_Alert(CONS_WARNING,"%s\n", warningmsg);\
	}\
}

Function prototypes

Function name Return type Params Defined in Description
LUA_ClearExtVars void none lua_script.c Declared only if _DEBUG is defined
LUA_LoadLump void UINT16 wad,
UINT16 lump 		lua_script.c
LUA_DumpFile void const char *filename lua_script.c Declared only if LUA_ALLOW_BYTECODE is defined
LUA_EvalMath fixed_t const char *word lua_script.c
LUA_PushUserdata void lua_State *L,
void *data,
const char *meta 		lua_script.c
LUA_InvalidateUserdata void void *data lua_script.c
LUA_InvalidateLevel void none lua_script.c
LUA_InvalidateMapthings void none lua_script.c
LUA_InvalidatePlayer void player_t *player lua_script.c
LUA_Step void none lua_script.c
LUA_Archive void none lua_script.c
LUA_UnArchive void none lua_script.c
Got_Luacmd void UINT8 **cp,
INT32 playernum 		lua_consolelib.c
LUA_CVarChanged void const char *name lua_consolelib.c
Lua_optoption int lua_State *L,
int narg,
const char *def,
const char *const lst[] 		lua_script.c
LUAh_NetArchiveHook void lua_CFunction archFunc lua_hooklib.c
COM_Lua_f void none lua_consolelib.c
Retrieved from "https://wiki.srb2.org/w/index.php?title=User:Monster_Iestyn/Source_Code_Documentation/lua_script.h&oldid=114527"