src/content_sao.cpp

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010-2011 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 General Public License as published by
   7 the Free Software Foundation; either version 2 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 General Public License for more details.
  14
  15 You should have received a copy of the GNU 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 #include "content_sao.h"
  21 #include "collision.h"
  22 #include "environment.h"
  23 #include "settings.h"
  24 #include "main.h" // For g_profiler
  25 #include "profiler.h"
  26 #include "serialization.h" // For compressZlib
  27 #include "tool.h" // For ToolCapabilities
  28 #include "gamedef.h"
  29
  30 core::map<u16, ServerActiveObject::Factory> ServerActiveObject::m_types;
  31
  32 /*
  33         DummyLoadSAO
  34 */
  35
  36 class DummyLoadSAO : public ServerActiveObject
  37 {
  38 public:
  39         DummyLoadSAO(ServerEnvironment *env, v3f pos, u8 type):
  40                 ServerActiveObject(env, pos)
  41         {
  42                 ServerActiveObject::registerType(type, create);
  43         }
  44         // Pretend to be the test object (to fool the client)
  45         u8 getType() const
  46         { return ACTIVEOBJECT_TYPE_TEST; }
  47         // And never save to disk
  48         bool isStaticAllowed() const
  49         { return false; }
  50
  51         static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
  52                         const std::string &data)
  53         {
  54                 return new DummyLoadSAO(env, pos, 0);
  55         }
  56
  57         void step(float dtime, bool send_recommended)
  58         {
  59                 m_removed = true;
  60                 infostream<<"DummyLoadSAO step"<<std::endl;
  61         }
  62
  63 private:
  64 };
  65
  66 // Prototype (registers item for deserialization)
  67 DummyLoadSAO proto1_DummyLoadSAO(NULL, v3f(0,0,0), ACTIVEOBJECT_TYPE_RAT);
  68 DummyLoadSAO proto2_DummyLoadSAO(NULL, v3f(0,0,0), ACTIVEOBJECT_TYPE_OERKKI1);
  69 DummyLoadSAO proto3_DummyLoadSAO(NULL, v3f(0,0,0), ACTIVEOBJECT_TYPE_FIREFLY);
  70 DummyLoadSAO proto4_DummyLoadSAO(NULL, v3f(0,0,0), ACTIVEOBJECT_TYPE_MOBV2);
  71
  72 /*
  73         TestSAO
  74 */
  75
  76 class TestSAO : public ServerActiveObject
  77 {
  78 public:
  79         TestSAO(ServerEnvironment *env, v3f pos):
  80                 ServerActiveObject(env, pos),
  81                 m_timer1(0),
  82                 m_age(0)
  83         {
  84                 ServerActiveObject::registerType(getType(), create);
  85         }
  86         u8 getType() const
  87         { return ACTIVEOBJECT_TYPE_TEST; }
  88
  89         static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
  90                         const std::string &data)
  91         {
  92                 return new TestSAO(env, pos);
  93         }
  94
  95         void step(float dtime, bool send_recommended)
  96         {
  97                 m_age += dtime;
  98                 if(m_age > 10)
  99                 {
 100                         m_removed = true;
 101                         return;
 102                 }
 103
 104                 m_base_position.Y += dtime * BS * 2;
 105                 if(m_base_position.Y > 8*BS)
 106                         m_base_position.Y = 2*BS;
 107
 108                 if(send_recommended == false)
 109                         return;
 110
 111                 m_timer1 -= dtime;
 112                 if(m_timer1 < 0.0)
 113                 {
 114                         m_timer1 += 0.125;
 115
 116                         std::string data;
 117
 118                         data += itos(0); // 0 = position
 119                         data += " ";
 120                         data += itos(m_base_position.X);
 121                         data += " ";
 122                         data += itos(m_base_position.Y);
 123                         data += " ";
 124                         data += itos(m_base_position.Z);
 125
 126                         ActiveObjectMessage aom(getId(), false, data);
 127                         m_messages_out.push_back(aom);
 128                 }
 129         }
 130
 131 private:
 132         float m_timer1;
 133         float m_age;
 134 };
 135
 136 // Prototype (registers item for deserialization)
 137 TestSAO proto_TestSAO(NULL, v3f(0,0,0));
 138
 139 /*
 140         ItemSAO
 141 */
 142
 143 class ItemSAO : public ServerActiveObject
 144 {
 145 public:
 146         u8 getType() const
 147         { return ACTIVEOBJECT_TYPE_ITEM; }
 148
 149         float getMinimumSavedMovement()
 150         { return 0.1*BS; }
 151
 152         static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
 153                         const std::string &data)
 154         {
 155                 std::istringstream is(data, std::ios::binary);
 156                 char buf[1];
 157                 // read version
 158                 is.read(buf, 1);
 159                 u8 version = buf[0];
 160                 // check if version is supported
 161                 if(version != 0)
 162                         return NULL;
 163                 std::string itemstring = deSerializeString(is);
 164                 infostream<<"create(): Creating item \""
 165                                 <<itemstring<<"\""<<std::endl;
 166                 return new ItemSAO(env, pos, itemstring);
 167         }
 168
 169         ItemSAO(ServerEnvironment *env, v3f pos,
 170                         const std::string itemstring):
 171                 ServerActiveObject(env, pos),
 172                 m_itemstring(itemstring),
 173                 m_itemstring_changed(false),
 174                 m_speed_f(0,0,0),
 175                 m_last_sent_position(0,0,0)
 176         {
 177                 ServerActiveObject::registerType(getType(), create);
 178         }
 179
 180         void step(float dtime, bool send_recommended)
 181         {
 182                 ScopeProfiler sp2(g_profiler, "step avg", SPT_AVG);
 183
 184                 assert(m_env);
 185
 186                 const float interval = 0.2;
 187                 if(m_move_interval.step(dtime, interval)==false)
 188                         return;
 189                 dtime = interval;
 190
 191                 core::aabbox3d<f32> box(-BS/3.,0.0,-BS/3., BS/3.,BS*2./3.,BS/3.);
 192                 collisionMoveResult moveresult;
 193                 // Apply gravity
 194                 m_speed_f += v3f(0, -dtime*9.81*BS, 0);
 195                 // Maximum movement without glitches
 196                 f32 pos_max_d = BS*0.25;
 197                 // Limit speed
 198                 if(m_speed_f.getLength()*dtime > pos_max_d)
 199                         m_speed_f *= pos_max_d / (m_speed_f.getLength()*dtime);
 200                 v3f pos_f = getBasePosition();
 201                 v3f pos_f_old = pos_f;
 202                 IGameDef *gamedef = m_env->getGameDef();
 203                 moveresult = collisionMoveSimple(&m_env->getMap(), gamedef,
 204                                 pos_max_d, box, dtime, pos_f, m_speed_f);
 205
 206                 if(send_recommended == false)
 207                         return;
 208
 209                 if(pos_f.getDistanceFrom(m_last_sent_position) > 0.05*BS)
 210                 {
 211                         setBasePosition(pos_f);
 212                         m_last_sent_position = pos_f;
 213
 214                         std::ostringstream os(std::ios::binary);
 215                         // command (0 = update position)
 216                         writeU8(os, 0);
 217                         // pos
 218                         writeV3F1000(os, m_base_position);
 219                         // create message and add to list
 220                         ActiveObjectMessage aom(getId(), false, os.str());
 221                         m_messages_out.push_back(aom);
 222                 }
 223                 if(m_itemstring_changed)
 224                 {
 225                         m_itemstring_changed = false;
 226
 227                         std::ostringstream os(std::ios::binary);
 228                         // command (1 = update itemstring)
 229                         writeU8(os, 1);
 230                         // itemstring
 231                         os<<serializeString(m_itemstring);
 232                         // create message and add to list
 233                         ActiveObjectMessage aom(getId(), false, os.str());
 234                         m_messages_out.push_back(aom);
 235                 }
 236         }
 237
 238         std::string getClientInitializationData()
 239         {
 240                 std::ostringstream os(std::ios::binary);
 241                 // version
 242                 writeU8(os, 0);
 243                 // pos
 244                 writeV3F1000(os, m_base_position);
 245                 // itemstring
 246                 os<<serializeString(m_itemstring);
 247                 return os.str();
 248         }
 249
 250         std::string getStaticData()
 251         {
 252                 infostream<<__FUNCTION_NAME<<std::endl;
 253                 std::ostringstream os(std::ios::binary);
 254                 // version
 255                 writeU8(os, 0);
 256                 // itemstring
 257                 os<<serializeString(m_itemstring);
 258                 return os.str();
 259         }
 260
 261         ItemStack createItemStack()
 262         {
 263                 try{
 264                         IItemDefManager *idef = m_env->getGameDef()->idef();
 265                         ItemStack item;
 266                         item.deSerialize(m_itemstring, idef);
 267                         infostream<<__FUNCTION_NAME<<": m_itemstring=\""<<m_itemstring
 268                                         <<"\" -> item=\""<<item.getItemString()<<"\""
 269                                         <<std::endl;
 270                         return item;
 271                 }
 272                 catch(SerializationError &e)
 273                 {
 274                         infostream<<__FUNCTION_NAME<<": serialization error: "
 275                                         <<"m_itemstring=\""<<m_itemstring<<"\""<<std::endl;
 276                         return ItemStack();
 277                 }
 278         }
 279
 280         int punch(v3f dir,
 281                         const ToolCapabilities *toolcap,
 282                         ServerActiveObject *puncher,
 283                         float time_from_last_punch)
 284         {
 285                 // Directly delete item in creative mode
 286                 if(g_settings->getBool("creative_mode") == true)
 287                 {
 288                         m_removed = true;
 289                         return 0;
 290                 }
 291
 292                 // Take item into inventory
 293                 ItemStack item = createItemStack();
 294                 Inventory *inv = puncher->getInventory();
 295                 if(inv != NULL)
 296                 {
 297                         std::string wieldlist = puncher->getWieldList();
 298                         ItemStack leftover = inv->addItem(wieldlist, item);
 299                         puncher->setInventoryModified();
 300                         if(leftover.empty())
 301                         {
 302                                 m_removed = true;
 303                         }
 304                         else
 305                         {
 306                                 m_itemstring = leftover.getItemString();
 307                                 m_itemstring_changed = true;
 308                         }
 309                 }
 310
 311                 return 0;
 312         }
 313
 314
 315 private:
 316         std::string m_itemstring;
 317         bool m_itemstring_changed;
 318         v3f m_speed_f;
 319         v3f m_last_sent_position;
 320         IntervalLimiter m_move_interval;
 321 };
 322
 323 // Prototype (registers item for deserialization)
 324 ItemSAO proto_ItemSAO(NULL, v3f(0,0,0), "");
 325
 326 ServerActiveObject* createItemSAO(ServerEnvironment *env, v3f pos,
 327                 const std::string itemstring)
 328 {
 329         return new ItemSAO(env, pos, itemstring);
 330 }
 331
 332 /*
 333         LuaEntitySAO
 334 */
 335
 336 #include "scriptapi.h"
 337 #include "luaentity_common.h"
 338
 339 // Prototype (registers item for deserialization)
 340 LuaEntitySAO proto_LuaEntitySAO(NULL, v3f(0,0,0), "_prototype", "");
 341
 342 LuaEntitySAO::LuaEntitySAO(ServerEnvironment *env, v3f pos,
 343                 const std::string &name, const std::string &state):
 344         ServerActiveObject(env, pos),
 345         m_init_name(name),
 346         m_init_state(state),
 347         m_registered(false),
 348         m_prop(new LuaEntityProperties),
 349         m_hp(-1),
 350         m_velocity(0,0,0),
 351         m_acceleration(0,0,0),
 352         m_yaw(0),
 353         m_last_sent_yaw(0),
 354         m_last_sent_position(0,0,0),
 355         m_last_sent_velocity(0,0,0),
 356         m_last_sent_position_timer(0),
 357         m_last_sent_move_precision(0)
 358 {
 359         // Only register type if no environment supplied
 360         if(env == NULL){
 361                 ServerActiveObject::registerType(getType(), create);
 362                 return;
 363         }
 364
 365         // Initialize something to armor groups
 366         m_armor_groups["fleshy"] = 3;
 367         m_armor_groups["snappy"] = 2;
 368 }
 369
 370 LuaEntitySAO::~LuaEntitySAO()
 371 {
 372         if(m_registered){
 373                 lua_State *L = m_env->getLua();
 374                 scriptapi_luaentity_rm(L, m_id);
 375         }
 376         delete m_prop;
 377 }
 378
 379 void LuaEntitySAO::addedToEnvironment()
 380 {
 381         ServerActiveObject::addedToEnvironment();
 382
 383         // Create entity from name and state
 384         lua_State *L = m_env->getLua();
 385         m_registered = scriptapi_luaentity_add(L, m_id, m_init_name.c_str(),
 386                         m_init_state.c_str());
 387
 388         if(m_registered){
 389                 // Get properties
 390                 scriptapi_luaentity_get_properties(L, m_id, m_prop);
 391         }
 392 }
 393
 394 ServerActiveObject* LuaEntitySAO::create(ServerEnvironment *env, v3f pos,
 395                 const std::string &data)
 396 {
 397         std::istringstream is(data, std::ios::binary);
 398         // read version
 399         u8 version = readU8(is);
 400         std::string name;
 401         std::string state;
 402         s16 hp = 1;
 403         v3f velocity;
 404         float yaw = 0;
 405         // check if version is supported
 406         if(version == 0){
 407                 name = deSerializeString(is);
 408                 state = deSerializeLongString(is);
 409         }
 410         else if(version == 1){
 411                 name = deSerializeString(is);
 412                 state = deSerializeLongString(is);
 413                 hp = readS16(is);
 414                 velocity = readV3F1000(is);
 415                 yaw = readF1000(is);
 416         }
 417         else{
 418                 return NULL;
 419         }
 420         // create object
 421         infostream<<"LuaEntitySAO::create(name=\""<<name<<"\" state=\""
 422                         <<state<<"\")"<<std::endl;
 423         LuaEntitySAO *sao = new LuaEntitySAO(env, pos, name, state);
 424         sao->m_hp = hp;
 425         sao->m_velocity = velocity;
 426         sao->m_yaw = yaw;
 427         return sao;
 428 }
 429
 430 void LuaEntitySAO::step(float dtime, bool send_recommended)
 431 {
 432         m_last_sent_position_timer += dtime;
 433
 434         if(m_prop->physical){
 435                 core::aabbox3d<f32> box = m_prop->collisionbox;
 436                 box.MinEdge *= BS;
 437                 box.MaxEdge *= BS;
 438                 collisionMoveResult moveresult;
 439                 f32 pos_max_d = BS*0.25; // Distance per iteration
 440                 v3f p_pos = getBasePosition();
 441                 v3f p_velocity = m_velocity;
 442                 IGameDef *gamedef = m_env->getGameDef();
 443                 moveresult = collisionMovePrecise(&m_env->getMap(), gamedef,
 444                                 pos_max_d, box, dtime, p_pos, p_velocity);
 445                 // Apply results
 446                 setBasePosition(p_pos);
 447                 m_velocity = p_velocity;
 448
 449                 m_velocity += dtime * m_acceleration;
 450         } else {
 451                 m_base_position += dtime * m_velocity + 0.5 * dtime
 452                                 * dtime * m_acceleration;
 453                 m_velocity += dtime * m_acceleration;
 454         }
 455
 456         if(m_registered){
 457                 lua_State *L = m_env->getLua();
 458                 scriptapi_luaentity_step(L, m_id, dtime);
 459         }
 460
 461         if(send_recommended == false)
 462                 return;
 463
 464         // TODO: force send when acceleration changes enough?
 465         float minchange = 0.2*BS;
 466         if(m_last_sent_position_timer > 1.0){
 467                 minchange = 0.01*BS;
 468         } else if(m_last_sent_position_timer > 0.2){
 469                 minchange = 0.05*BS;
 470         }
 471         float move_d = m_base_position.getDistanceFrom(m_last_sent_position);
 472         move_d += m_last_sent_move_precision;
 473         float vel_d = m_velocity.getDistanceFrom(m_last_sent_velocity);
 474         if(move_d > minchange || vel_d > minchange ||
 475                         fabs(m_yaw - m_last_sent_yaw) > 1.0){
 476                 sendPosition(true, false);
 477         }
 478 }
 479
 480 std::string LuaEntitySAO::getClientInitializationData()
 481 {
 482         std::ostringstream os(std::ios::binary);
 483         // version
 484         writeU8(os, 1);
 485         // pos
 486         writeV3F1000(os, m_base_position);
 487         // yaw
 488         writeF1000(os, m_yaw);
 489         // hp
 490         writeS16(os, m_hp);
 491         // properties
 492         std::ostringstream prop_os(std::ios::binary);
 493         m_prop->serialize(prop_os);
 494         os<<serializeLongString(prop_os.str());
 495         // return result
 496         return os.str();
 497 }
 498
 499 std::string LuaEntitySAO::getStaticData()
 500 {
 501         infostream<<__FUNCTION_NAME<<std::endl;
 502         std::ostringstream os(std::ios::binary);
 503         // version
 504         writeU8(os, 1);
 505         // name
 506         os<<serializeString(m_init_name);
 507         // state
 508         if(m_registered){
 509                 lua_State *L = m_env->getLua();
 510                 std::string state = scriptapi_luaentity_get_staticdata(L, m_id);
 511                 os<<serializeLongString(state);
 512         } else {
 513                 os<<serializeLongString(m_init_state);
 514         }
 515         // hp
 516         writeS16(os, m_hp);
 517         // velocity
 518         writeV3F1000(os, m_velocity);
 519         // yaw
 520         writeF1000(os, m_yaw);
 521         return os.str();
 522 }
 523
 524 int LuaEntitySAO::punch(v3f dir,
 525                 const ToolCapabilities *toolcap,
 526                 ServerActiveObject *puncher,
 527                 float time_from_last_punch)
 528 {
 529         if(!m_registered){
 530                 // Delete unknown LuaEntities when punched
 531                 m_removed = true;
 532                 return 0;
 533         }
 534         lua_State *L = m_env->getLua();
 535         scriptapi_luaentity_punch(L, m_id, puncher,
 536                         time_from_last_punch, toolcap, dir);
 537
 538         HitParams hitparams = getHitParams(m_armor_groups, toolcap,
 539                         time_from_last_punch);
 540
 541         actionstream<<getDescription()<<" punched by "
 542                         <<puncher->getDescription()<<", damage "<<hitparams.hp
 543                         <<" HP"<<std::endl;
 544
 545         setHP(getHP() - hitparams.hp);
 546
 547         {
 548                 std::ostringstream os(std::ios::binary);
 549                 // command
 550                 writeU8(os, LUAENTITY_CMD_PUNCHED);
 551                 // damage
 552                 writeS16(os, hitparams.hp);
 553                 // result_hp
 554                 writeS16(os, getHP());
 555                 // create message and add to list
 556                 ActiveObjectMessage aom(getId(), true, os.str());
 557                 m_messages_out.push_back(aom);
 558         }
 559
 560         return hitparams.wear;
 561 }
 562
 563 void LuaEntitySAO::rightClick(ServerActiveObject *clicker)
 564 {
 565         if(!m_registered)
 566                 return;
 567         lua_State *L = m_env->getLua();
 568         scriptapi_luaentity_rightclick(L, m_id, clicker);
 569 }
 570
 571 void LuaEntitySAO::setHP(s16 hp)
 572 {
 573         if(hp < 0) hp = 0;
 574         m_hp = hp;
 575 }
 576
 577 s16 LuaEntitySAO::getHP()
 578 {
 579         return m_hp;
 580 }
 581
 582 void LuaEntitySAO::setPos(v3f pos)
 583 {
 584         m_base_position = pos;
 585         sendPosition(false, true);
 586 }
 587
 588 void LuaEntitySAO::moveTo(v3f pos, bool continuous)
 589 {
 590         m_base_position = pos;
 591         if(!continuous)
 592                 sendPosition(true, true);
 593 }
 594
 595 float LuaEntitySAO::getMinimumSavedMovement()
 596 {
 597         return 0.1 * BS;
 598 }
 599
 600 std::string LuaEntitySAO::getDescription()
 601 {
 602         std::ostringstream os(std::ios::binary);
 603         os<<"LuaEntitySAO at (";
 604         os<<(m_base_position.X/BS)<<",";
 605         os<<(m_base_position.Y/BS)<<",";
 606         os<<(m_base_position.Z/BS);
 607         os<<")";
 608         return std::string("LuaEntitySAO");
 609 }
 610
 611 void LuaEntitySAO::setVelocity(v3f velocity)
 612 {
 613         m_velocity = velocity;
 614 }
 615
 616 v3f LuaEntitySAO::getVelocity()
 617 {
 618         return m_velocity;
 619 }
 620
 621 void LuaEntitySAO::setAcceleration(v3f acceleration)
 622 {
 623         m_acceleration = acceleration;
 624 }
 625
 626 v3f LuaEntitySAO::getAcceleration()
 627 {
 628         return m_acceleration;
 629 }
 630
 631 void LuaEntitySAO::setYaw(float yaw)
 632 {
 633         m_yaw = yaw;
 634 }
 635
 636 float LuaEntitySAO::getYaw()
 637 {
 638         return m_yaw;
 639 }
 640
 641 void LuaEntitySAO::setTextureMod(const std::string &mod)
 642 {
 643         std::ostringstream os(std::ios::binary);
 644         // command
 645         writeU8(os, LUAENTITY_CMD_SET_TEXTURE_MOD);
 646         // parameters
 647         os<<serializeString(mod);
 648         // create message and add to list
 649         ActiveObjectMessage aom(getId(), false, os.str());
 650         m_messages_out.push_back(aom);
 651 }
 652
 653 void LuaEntitySAO::setSprite(v2s16 p, int num_frames, float framelength,
 654                 bool select_horiz_by_yawpitch)
 655 {
 656         std::ostringstream os(std::ios::binary);
 657         // command
 658         writeU8(os, LUAENTITY_CMD_SET_SPRITE);
 659         // parameters
 660         writeV2S16(os, p);
 661         writeU16(os, num_frames);
 662         writeF1000(os, framelength);
 663         writeU8(os, select_horiz_by_yawpitch);
 664         // create message and add to list
 665         ActiveObjectMessage aom(getId(), false, os.str());
 666         m_messages_out.push_back(aom);
 667 }
 668
 669 std::string LuaEntitySAO::getName()
 670 {
 671         return m_init_name;
 672 }
 673
 674 void LuaEntitySAO::sendPosition(bool do_interpolate, bool is_movement_end)
 675 {
 676         m_last_sent_move_precision = m_base_position.getDistanceFrom(
 677                         m_last_sent_position);
 678         m_last_sent_position_timer = 0;
 679         m_last_sent_yaw = m_yaw;
 680         m_last_sent_position = m_base_position;
 681         m_last_sent_velocity = m_velocity;
 682         //m_last_sent_acceleration = m_acceleration;
 683
 684         float update_interval = m_env->getSendRecommendedInterval();
 685
 686         std::ostringstream os(std::ios::binary);
 687         // command
 688         writeU8(os, LUAENTITY_CMD_UPDATE_POSITION);
 689
 690         // do_interpolate
 691         writeU8(os, do_interpolate);
 692         // pos
 693         writeV3F1000(os, m_base_position);
 694         // velocity
 695         writeV3F1000(os, m_velocity);
 696         // acceleration
 697         writeV3F1000(os, m_acceleration);
 698         // yaw
 699         writeF1000(os, m_yaw);
 700         // is_end_position (for interpolation)
 701         writeU8(os, is_movement_end);
 702         // update_interval (for interpolation)
 703         writeF1000(os, update_interval);
 704
 705         // create message and add to list
 706         ActiveObjectMessage aom(getId(), false, os.str());
 707         m_messages_out.push_back(aom);
 708 }
 709