lua_api.hpp File Reference

#include <cstddef>
#include <string>
#include "lua_types.hpp"
#include "units/ptr.hpp"

Include dependency graph for lua_api.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	lua_unit
	Storage for a unit, either owned by the Lua code (ptr != 0), a local variable unit (c_ptr != 0), on a recall list (side != 0), or on the map. More...

Functions
unit *	luaW_tounit (lua_State *L, int index, bool only_on_map=false)
	Converts a Lua value to a unit pointer. More...
void	chat_message (std::string const &caption, std::string const &msg)
	Displays a message in the chat window. More...
bool	luaW_pcall (lua_State *L, int nArgs, int nRets, bool allow_wml_error=false)
	Calls a Lua function stored below its nArgs arguments at the top of the stack. More...
unit &	luaW_checkunit (lua_State *L, int index, bool only_on_map=false)
	Converts a Lua value to a unit pointer. More...
lua_unit *	luaW_pushlocalunit (lua_State *L, unit &u)
unit_ptr	luaW_tounit_ptr (lua_State *L, int index, bool only_on_map)
	Similar to luaW_checkunit/luaW_tounit but returns a unit_ptr, use this instead of luaW_checkunit/luaW_tounit when uasing an api that needs unit_ptr. More...
unit_ptr	luaW_checkunit_ptr (lua_State *L, int index, bool only_on_map)

Function Documentation

void chat_message	(	std::string const &	caption,
		std::string const &	msg
	)

Displays a message in the chat window.

Definition at line 48 of file lua_api.cpp.

References display_chat_manager::add_chat_message(), game_display::get_chat_manager(), events::chat_handler::MESSAGE_PUBLIC, and resources::screen.

Referenced by display_chat_manager::add_chat_message(), chat_log::add_message(), and luaW_pcall().

unit& luaW_checkunit	(	lua_State *	L,
		int	index,
		bool	only_on_map = false
	)

Converts a Lua value to a unit pointer.

Definition at line 205 of file lua_api.cpp.

References luaL_typerror(), and luaW_tounit().

Referenced by game_lua_kernel::cfun_builtin_effect(), impl_unit_equality(), intf_add_modification(), intf_advance_unit(), intf_copy_unit(), game_lua_kernel::intf_find_path(), game_lua_kernel::intf_find_reach(), game_lua_kernel::intf_simulate_combat(), intf_transform_unit(), intf_unit_ability(), intf_unit_defense(), intf_unit_jamming_cost(), intf_unit_movement_cost(), intf_unit_resistance(), and intf_unit_vision_cost().

unit_ptr luaW_checkunit_ptr	(	lua_State *	L,
		int	index,
		bool	only_on_map
	)

Definition at line 199 of file lua_api.cpp.

References luaL_typerror(), and luaW_tounit().

Referenced by game_lua_kernel::intf_teleport().

bool luaW_pcall	(	lua_State *	L,
		int	nArgs,
		int	nRets,
		bool	allow_wml_error = false
	)

Calls a Lua function stored below its nArgs arguments at the top of the stack.

Parameters

nRets

LUA_MULTRET for unbounded return values.

Returns

true if the call was successful and nRets return values are available.

Definition at line 59 of file lua_api.cpp.

References chat_message(), e, ERR_LUA, executeKey, lua_gettop(), lua_insert(), lua_pcall, lua_pop, lua_pushlightuserdata(), lua_rawget(), LUA_REGISTRYINDEX, lua_remove(), lua_tostring, tlua_jailbreak_exception::rethrow(), and lg::wml_error().

Referenced by game_lua_kernel::apply_effect(), ai::call_lua_filter_fcn(), lua_pathfind_cost_calculator::cost(), ai::lua_ai_action_handler::handle(), intf_do_unsynced(), game_lua_kernel::load_game(), game_lua_kernel::mouse_over_hex_callback(), game_lua_kernel::run_event(), game_lua_kernel::run_filter(), game_lua_kernel::run_wml_action(), game_lua_kernel::run_wml_conditional(), game_lua_kernel::save_game(), game_lua_kernel::select_hex_callback(), and ai::lua_ai_context::update_state().

lua_unit* luaW_pushlocalunit	(	lua_State *	L,
		unit &	u
	)

Definition at line 212 of file lua_api.cpp.

References getunitKey, lua_newuserdata(), lua_pushlightuserdata(), lua_rawget(), LUA_REGISTRYINDEX, and lua_setmetatable().

Referenced by game_lua_kernel::apply_effect().

unit* luaW_tounit	(	lua_State *	L,
		int	index,
		bool	only_on_map = false
	)

Converts a Lua value to a unit pointer.

Definition at line 183 of file lua_api.cpp.

References lua_unit::get(), getunitKey, lua_touserdata(), luaW_hasmetatable(), and lua_unit::on_map().

Referenced by ai::cfun_ai_get_suitable_keep(), impl_unit_attack_get(), impl_unit_attack_set(), impl_unit_attacks_get(), impl_unit_attacks_len(), impl_unit_status_get(), impl_unit_status_set(), impl_unit_variables_get(), impl_unit_variables_set(), lua_formula_bridge::intf_eval_formula(), game_lua_kernel::intf_find_cost_map(), luaW_checkunit(), luaW_checkunit_ptr(), luaW_tofaivariant(), and luaW_tolocation().

unit_ptr luaW_tounit_ptr	(	lua_State *	L,
		int	index,
		bool	only_on_map
	)

Similar to luaW_checkunit/luaW_tounit but returns a unit_ptr, use this instead of luaW_checkunit/luaW_tounit when uasing an api that needs unit_ptr.

Definition at line 191 of file lua_api.cpp.

References lua_unit::get_shared(), getunitKey, lua_touserdata(), luaW_hasmetatable(), and lua_unit::on_map().