Add static_save property to luaentites to not save them statically. (#5112)
[oweals/minetest.git] / src / object_properties.cpp
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 #include "object_properties.h"
21 #include "irrlichttypes_bloated.h"
22 #include "exceptions.h"
23 #include "util/serialize.h"
24 #include "util/basic_macros.h"
25 #include <sstream>
26
27 ObjectProperties::ObjectProperties()
28 {
29         textures.emplace_back("unknown_object.png");
30         colors.emplace_back(255,255,255,255);
31 }
32
33 std::string ObjectProperties::dump()
34 {
35         std::ostringstream os(std::ios::binary);
36         os << "hp_max=" << hp_max;
37         os << ", breath_max=" << breath_max;
38         os << ", physical=" << physical;
39         os << ", collideWithObjects=" << collideWithObjects;
40         os << ", weight=" << weight;
41         os << ", collisionbox=" << PP(collisionbox.MinEdge) << "," << PP(collisionbox.MaxEdge);
42         os << ", visual=" << visual;
43         os << ", mesh=" << mesh;
44         os << ", visual_size=" << PP2(visual_size);
45         os << ", textures=[";
46         for (const std::string &texture : textures) {
47                 os << "\"" << texture << "\" ";
48         }
49         os << "]";
50         os << ", colors=[";
51         for (const video::SColor &color : colors) {
52                 os << "\"" << color.getAlpha() << "," << color.getRed() << ","
53                         << color.getGreen() << "," << color.getBlue() << "\" ";
54         }
55         os << "]";
56         os << ", spritediv=" << PP2(spritediv);
57         os << ", initial_sprite_basepos=" << PP2(initial_sprite_basepos);
58         os << ", is_visible=" << is_visible;
59         os << ", makes_footstep_sound=" << makes_footstep_sound;
60         os << ", automatic_rotate="<< automatic_rotate;
61         os << ", backface_culling="<< backface_culling;
62         os << ", glow=" << glow;
63         os << ", nametag=" << nametag;
64         os << ", nametag_color=" << "\"" << nametag_color.getAlpha() << "," << nametag_color.getRed()
65                         << "," << nametag_color.getGreen() << "," << nametag_color.getBlue() << "\" ";
66         os << ", selectionbox=" << PP(selectionbox.MinEdge) << "," << PP(selectionbox.MaxEdge);
67         os << ", pointable=" << pointable;
68         os << ", can_zoom=" << can_zoom;
69         os << ", static_save=" << static_save;
70         return os.str();
71 }
72
73 void ObjectProperties::serialize(std::ostream &os) const
74 {
75         writeU8(os, 2); // version, protocol_version >= 36
76         writeS16(os, hp_max);
77         writeU8(os, physical);
78         writeF1000(os, weight);
79         writeV3F1000(os, collisionbox.MinEdge);
80         writeV3F1000(os, collisionbox.MaxEdge);
81         writeV3F1000(os, selectionbox.MinEdge);
82         writeV3F1000(os, selectionbox.MaxEdge);
83         writeU8(os, pointable);
84         os << serializeString(visual);
85         writeV2F1000(os, visual_size);
86         writeU16(os, textures.size());
87         for (const std::string &texture : textures) {
88                 os << serializeString(texture);
89         }
90         writeV2S16(os, spritediv);
91         writeV2S16(os, initial_sprite_basepos);
92         writeU8(os, is_visible);
93         writeU8(os, makes_footstep_sound);
94         writeF1000(os, automatic_rotate);
95         // Added in protocol version 14
96         os << serializeString(mesh);
97         writeU16(os, colors.size());
98         for (video::SColor color : colors) {
99                 writeARGB8(os, color);
100         }
101         writeU8(os, collideWithObjects);
102         writeF1000(os,stepheight);
103         writeU8(os, automatic_face_movement_dir);
104         writeF1000(os, automatic_face_movement_dir_offset);
105         writeU8(os, backface_culling);
106         os << serializeString(nametag);
107         writeARGB8(os, nametag_color);
108         writeF1000(os, automatic_face_movement_max_rotation_per_sec);
109         os << serializeString(infotext);
110         os << serializeString(wield_item);
111         writeU8(os, can_zoom);
112         writeS8(os, glow);
113         writeU16(os, breath_max);
114
115         // Add stuff only at the bottom.
116         // Never remove anything, because we don't want new versions of this
117 }
118
119 void ObjectProperties::deSerialize(std::istream &is)
120 {
121         int version = readU8(is);
122         if (version != 2)
123                 throw SerializationError("unsupported ObjectProperties version");
124
125         hp_max = readS16(is);
126         physical = readU8(is);
127         weight = readF1000(is);
128         collisionbox.MinEdge = readV3F1000(is);
129         collisionbox.MaxEdge = readV3F1000(is);
130         selectionbox.MinEdge = readV3F1000(is);
131         selectionbox.MaxEdge = readV3F1000(is);
132         pointable = readU8(is);
133         visual = deSerializeString(is);
134         visual_size = readV2F1000(is);
135         textures.clear();
136         u32 texture_count = readU16(is);
137         for (u32 i = 0; i < texture_count; i++){
138                 textures.push_back(deSerializeString(is));
139         }
140         spritediv = readV2S16(is);
141         initial_sprite_basepos = readV2S16(is);
142         is_visible = readU8(is);
143         makes_footstep_sound = readU8(is);
144         automatic_rotate = readF1000(is);
145         mesh = deSerializeString(is);
146         u32 color_count = readU16(is);
147         for (u32 i = 0; i < color_count; i++){
148                 colors.push_back(readARGB8(is));
149         }
150         collideWithObjects = readU8(is);
151         stepheight = readF1000(is);
152         automatic_face_movement_dir = readU8(is);
153         automatic_face_movement_dir_offset = readF1000(is);
154         backface_culling = readU8(is);
155         nametag = deSerializeString(is);
156         nametag_color = readARGB8(is);
157         automatic_face_movement_max_rotation_per_sec = readF1000(is);
158         infotext = deSerializeString(is);
159         wield_item = deSerializeString(is);
160         can_zoom = readU8(is);
161
162         try {
163                 glow = readS8(is);
164                 breath_max = readU16(is);
165         } catch (SerializationError &e) {}
166 }