src/activeobject.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-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 "irr_aabb3d.h"
  23 #include "irr_v3d.h"
  24 #include <string>
  25
  26
  27 enum ActiveObjectType {
  28         ACTIVEOBJECT_TYPE_INVALID = 0,
  29         ACTIVEOBJECT_TYPE_TEST = 1,
  30 // Obsolete stuff
  31         ACTIVEOBJECT_TYPE_ITEM = 2,
  32 //      ACTIVEOBJECT_TYPE_RAT = 3,
  33 //      ACTIVEOBJECT_TYPE_OERKKI1 = 4,
  34 //      ACTIVEOBJECT_TYPE_FIREFLY = 5,
  35         ACTIVEOBJECT_TYPE_MOBV2 = 6,
  36 // End obsolete stuff
  37         ACTIVEOBJECT_TYPE_LUAENTITY = 7,
  38 // Special type, not stored as a static object
  39         ACTIVEOBJECT_TYPE_PLAYER = 100,
  40 // Special type, only exists as CAO
  41         ACTIVEOBJECT_TYPE_GENERIC = 101,
  42 };
  43 // Other types are defined in content_object.h
  44
  45 struct ActiveObjectMessage
  46 {
  47         ActiveObjectMessage(u16 id_, bool reliable_=true, const std::string &data_ = "") :
  48                 id(id_),
  49                 reliable(reliable_),
  50                 datastring(data_)
  51         {}
  52
  53         u16 id;
  54         bool reliable;
  55         std::string datastring;
  56 };
  57
  58 enum ActiveObjectCommand {
  59         AO_CMD_SET_PROPERTIES,
  60         AO_CMD_UPDATE_POSITION,
  61         AO_CMD_SET_TEXTURE_MOD,
  62         AO_CMD_SET_SPRITE,
  63         AO_CMD_PUNCHED,
  64         AO_CMD_UPDATE_ARMOR_GROUPS,
  65         AO_CMD_SET_ANIMATION,
  66         AO_CMD_SET_BONE_POSITION,
  67         AO_CMD_ATTACH_TO,
  68         AO_CMD_SET_PHYSICS_OVERRIDE,
  69         AO_CMD_OBSOLETE1,
  70         // ^ UPDATE_NAMETAG_ATTRIBUTES deprecated since 0.4.14, removed in 5.3.0
  71         AO_CMD_SPAWN_INFANT,
  72         AO_CMD_SET_ANIMATION_SPEED
  73 };
  74
  75 /*
  76         Parent class for ServerActiveObject and ClientActiveObject
  77 */
  78 class ActiveObject
  79 {
  80 public:
  81         ActiveObject(u16 id):
  82                 m_id(id)
  83         {
  84         }
  85
  86         u16 getId() const
  87         {
  88                 return m_id;
  89         }
  90
  91         void setId(u16 id)
  92         {
  93                 m_id = id;
  94         }
  95
  96         virtual ActiveObjectType getType() const = 0;
  97
  98
  99         /*!
 100          * Returns the collision box of the object.
 101          * This box is translated by the object's
 102          * location.
 103          * The box's coordinates are world coordinates.
 104          * @returns true if the object has a collision box.
 105          */
 106         virtual bool getCollisionBox(aabb3f *toset) const = 0;
 107
 108
 109         /*!
 110          * Returns the selection box of the object.
 111          * This box is not translated when the
 112          * object moves.
 113          * The box's coordinates are world coordinates.
 114          * @returns true if the object has a selection box.
 115          */
 116         virtual bool getSelectionBox(aabb3f *toset) const = 0;
 117
 118
 119         virtual bool collideWithObjects() const = 0;
 120
 121
 122         virtual void setAttachment(int parent_id, const std::string &bone, v3f position,
 123                         v3f rotation) {}
 124         virtual void getAttachment(int *parent_id, std::string *bone, v3f *position,
 125                         v3f *rotation) const {}
 126         virtual void clearChildAttachments() {}
 127         virtual void clearParentAttachment() {}
 128         virtual void addAttachmentChild(int child_id) {}
 129         virtual void removeAttachmentChild(int child_id) {}
 130 protected:
 131         u16 m_id; // 0 is invalid, "no id"
 132 };