src/script/lua_api/l_object.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef L_OBJECT_H_
  21 #define L_OBJECT_H_
  22
  23 #include "lua_api/l_base.h"
  24 #include "irrlichttypes.h"
  25
  26 class ServerActiveObject;
  27 class LuaEntitySAO;
  28 class PlayerSAO;
  29 class RemotePlayer;
  30
  31 /*
  32         ObjectRef
  33 */
  34
  35 class ObjectRef : public ModApiBase {
  36 private:
  37         ServerActiveObject *m_object;
  38
  39         static const char className[];
  40         static const luaL_reg methods[];
  41 public:
  42         static ObjectRef *checkobject(lua_State *L, int narg);
  43
  44         static ServerActiveObject* getobject(ObjectRef *ref);
  45 private:
  46         static LuaEntitySAO* getluaobject(ObjectRef *ref);
  47
  48         static PlayerSAO* getplayersao(ObjectRef *ref);
  49
  50         static RemotePlayer* getplayer(ObjectRef *ref);
  51
  52         // Exported functions
  53
  54         // garbage collector
  55         static int gc_object(lua_State *L);
  56
  57         // remove(self)
  58         static int l_remove(lua_State *L);
  59
  60         // getpos(self)
  61         // returns: {x=num, y=num, z=num}
  62         static int l_getpos(lua_State *L);
  63
  64         // setpos(self, pos)
  65         static int l_setpos(lua_State *L);
  66
  67         // moveto(self, pos, continuous=false)
  68         static int l_moveto(lua_State *L);
  69
  70         // punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
  71         static int l_punch(lua_State *L);
  72
  73         // right_click(self, clicker); clicker = an another ObjectRef
  74         static int l_right_click(lua_State *L);
  75
  76         // set_hp(self, hp)
  77         // hp = number of hitpoints (2 * number of hearts)
  78         // returns: nil
  79         static int l_set_hp(lua_State *L);
  80
  81         // get_hp(self)
  82         // returns: number of hitpoints (2 * number of hearts)
  83         // 0 if not applicable to this type of object
  84         static int l_get_hp(lua_State *L);
  85
  86         // get_inventory(self)
  87         static int l_get_inventory(lua_State *L);
  88
  89         // get_wield_list(self)
  90         static int l_get_wield_list(lua_State *L);
  91
  92         // get_wield_index(self)
  93         static int l_get_wield_index(lua_State *L);
  94
  95         // get_wielded_item(self)
  96         static int l_get_wielded_item(lua_State *L);
  97
  98         // set_wielded_item(self, itemstack or itemstring or table or nil)
  99         static int l_set_wielded_item(lua_State *L);
 100
 101         // set_armor_groups(self, groups)
 102         static int l_set_armor_groups(lua_State *L);
 103
 104         // get_armor_groups(self)
 105         static int l_get_armor_groups(lua_State *L);
 106
 107         // set_physics_override(self, physics_override_speed, physics_override_jump,
 108         //                      physics_override_gravity, sneak, sneak_glitch)
 109         static int l_set_physics_override(lua_State *L);
 110
 111         // get_physics_override(self)
 112         static int l_get_physics_override(lua_State *L);
 113
 114         // set_animation(self, frame_range, frame_speed, frame_blend, frame_loop)
 115         static int l_set_animation(lua_State *L);
 116
 117         // get_animation(self)
 118         static int l_get_animation(lua_State *L);
 119
 120         // set_bone_position(self, std::string bone, v3f position, v3f rotation)
 121         static int l_set_bone_position(lua_State *L);
 122
 123         // get_bone_position(self, bone)
 124         static int l_get_bone_position(lua_State *L);
 125
 126         // set_attach(self, parent, bone, position, rotation)
 127         static int l_set_attach(lua_State *L);
 128
 129         // get_attach(self)
 130         static int l_get_attach(lua_State *L);
 131
 132         // set_detach(self)
 133         static int l_set_detach(lua_State *L);
 134
 135         // set_properties(self, properties)
 136         static int l_set_properties(lua_State *L);
 137
 138         // get_properties(self)
 139         static int l_get_properties(lua_State *L);
 140
 141         // is_player(self)
 142         static int l_is_player(lua_State *L);
 143
 144         /* LuaEntitySAO-only */
 145
 146         // setvelocity(self, {x=num, y=num, z=num})
 147         static int l_setvelocity(lua_State *L);
 148
 149         // getvelocity(self)
 150         static int l_getvelocity(lua_State *L);
 151
 152         // setacceleration(self, {x=num, y=num, z=num})
 153         static int l_setacceleration(lua_State *L);
 154
 155         // getacceleration(self)
 156         static int l_getacceleration(lua_State *L);
 157
 158         // setyaw(self, radians)
 159         static int l_setyaw(lua_State *L);
 160
 161         // getyaw(self)
 162         static int l_getyaw(lua_State *L);
 163
 164         // settexturemod(self, mod)
 165         static int l_settexturemod(lua_State *L);
 166
 167         // setsprite(self, p={x=0,y=0}, num_frames=1, framelength=0.2,
 168         //           select_horiz_by_yawpitch=false)
 169         static int l_setsprite(lua_State *L);
 170
 171         // DEPRECATED
 172         // get_entity_name(self)
 173         static int l_get_entity_name(lua_State *L);
 174
 175         // get_luaentity(self)
 176         static int l_get_luaentity(lua_State *L);
 177
 178         /* Player-only */
 179
 180         // is_player_connected(self)
 181         static int l_is_player_connected(lua_State *L);
 182
 183         // get_player_name(self)
 184         static int l_get_player_name(lua_State *L);
 185
 186         // get_player_velocity(self)
 187         static int l_get_player_velocity(lua_State *L);
 188
 189         // get_look_dir(self)
 190         static int l_get_look_dir(lua_State *L);
 191
 192         // DEPRECATED
 193         // get_look_pitch(self)
 194         static int l_get_look_pitch(lua_State *L);
 195
 196         // DEPRECATED
 197         // get_look_yaw(self)
 198         static int l_get_look_yaw(lua_State *L);
 199
 200         // get_look_pitch2(self)
 201         static int l_get_look_vertical(lua_State *L);
 202
 203         // get_look_yaw2(self)
 204         static int l_get_look_horizontal(lua_State *L);
 205
 206         // set_look_vertical(self, radians)
 207         static int l_set_look_vertical(lua_State *L);
 208
 209         // set_look_horizontal(self, radians)
 210         static int l_set_look_horizontal(lua_State *L);
 211
 212         // DEPRECATED
 213         // set_look_pitch(self, radians)
 214         static int l_set_look_pitch(lua_State *L);
 215
 216         // DEPRECATED
 217         // set_look_yaw(self, radians)
 218         static int l_set_look_yaw(lua_State *L);
 219
 220         // set_breath(self, breath)
 221         static int l_set_breath(lua_State *L);
 222
 223         // get_breath(self, breath)
 224         static int l_get_breath(lua_State *L);
 225
 226         // set_inventory_formspec(self, formspec)
 227         static int l_set_inventory_formspec(lua_State *L);
 228
 229         // get_inventory_formspec(self) -> formspec
 230         static int l_get_inventory_formspec(lua_State *L);
 231
 232         // get_player_control(self)
 233         static int l_get_player_control(lua_State *L);
 234
 235         // get_player_control_bits(self)
 236         static int l_get_player_control_bits(lua_State *L);
 237
 238         // hud_add(self, id, form)
 239         static int l_hud_add(lua_State *L);
 240
 241         // hud_rm(self, id)
 242         static int l_hud_remove(lua_State *L);
 243
 244         // hud_change(self, id, stat, data)
 245         static int l_hud_change(lua_State *L);
 246
 247         // hud_get_next_id(self)
 248         static u32 hud_get_next_id(lua_State *L);
 249
 250         // hud_get(self, id)
 251         static int l_hud_get(lua_State *L);
 252
 253         // hud_set_flags(self, flags)
 254         static int l_hud_set_flags(lua_State *L);
 255
 256         // hud_get_flags()
 257         static int l_hud_get_flags(lua_State *L);
 258
 259         // hud_set_hotbar_itemcount(self, hotbar_itemcount)
 260         static int l_hud_set_hotbar_itemcount(lua_State *L);
 261
 262         // hud_get_hotbar_itemcount(self)
 263         static int l_hud_get_hotbar_itemcount(lua_State *L);
 264
 265         // hud_set_hotbar_image(self, name)
 266         static int l_hud_set_hotbar_image(lua_State *L);
 267
 268         // hud_get_hotbar_image(self)
 269         static int l_hud_get_hotbar_image(lua_State *L);
 270
 271         // hud_set_hotbar_selected_image(self, name)
 272         static int l_hud_set_hotbar_selected_image(lua_State *L);
 273
 274         // hud_get_hotbar_selected_image(self)
 275         static int l_hud_get_hotbar_selected_image(lua_State *L);
 276
 277         // set_sky(self, type, list)
 278         static int l_set_sky(lua_State *L);
 279
 280         // get_sky(self, type, list)
 281         static int l_get_sky(lua_State *L);
 282
 283         // override_day_night_ratio(self, type)
 284         static int l_override_day_night_ratio(lua_State *L);
 285
 286         // get_day_night_ratio(self)
 287         static int l_get_day_night_ratio(lua_State *L);
 288
 289         // set_local_animation(self, {stand/idle}, {walk}, {dig}, {walk+dig}, frame_speed)
 290         static int l_set_local_animation(lua_State *L);
 291
 292         // get_local_animation(self)
 293         static int l_get_local_animation(lua_State *L);
 294
 295         // set_eye_offset(self, v3f first pv, v3f third pv)
 296         static int l_set_eye_offset(lua_State *L);
 297
 298         // get_eye_offset(self)
 299         static int l_get_eye_offset(lua_State *L);
 300
 301         // set_nametag_attributes(self, attributes)
 302         static int l_set_nametag_attributes(lua_State *L);
 303
 304         // get_nametag_attributes(self)
 305         static int l_get_nametag_attributes(lua_State *L);
 306
 307 public:
 308         ObjectRef(ServerActiveObject *object);
 309
 310         ~ObjectRef();
 311
 312         // Creates an ObjectRef and leaves it on top of stack
 313         // Not callable from Lua; all references are created on the C side.
 314         static void create(lua_State *L, ServerActiveObject *object);
 315
 316         static void set_null(lua_State *L);
 317
 318         static void Register(lua_State *L);
 319 };
 320
 321 #endif /* L_OBJECT_H_ */