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 #pragma once
  21
  22 #include "lua_api/l_base.h"
  23 #include "irrlichttypes.h"
  24
  25 class ServerActiveObject;
  26 class LuaEntitySAO;
  27 class PlayerSAO;
  28 class RemotePlayer;
  29
  30 /*
  31         ObjectRef
  32 */
  33
  34 class ObjectRef : public ModApiBase {
  35 public:
  36         ObjectRef(ServerActiveObject *object);
  37
  38         ~ObjectRef() = default;
  39
  40         // Creates an ObjectRef and leaves it on top of stack
  41         // Not callable from Lua; all references are created on the C side.
  42         static void create(lua_State *L, ServerActiveObject *object);
  43
  44         static void set_null(lua_State *L);
  45
  46         static void Register(lua_State *L);
  47
  48         static ObjectRef *checkobject(lua_State *L, int narg);
  49
  50         static ServerActiveObject* getobject(ObjectRef *ref);
  51 private:
  52         ServerActiveObject *m_object = nullptr;
  53
  54         static const char className[];
  55         static const luaL_Reg methods[];
  56
  57
  58         static LuaEntitySAO* getluaobject(ObjectRef *ref);
  59
  60         static PlayerSAO* getplayersao(ObjectRef *ref);
  61
  62         static RemotePlayer *getplayer(ObjectRef *ref);
  63
  64         // Exported functions
  65
  66         // garbage collector
  67         static int gc_object(lua_State *L);
  68
  69         // remove(self)
  70         static int l_remove(lua_State *L);
  71
  72         // get_pos(self)
  73         // returns: {x=num, y=num, z=num}
  74         static int l_get_pos(lua_State *L);
  75
  76         // set_pos(self, pos)
  77         static int l_set_pos(lua_State *L);
  78
  79         // move_to(self, pos, continuous=false)
  80         static int l_move_to(lua_State *L);
  81
  82         // punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
  83         static int l_punch(lua_State *L);
  84
  85         // right_click(self, clicker); clicker = an another ObjectRef
  86         static int l_right_click(lua_State *L);
  87
  88         // set_hp(self, hp)
  89         // hp = number of hitpoints (2 * number of hearts)
  90         // returns: nil
  91         static int l_set_hp(lua_State *L);
  92
  93         // get_hp(self)
  94         // returns: number of hitpoints (2 * number of hearts)
  95         // 0 if not applicable to this type of object
  96         static int l_get_hp(lua_State *L);
  97
  98         // get_inventory(self)
  99         static int l_get_inventory(lua_State *L);
 100
 101         // get_wield_list(self)
 102         static int l_get_wield_list(lua_State *L);
 103
 104         // get_wield_index(self)
 105         static int l_get_wield_index(lua_State *L);
 106
 107         // get_wielded_item(self)
 108         static int l_get_wielded_item(lua_State *L);
 109
 110         // set_wielded_item(self, itemstack or itemstring or table or nil)
 111         static int l_set_wielded_item(lua_State *L);
 112
 113         // set_armor_groups(self, groups)
 114         static int l_set_armor_groups(lua_State *L);
 115
 116         // get_armor_groups(self)
 117         static int l_get_armor_groups(lua_State *L);
 118
 119         // set_physics_override(self, physics_override_speed, physics_override_jump,
 120         //                      physics_override_gravity, sneak, sneak_glitch, new_move)
 121         static int l_set_physics_override(lua_State *L);
 122
 123         // get_physics_override(self)
 124         static int l_get_physics_override(lua_State *L);
 125
 126         // set_animation(self, frame_range, frame_speed, frame_blend, frame_loop)
 127         static int l_set_animation(lua_State *L);
 128
 129         // set_animation_frame_speed(self, frame_speed)
 130         static int l_set_animation_frame_speed(lua_State *L);
 131
 132         // get_animation(self)
 133         static int l_get_animation(lua_State *L);
 134
 135         // set_bone_position(self, std::string bone, v3f position, v3f rotation)
 136         static int l_set_bone_position(lua_State *L);
 137
 138         // get_bone_position(self, bone)
 139         static int l_get_bone_position(lua_State *L);
 140
 141         // set_attach(self, parent, bone, position, rotation)
 142         static int l_set_attach(lua_State *L);
 143
 144         // get_attach(self)
 145         static int l_get_attach(lua_State *L);
 146
 147         // set_detach(self)
 148         static int l_set_detach(lua_State *L);
 149
 150         // set_properties(self, properties)
 151         static int l_set_properties(lua_State *L);
 152
 153         // get_properties(self)
 154         static int l_get_properties(lua_State *L);
 155
 156         // is_player(self)
 157         static int l_is_player(lua_State *L);
 158
 159         /* LuaEntitySAO-only */
 160
 161         // set_velocity(self, {x=num, y=num, z=num})
 162         static int l_set_velocity(lua_State *L);
 163
 164         // get_velocity(self)
 165         static int l_get_velocity(lua_State *L);
 166
 167         // set_acceleration(self, {x=num, y=num, z=num})
 168         static int l_set_acceleration(lua_State *L);
 169
 170         // get_acceleration(self)
 171         static int l_get_acceleration(lua_State *L);
 172
 173         // set_yaw(self, radians)
 174         static int l_set_yaw(lua_State *L);
 175
 176         // get_yaw(self)
 177         static int l_get_yaw(lua_State *L);
 178
 179         // set_texture_mod(self, mod)
 180         static int l_set_texture_mod(lua_State *L);
 181
 182         // l_get_texture_mod(self)
 183         static int l_get_texture_mod(lua_State *L);
 184
 185         // set_sprite(self, p={x=0,y=0}, num_frames=1, framelength=0.2,
 186         //           select_horiz_by_yawpitch=false)
 187         static int l_set_sprite(lua_State *L);
 188
 189         // DEPRECATED
 190         // get_entity_name(self)
 191         static int l_get_entity_name(lua_State *L);
 192
 193         // get_luaentity(self)
 194         static int l_get_luaentity(lua_State *L);
 195
 196         /* Player-only */
 197
 198         // is_player_connected(self)
 199         static int l_is_player_connected(lua_State *L);
 200
 201         // get_player_name(self)
 202         static int l_get_player_name(lua_State *L);
 203
 204         // get_player_velocity(self)
 205         static int l_get_player_velocity(lua_State *L);
 206
 207         // get_look_dir(self)
 208         static int l_get_look_dir(lua_State *L);
 209
 210         // DEPRECATED
 211         // get_look_pitch(self)
 212         static int l_get_look_pitch(lua_State *L);
 213
 214         // DEPRECATED
 215         // get_look_yaw(self)
 216         static int l_get_look_yaw(lua_State *L);
 217
 218         // get_look_pitch2(self)
 219         static int l_get_look_vertical(lua_State *L);
 220
 221         // get_look_yaw2(self)
 222         static int l_get_look_horizontal(lua_State *L);
 223
 224         // set_look_vertical(self, radians)
 225         static int l_set_look_vertical(lua_State *L);
 226
 227         // set_look_horizontal(self, radians)
 228         static int l_set_look_horizontal(lua_State *L);
 229
 230         // DEPRECATED
 231         // set_look_pitch(self, radians)
 232         static int l_set_look_pitch(lua_State *L);
 233
 234         // DEPRECATED
 235         // set_look_yaw(self, radians)
 236         static int l_set_look_yaw(lua_State *L);
 237
 238         // set_breath(self, breath)
 239         static int l_set_breath(lua_State *L);
 240
 241         // get_breath(self, breath)
 242         static int l_get_breath(lua_State *L);
 243
 244         // set_attribute(self, attribute, value)
 245         static int l_set_attribute(lua_State *L);
 246
 247         // get_attribute(self, attribute)
 248         static int l_get_attribute(lua_State *L);
 249
 250         // set_inventory_formspec(self, formspec)
 251         static int l_set_inventory_formspec(lua_State *L);
 252
 253         // get_inventory_formspec(self) -> formspec
 254         static int l_get_inventory_formspec(lua_State *L);
 255
 256         // get_player_control(self)
 257         static int l_get_player_control(lua_State *L);
 258
 259         // get_player_control_bits(self)
 260         static int l_get_player_control_bits(lua_State *L);
 261
 262         // hud_add(self, id, form)
 263         static int l_hud_add(lua_State *L);
 264
 265         // hud_rm(self, id)
 266         static int l_hud_remove(lua_State *L);
 267
 268         // hud_change(self, id, stat, data)
 269         static int l_hud_change(lua_State *L);
 270
 271         // hud_get_next_id(self)
 272         static u32 hud_get_next_id(lua_State *L);
 273
 274         // hud_get(self, id)
 275         static int l_hud_get(lua_State *L);
 276
 277         // hud_set_flags(self, flags)
 278         static int l_hud_set_flags(lua_State *L);
 279
 280         // hud_get_flags()
 281         static int l_hud_get_flags(lua_State *L);
 282
 283         // hud_set_hotbar_itemcount(self, hotbar_itemcount)
 284         static int l_hud_set_hotbar_itemcount(lua_State *L);
 285
 286         // hud_get_hotbar_itemcount(self)
 287         static int l_hud_get_hotbar_itemcount(lua_State *L);
 288
 289         // hud_set_hotbar_image(self, name)
 290         static int l_hud_set_hotbar_image(lua_State *L);
 291
 292         // hud_get_hotbar_image(self)
 293         static int l_hud_get_hotbar_image(lua_State *L);
 294
 295         // hud_set_hotbar_selected_image(self, name)
 296         static int l_hud_set_hotbar_selected_image(lua_State *L);
 297
 298         // hud_get_hotbar_selected_image(self)
 299         static int l_hud_get_hotbar_selected_image(lua_State *L);
 300
 301         // set_sky(self, bgcolor, type, list, clouds = true)
 302         static int l_set_sky(lua_State *L);
 303
 304         // get_sky(self)
 305         static int l_get_sky(lua_State *L);
 306
 307         // set_clouds(self, {density=, color=, ambient=, height=, thickness=, speed=})
 308         static int l_set_clouds(lua_State *L);
 309
 310         // get_clouds(self)
 311         static int l_get_clouds(lua_State *L);
 312
 313         // override_day_night_ratio(self, type)
 314         static int l_override_day_night_ratio(lua_State *L);
 315
 316         // get_day_night_ratio(self)
 317         static int l_get_day_night_ratio(lua_State *L);
 318
 319         // set_local_animation(self, {stand/idle}, {walk}, {dig}, {walk+dig}, frame_speed)
 320         static int l_set_local_animation(lua_State *L);
 321
 322         // get_local_animation(self)
 323         static int l_get_local_animation(lua_State *L);
 324
 325         // set_eye_offset(self, v3f first pv, v3f third pv)
 326         static int l_set_eye_offset(lua_State *L);
 327
 328         // get_eye_offset(self)
 329         static int l_get_eye_offset(lua_State *L);
 330
 331         // set_nametag_attributes(self, attributes)
 332         static int l_set_nametag_attributes(lua_State *L);
 333
 334         // get_nametag_attributes(self)
 335         static int l_get_nametag_attributes(lua_State *L);
 336
 337 };