qcsrc/lib/net.qh

   1 #ifndef NET_H
   2 #define NET_H
   3
   4 #ifdef SVQC
   5         .int Version;  // deprecated, use SendFlags
   6         .int SendFlags;
   7         .bool(entity to, int sendflags) SendEntity;
   8         /** return false to remove from the client */
   9         .bool(entity this, entity to, int sendflags) SendEntity3;
  10
  11         bool SendEntity_self(entity to, int sendflags) { return self.SendEntity3(self, to, sendflags); }
  12
  13         void Net_LinkEntity(entity e, bool docull, float dt, bool(entity this, entity to, int sendflags) sendfunc)
  14         {
  15                 if (e.classname == "") e.classname = "net_linked";
  16
  17                 if (e.model == "" || self.modelindex == 0)
  18                 {
  19                         vector mi = e.mins;
  20                         vector ma = e.maxs;
  21                         _setmodel(e, "null");
  22                         setsize(e, mi, ma);
  23                 }
  24
  25                 e.SendEntity = SendEntity_self;
  26                 e.SendEntity3 = sendfunc;
  27                 e.SendFlags = 0xFFFFFF;
  28
  29                 if (!docull) e.effects |= EF_NODEPTHTEST;
  30
  31                 if (dt)
  32                 {
  33                         e.nextthink = time + dt;
  34                         e.think = SUB_Remove_self;
  35                 }
  36         }
  37
  38         void Net_UnlinkEntity(entity e)
  39         {
  40                 e.SendEntity = func_null;
  41         }
  42
  43         .void() uncustomizeentityforclient;
  44         .float uncustomizeentityforclient_set;
  45
  46         void SetCustomizer(entity e, float() customizer, void() uncustomizer)
  47         {
  48                 e.customizeentityforclient = customizer;
  49                 e.uncustomizeentityforclient = uncustomizer;
  50                 e.uncustomizeentityforclient_set = !!uncustomizer;
  51         }
  52
  53         void UncustomizeEntitiesRun()
  54         {
  55                 for (entity e = NULL; (e = findfloat(e, uncustomizeentityforclient_set, 1)); )
  56                         WITH(entity, self, e, e.uncustomizeentityforclient());
  57         }
  58
  59 #endif
  60
  61 #include "registry.qh"
  62 #include "sort.qh"
  63
  64 .string netname;
  65 .int m_id;
  66 .bool(entity this, bool isNew) m_read;
  67
  68 #ifdef CSQC
  69         #define Net_Accept(classname) \
  70                 MACRO_BEGIN \
  71                 { \
  72                         if (!this)    this = new(classname); \
  73                 } MACRO_END
  74         #define Net_Reject() \
  75                 MACRO_BEGIN \
  76                 { \
  77                         if (this)     remove(this); \
  78                 } MACRO_END
  79         #define NET_HANDLE(id, param) \
  80                 bool Net_Handle_##id(entity this, param)
  81 #else
  82         #define WriteHeader(to, id) \
  83                 MACRO_BEGIN \
  84                 { \
  85                         if (NET_##id##_istemp) WriteByte(to, SVC_TEMPENTITY); \
  86                         WriteByte(to, NET_##id.m_id); \
  87                 } MACRO_END
  88 #endif
  89
  90 #ifdef CSQC
  91         #define REGISTER_NET_LINKED(id) \
  92                 [[accumulate]] NET_HANDLE(id, bool isnew) \
  93                 { \
  94                         this = self; \
  95                         this.sourceLocFile = __FILE__; \
  96                         this.sourceLocLine = __LINE__; \
  97                         if (!this) isnew = true; \
  98                 } \
  99                 REGISTER(LinkedEntities, NET, id, m_id, new(net_linked_packet)) \
 100                 { \
 101                         make_pure(this); \
 102                         this.netname = #id; \
 103                         this.m_read = Net_Handle_##id; \
 104                 }
 105 #else
 106         #define REGISTER_NET_LINKED(id) \
 107                 const bool NET_##id##_istemp = false; \
 108                 REGISTER(LinkedEntities, NET, id, m_id, new(net_linked_packet)) \
 109                 { \
 110                         make_pure(this); \
 111                         this.netname = #id; \
 112                 }
 113 #endif
 114
 115 REGISTRY(LinkedEntities, BITS(8) - 1)
 116 #define LinkedEntities_from(i) _LinkedEntities_from(i, NULL)
 117 REGISTER_REGISTRY(LinkedEntities)
 118 REGISTRY_SORT(LinkedEntities)
 119 REGISTRY_CHECK(LinkedEntities)
 120 STATIC_INIT(RegisterLinkedEntities_renumber)
 121 {
 122         for (int i = 0; i < LinkedEntities_COUNT; ++i)
 123                 LinkedEntities_from(i).m_id = 1 + i;
 124 }
 125
 126 #ifdef CSQC
 127         #define REGISTER_NET_TEMP(id) \
 128                 NET_HANDLE(id, bool); \
 129                 REGISTER(TempEntities, NET, id, m_id, new(net_temp_packet)) \
 130                 { \
 131                         make_pure(this); \
 132                         this.netname = #id; \
 133                         this.m_read = Net_Handle_##id; \
 134                 }
 135 #else
 136         #define REGISTER_NET_TEMP(id) \
 137                 const bool NET_##id##_istemp = true; \
 138                 REGISTER(TempEntities, NET, id, m_id, new(net_temp_packet)) \
 139                 { \
 140                         make_pure(this); \
 141                         this.netname = #id; \
 142                 }
 143 #endif
 144
 145 REGISTRY(TempEntities, BITS(8) - 80)
 146 #define TempEntities_from(i) _TempEntities_from(i, NULL)
 147 REGISTER_REGISTRY(TempEntities)
 148 REGISTRY_SORT(TempEntities)
 149 REGISTRY_CHECK(TempEntities)
 150 STATIC_INIT(RegisterTempEntities_renumber)
 151 {
 152         for (int i = 0; i < TempEntities_COUNT; ++i)
 153                 TempEntities_from(i).m_id = 80 + i;
 154 }
 155
 156 #ifndef MENUQC
 157         const float APPROXPASTTIME_ACCURACY_REQUIREMENT = 0.05;
 158         #define APPROXPASTTIME_MAX (16384 * APPROXPASTTIME_ACCURACY_REQUIREMENT)
 159         #define APPROXPASTTIME_RANGE (64 * APPROXPASTTIME_ACCURACY_REQUIREMENT)
 160
 161         #if defined(CSQC)
 162                 #define Read_float() ReadFloat()
 163                 #define Read_int() ReadInt24_t()
 164                 #define Read_string() ReadString()
 165         #elif defined(SVQC)
 166                 #define Write_float(to, f) WriteFloat(to, f)
 167                 #define Write_int(to, f) WriteInt24_t(to, f)
 168                 #define Write_string(to, f) WriteString(to, f)
 169         #endif
 170
 171         #ifdef CSQC
 172         #define ReadRegistry(r) r##_from(ReadByte())
 173
 174                 entity ReadCSQCEntity()
 175                 {
 176                         int f = ReadShort();
 177                         if (f == 0) return world;
 178                         return findfloat(world, entnum, f);
 179                 }
 180                 int ReadInt24_t()
 181                 {
 182                         int v = ReadShort() << 8; // note: this is signed
 183                         v += ReadByte();          // note: this is unsigned
 184                         return v;
 185                 }
 186                 vector ReadInt48_t()
 187                 {
 188                         vector v;
 189                         v.x = ReadInt24_t();
 190                         v.y = ReadInt24_t();
 191                         v.z = 0;
 192                         return v;
 193                 }
 194                 vector ReadInt72_t()
 195                 {
 196                         vector v;
 197                         v.x = ReadInt24_t();
 198                         v.y = ReadInt24_t();
 199                         v.z = ReadInt24_t();
 200                         return v;
 201                 }
 202
 203                 int _ReadSByte;
 204                 #define ReadSByte() (_ReadSByte = ReadByte(), (_ReadSByte & BIT(7) ? -128 : 0) + (_ReadSByte & BITS(7)))
 205                 #define ReadFloat() ReadCoord()
 206         vector ReadVector() { vector v; v.x = ReadFloat(); v.y = ReadFloat(); v.z = ReadFloat(); return v; }
 207                 vector ReadVector2D() { vector v; v.x = ReadFloat(); v.y = ReadFloat(); v.z = 0; return v; }
 208
 209                 float ReadApproxPastTime()
 210                 {
 211                         float dt = ReadByte();
 212
 213                         // map from range...PPROXPASTTIME_MAX / 256
 214                         dt = (APPROXPASTTIME_MAX / 256) * (dt / (256 - dt));
 215
 216                         return servertime - dt;
 217                 }
 218
 219         #else
 220                 const int MSG_ENTITY = 5;
 221
 222                 #define WriteRegistry(r, to, it) WriteByte(to, it.m_id)
 223
 224                 void WriteInt24_t(float dst, float val)
 225                 {
 226                         float v;
 227                         WriteShort(dst, (v = floor(val >> 8)));
 228                         WriteByte(dst, val - (v << 8));  // 0..255
 229                 }
 230                 void WriteInt48_t(float dst, vector val)
 231                 {
 232                         WriteInt24_t(dst, val.x);
 233                         WriteInt24_t(dst, val.y);
 234                 }
 235                 void WriteInt72_t(float dst, vector val)
 236                 {
 237                         WriteInt24_t(dst, val.x);
 238                         WriteInt24_t(dst, val.y);
 239                         WriteInt24_t(dst, val.z);
 240                 }
 241
 242         #define WriteFloat(to, f) WriteCoord(to, f)
 243                 #define WriteVector(to, v) MACRO_BEGIN { WriteFloat(to, v.x); WriteFloat(to, v.y); WriteFloat(to, v.z); } MACRO_END
 244         #define WriteVector2D(to, v) MACRO_BEGIN { WriteFloat(to, v.x); WriteFloat(to, v.y); } MACRO_END
 245
 246                 // this will use the value:
 247                 //   128
 248                 // accuracy near zero is APPROXPASTTIME_MAX/(256*255)
 249                 // accuracy at x is 1/derivative, i.e.
 250                 //   APPROXPASTTIME_MAX * (1 + 256 * (dt / APPROXPASTTIME_MAX))^2 / 65536
 251                 void WriteApproxPastTime(float dst, float t)
 252                 {
 253                         float dt = time - t;
 254
 255                         // warning: this is approximate; do not resend when you don't have to!
 256                         // be careful with sendflags here!
 257                         // we want: 0 -> 0.05, 1 -> 0.1, ..., 255 -> 12.75
 258
 259                         // map to range...
 260                         dt = 256 * (dt / ((APPROXPASTTIME_MAX / 256) + dt));
 261
 262                         // round...
 263                         dt = rint(bound(0, dt, 255));
 264
 265                         WriteByte(dst, dt);
 266                 }
 267
 268                 // allow writing to also pass through to spectators (like so spectators see the same centerprints as players for example)
 269                 #define WRITESPECTATABLE_MSG_ONE_VARNAME(varname, statement) \
 270                         entity varname; varname = msg_entity; \
 271                         FOR_EACH_REALCLIENT(msg_entity) \
 272                         if (msg_entity == varname || (msg_entity.classname == STR_SPECTATOR && msg_entity.enemy == varname)) \
 273                                 statement msg_entity = varname
 274                 #define WRITESPECTATABLE_MSG_ONE(statement) \
 275                         MACRO_BEGIN \
 276                         { \
 277                                 WRITESPECTATABLE_MSG_ONE_VARNAME(oldmsg_entity, statement); \
 278                         } MACRO_END
 279                 #define WRITESPECTATABLE(msg, statement) \
 280                         if (msg == MSG_ONE) WRITESPECTATABLE_MSG_ONE(statement); \
 281                         else \
 282                                 statement float WRITESPECTATABLE_workaround = 0
 283         #endif
 284 #endif
 285
 286 #endif