lua_team.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2014 - 2025
    by Chris Beck <render787@gmail.com>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#pragma once
 
class team;
struct lua_State;
 
#include <string>
 
/**
 * This namespace contains bindings for lua to hold a pointer to a team,
 * and to access and modify it.
 */
namespace lua_team {
    std::string register_metatable(lua_State *);
} //end namespace lua_team
 
/** Create a full userdata containing a pointer to the team. */
void luaW_pushteam(lua_State *, team &);
 
/** Test if the top stack element is a team, and if so, return it */
team* luaW_toteam(lua_State*, int);
 
/** Test if the top stack element is a team, and if not, error */
team& luaW_checkteam(lua_State*, int);
 
/** Get a team either from a direct userdata or from a side number */
team& luaW_checkteam(lua_State* L, int idx, class game_board& board);