LuaCamera Class Reference

#include <l_camera.h>

Inheritance diagram for LuaCamera:

Collaboration diagram for LuaCamera:

Public Member Functions
	LuaCamera (Camera *m)
	~LuaCamera ()=default

Static Public Member Functions
static void	create (lua_State *L, Camera *m)
static void	Register (lua_State *L)
Static Public Member Functions inherited from ModApiBase
static ScriptApiBase *	getScriptApiBase (lua_State *L)
static Server *	getServer (lua_State *L)
static ServerInventoryManager *	getServerInventoryMgr (lua_State *L)
static EmergeThread *	getEmergeThread (lua_State *L)
static IGameDef *	getGameDef (lua_State *L)
static Environment *	getEnv (lua_State *L)
static std::string	getCurrentModPath (lua_State *L)
template<typename T>
static T *	getScriptApi (lua_State *L)
static bool	registerFunction (lua_State *L, const char *name, lua_CFunction func, int top)
template<typename T>
static void	registerClass (lua_State *L, const luaL_Reg *methods, const luaL_Reg *metamethods)
template<typename T>
static T *	checkObject (lua_State *L, int narg)
static int	l_deprecated_function (lua_State *L, const char *good, const char *bad, lua_CFunction func)
	A wrapper for deprecated functions.

Static Public Attributes
static const char	className [] = "Camera"

Static Private Member Functions
static int	gc_object (lua_State *L)
static int	l_set_camera_mode (lua_State *L)
static int	l_get_camera_mode (lua_State *L)
static int	l_get_fov (lua_State *L)
static int	l_get_pos (lua_State *L)
static int	l_get_offset (lua_State *L)
static int	l_get_look_dir (lua_State *L)
static int	l_get_look_vertical (lua_State *L)
static int	l_get_look_horizontal (lua_State *L)
static int	l_get_aspect_ratio (lua_State *L)
static Camera *	getobject (LuaCamera *ref)
static Camera *	getobject (lua_State *L, int narg)

Private Attributes
Camera *	m_camera = nullptr

Static Private Attributes
static const luaL_Reg	methods []

Additional Inherited Members
Protected Member Functions inherited from LuaHelper
template<>
bool	readParam (lua_State *L, int index)
template<>
s16	readParam (lua_State *L, int index)
template<>
int	readParam (lua_State *L, int index)
template<>
float	readParam (lua_State *L, int index)
template<>
v2s16	readParam (lua_State *L, int index)
template<>
v2f	readParam (lua_State *L, int index)
template<>
v3f	readParam (lua_State *L, int index)
template<>
std::string_view	readParam (lua_State *L, int index)
template<>
std::string	readParam (lua_State *L, int index)
template<>
std::string_view	readParam (lua_State *L, int index)
	Read a string from Lua state L at index without copying it.
Static Protected Member Functions inherited from LuaHelper
template<typename T>
static T	readParam (lua_State *L, int index)
	Read a value using a template type T from Lua state L at index.
template<typename T>
static T	readParam (lua_State *L, int index, const T &default_value)
	Read a value using a template type T from Lua state L at index.
static bool	geti (lua_State *L, int table, int i)
	Utility for list iteration.
template<typename F>
static void	for_ipairs (lua_State *L, int table, const F &f)
	Iterate values t[1], t[2], ... of the given table in order.

Constructor & Destructor Documentation

LuaCamera()

LuaCamera::LuaCamera

(

Camera *

m

)

References m_camera.

Referenced by create(), gc_object(), getobject(), and getobject().

Here is the caller graph for this function:

~LuaCamera()

LuaCamera::~LuaCamera ( )

default

Member Function Documentation

create()

void LuaCamera::create ( lua_State * L, Camera * m )

static

References LuaCamera(), and className.

Referenced by ClientScripting::on_camera_ready().

Here is the call graph for this function:

Here is the caller graph for this function:

gc_object()

int LuaCamera::gc_object ( lua_State * L )

staticprivate

References LuaCamera().

Referenced by Register().

Here is the call graph for this function:

Here is the caller graph for this function:

getobject() [1/2]

Camera * LuaCamera::getobject ( lua_State * L, int narg )

staticprivate

References LuaCamera(), ModApiBase::checkObject(), and getobject().

Here is the call graph for this function:

getobject() [2/2]

Camera * LuaCamera::getobject ( LuaCamera * ref )

staticprivate

References LuaCamera(), and m_camera.

Referenced by getobject(), l_get_aspect_ratio(), l_get_camera_mode(), l_get_fov(), l_get_look_dir(), l_get_pos(), and l_set_camera_mode().

Here is the call graph for this function:

Here is the caller graph for this function:

l_get_aspect_ratio()

int LuaCamera::l_get_aspect_ratio ( lua_State * L )

staticprivate

References Camera::getCameraNode(), and getobject().

Here is the call graph for this function:

l_get_camera_mode()

int LuaCamera::l_get_camera_mode ( lua_State * L )

staticprivate

References Camera::getCameraMode(), and getobject().

Here is the call graph for this function:

l_get_fov()

int LuaCamera::l_get_fov ( lua_State * L )

staticprivate

References Camera::getCameraNode(), Camera::getFovMax(), Camera::getFovX(), Camera::getFovY(), and getobject().

Here is the call graph for this function:

l_get_look_dir()

int LuaCamera::l_get_look_dir ( lua_State * L )

staticprivate

References Camera::getDirection(), getobject(), and push_v3f().

Here is the call graph for this function:

l_get_look_horizontal()

int LuaCamera::l_get_look_horizontal ( lua_State * L )

staticprivate

References LocalPlayer::getYaw(), and sanity_check.

Here is the call graph for this function:

l_get_look_vertical()

int LuaCamera::l_get_look_vertical ( lua_State * L )

staticprivate

References LocalPlayer::getPitch(), and sanity_check.

Here is the call graph for this function:

l_get_offset()

int LuaCamera::l_get_offset ( lua_State * L )

staticprivate

References BS, LocalPlayer::getEyeOffset(), push_v3f(), and sanity_check.

Here is the call graph for this function:

l_get_pos()

int LuaCamera::l_get_pos ( lua_State * L )

staticprivate

References BS, getobject(), Camera::getPosition(), and push_v3f().

Here is the call graph for this function:

l_set_camera_mode()

int LuaCamera::l_set_camera_mode ( lua_State * L )

staticprivate

References CAMERA_MODE_FIRST, Camera::getCameraMode(), getobject(), sanity_check, Camera::setCameraMode(), GenericCAO::setChildrenVisible(), and GenericCAO::updateMeshCulling().

Here is the call graph for this function:

Register()

void LuaCamera::Register ( lua_State * L )

static

References gc_object(), methods, and ModApiBase::registerClass().

Referenced by ClientScripting::InitializeModApi().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

className

const char LuaCamera::className = "Camera"

static

Referenced by create().

m_camera

Camera* LuaCamera::m_camera = nullptr

private

Referenced by LuaCamera(), and getobject().

methods

const luaL_Reg LuaCamera::methods

staticprivate

Initial value:

                                  = {
        luamethod(LuaCamera, set_camera_mode),
        luamethod(LuaCamera, get_camera_mode),
        luamethod(LuaCamera, get_fov),
        luamethod(LuaCamera, get_pos),
        luamethod(LuaCamera, get_offset),
        luamethod(LuaCamera, get_look_dir),
        luamethod(LuaCamera, get_look_vertical),
        luamethod(LuaCamera, get_look_horizontal),
        luamethod(LuaCamera, get_aspect_ratio),
 
        {0, 0}
}

Referenced by Register().

---

The documentation for this class was generated from the following files:

• script/lua_api/l_camera.h
• script/lua_api/l_camera.cpp