src/shared/MAPDEF.pas

   1 (* Copyright (C)  DooM 2D:Forever Developers
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 3 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  *)
  16 {$INCLUDE a_modes.inc}
  17 {$M+}
  18 unit MAPDEF;
  19
  20 interface
  21
  22 uses
  23   xdynrec;
  24
  25
  26 const
  27   MAP_SIGNATURE = 'MAP';
  28
  29
  30 const
  31   TEXTURE_NAME_WATER = '_water_0';
  32   TEXTURE_NAME_ACID1 = '_water_1';
  33   TEXTURE_NAME_ACID2 = '_water_2';
  34
  35
  36 type
  37   TDFPoint = packed record
  38   public
  39     X, Y: LongInt;
  40
  41   public
  42     constructor Create (ax, ay: LongInt);
  43   end;
  44
  45   Char16     = packed array[0..15] of Char;
  46   Char32     = packed array[0..31] of Char;
  47   Char64     = packed array[0..63] of Char;
  48   Char100    = packed array[0..99] of Char;
  49   Char256    = packed array[0..255] of Char;
  50   Byte128    = packed array[0..127] of Byte;
  51
  52 {$INCLUDE mapdef.inc}
  53
  54 // various helpers to access map structures
  55 type
  56   TDynRecordHelper = class helper for TDynRecord
  57   private
  58     function getFieldWithType (const aname: AnsiString; atype: TDynField.TType): TDynField; inline;
  59
  60     function getPanelByIdx (idx: Integer): TDynRecord; inline;
  61
  62     function getPanelId (): Integer; inline;
  63     //procedure setPanelId (v: Integer); inline;
  64
  65     function getTexturePanel (): Integer; inline;
  66     //procedure setTexturePanel (v: Integer); inline;
  67
  68     function getPanelIndex (pan: TDynRecord): Integer;
  69
  70     function getPointField (const aname: AnsiString): TDFPoint; inline;
  71
  72   public
  73     function panelCount (): Integer; inline;
  74
  75     // header
  76     function mapName (): AnsiString; inline;
  77     function mapAuthor (): AnsiString; inline;
  78     function mapDesc (): AnsiString; inline;
  79     function musicName (): AnsiString; inline;
  80     function skyName (): AnsiString; inline;
  81
  82     // panel
  83     function X (): Integer; inline;
  84     function Y (): Integer; inline;
  85     function Width (): Word; inline;
  86     function Height (): Word; inline;
  87     function TextureNum (): Word; inline;
  88     function TextureRec (): TDynRecord; inline;
  89     function PanelType (): Word; inline;
  90     function Alpha (): Byte; inline;
  91     function Flags (): Byte; inline;
  92
  93     // texture
  94     function Resource (): AnsiString; inline;
  95     function Anim (): Boolean; inline;
  96
  97     // item
  98     function ItemType (): Byte; inline;
  99     function Options (): Byte; inline;
 100
 101     // monster
 102     function MonsterType (): Byte; inline; // type, ubyte
 103     function Direction (): Byte; inline; // direction, ubyte
 104
 105     // area
 106     function AreaType (): Byte; inline; // type, ubyte
 107     //function Direction (): Byte; inline; // direction, ubyte
 108
 109     // trigger
 110     function trigRec (): TDynRecord; inline;
 111     function Enabled (): Boolean; inline; // enabled, bool
 112     function TriggerType (): Byte; inline; // type, ubyte
 113     function ActivateType (): Byte; inline; // activatetype, ubyte
 114     function Keys (): Byte; inline; // keys, ubyte
 115     //function DATA (): Byte128; inline; // triggerdata, trigdata[128]; // the only special nested structure
 116
 117     {$INCLUDE mapdef_help.inc}
 118     function trigMonsterId (): Integer; inline;
 119
 120   private
 121     // user fields
 122     function getGamePanelId (): Integer; inline;
 123     procedure setGamePanelId (v: Integer); inline;
 124
 125   public
 126     property panel[idx: Integer]: TDynRecord read getPanelByIdx;
 127     property panelIndex[pan: TDynRecord]: Integer read getPanelIndex;
 128     // triggers
 129     property tgPanelID: Integer read getPanelId {write setPanelId};
 130     property tgShotPanelID: Integer read getPanelId {write setPanelId};
 131     property TexturePanel: Integer read getTexturePanel {write setTexturePanel}; // texturepanel, int
 132     // user fields
 133     property gamePanelId: Integer read getGamePanelId write setGamePanelId;
 134   end;
 135
 136 implementation
 137
 138 uses
 139   SysUtils, {e_log,} utils, xparser, xstreams;
 140
 141
 142 // ////////////////////////////////////////////////////////////////////////// //
 143 constructor TDFPoint.Create (ax, ay: LongInt); begin X := ax; Y := ay; end;
 144
 145
 146 // ////////////////////////////////////////////////////////////////////////// //
 147 function TDynRecordHelper.getGamePanelId (): Integer; inline;
 148 var
 149   fld: TDynField;
 150 begin
 151   fld := field['gamePanelId'];
 152   if (fld = nil) or (fld.baseType <> TDynField.TType.TInt) then result := -1 else result := fld.ival;
 153 end;
 154
 155
 156 procedure TDynRecordHelper.setGamePanelId (v: Integer); inline;
 157 begin
 158   setUserField('gamePanelId', Integer(v));
 159 end;
 160
 161
 162 // ////////////////////////////////////////////////////////////////////////// //
 163 function TDynRecordHelper.getFieldWithType (const aname: AnsiString; atype: TDynField.TType): TDynField; inline;
 164 begin
 165   result := field[aname];
 166   if (result = nil) then raise Exception.Create(Format('field ''%s'' not found in record ''%s'' of type ''%s''', [aname, name, id]));
 167   if (result.baseType <> atype) then raise Exception.Create(Format('field ''%s'' in record ''%s'' of type ''%s'' has invalid data type', [aname, name, id]));
 168 end;
 169
 170
 171 function TDynRecordHelper.getPointField (const aname: AnsiString): TDFPoint; inline;
 172 var
 173   fld: TDynField;
 174 begin
 175   fld := field[aname];
 176   if (fld = nil) then raise Exception.Create(Format('field ''%s'' not found in record ''%s'' of type ''%s''', [aname, name, id]));
 177   if (fld.baseType <> TPoint) then raise Exception.Create(Format('field ''%s'' in record ''%s'' of type ''%s'' has invalid data type', [aname, name, id]));
 178   result := TDFPoint.Create(fld.ival, fld.ival2);
 179 end;
 180
 181
 182 function TDynRecordHelper.getPanelByIdx (idx: Integer): TDynRecord; inline;
 183 var
 184   fld: TDynField;
 185 begin
 186   fld := headerRec['panel'];
 187   if (fld <> nil) then result := fld.item[idx] else result := nil;
 188 end;
 189
 190
 191 function TDynRecordHelper.getPanelIndex (pan: TDynRecord): Integer;
 192 var
 193   fld: TDynField;
 194   f: Integer;
 195 begin
 196   result := -1;
 197   if (pan <> nil) then
 198   begin
 199     fld := headerRec['panel'];
 200     if (fld <> nil) then
 201     begin
 202       for f := 0 to fld.count-1 do if (fld.item[f] = pan) then begin result := f; exit; end;
 203     end;
 204   end;
 205 end;
 206
 207
 208 function TDynRecordHelper.panelCount (): Integer; inline;
 209 var
 210   fld: TDynField;
 211 begin
 212   fld := headerRec['panel'];
 213   if (fld <> nil) then result := fld.count else result := 0;
 214 end;
 215
 216
 217 function TDynRecordHelper.TextureNum (): Word; inline;
 218 var
 219   idx: Integer;
 220   fld: TDynField;
 221 begin
 222   fld := getFieldWithType('texture', TDynField.TType.TUShort);
 223   idx := fld.recrefIndex;
 224   if (idx < 0) then result := Word(TEXTURE_NONE) else result := Word(idx);
 225 end;
 226
 227
 228 // ////////////////////////////////////////////////////////////////////////// //
 229 // trigger
 230 function TDynRecordHelper.trigRec (): TDynRecord; inline;
 231 var
 232   fld: TDynField;
 233 begin
 234   fld := getFieldWithType('triggerdata', TDynField.TType.TTrigData);
 235   if (fld <> nil) then result := fld.recref else result := nil;
 236 end;
 237
 238
 239 function TDynRecordHelper.trigMonsterId (): Integer; inline;
 240 var
 241   fld: TDynField;
 242 begin
 243   fld := getFieldWithType('monsterid', TDynField.TType.TInt);
 244   result := fld.recrefIndex;
 245 end;
 246
 247
 248 // ////////////////////////////////////////////////////////////////////////// //
 249 function TDynRecordHelper.mapName (): AnsiString; inline; begin result := utf2win(getFieldWithType('name', TDynField.TType.TChar).sval); end;
 250 function TDynRecordHelper.mapAuthor (): AnsiString; inline; begin result := utf2win(getFieldWithType('author', TDynField.TType.TChar).sval); end;
 251 function TDynRecordHelper.mapDesc (): AnsiString; inline; begin result := utf2win(getFieldWithType('description', TDynField.TType.TChar).sval); end;
 252 function TDynRecordHelper.musicName (): AnsiString; inline; begin result := utf2win(getFieldWithType('music', TDynField.TType.TChar).sval); end;
 253 function TDynRecordHelper.skyName (): AnsiString; inline; begin result := utf2win(getFieldWithType('sky', TDynField.TType.TChar).sval); end;
 254 function TDynRecordHelper.X (): Integer; inline; begin result := getFieldWithType('position', TDynField.TType.TPoint).ival; end;
 255 function TDynRecordHelper.Y (): Integer; inline; begin result := getFieldWithType('position', TDynField.TType.TPoint).ival2; end;
 256 function TDynRecordHelper.Width (): Word; inline; begin result := Word(getFieldWithType('size', TDynField.TType.TSize).ival); end;
 257 function TDynRecordHelper.Height (): Word; inline; begin result := Word(getFieldWithType('size', TDynField.TType.TSize).ival2); end;
 258 function TDynRecordHelper.PanelType (): Word; inline; begin result := Word(getFieldWithType('type', TDynField.TType.TUShort).ival); end;
 259 function TDynRecordHelper.TextureRec (): TDynRecord; inline; begin result := getFieldWithType('texture', TDynField.TType.TUShort).recref; end;
 260 function TDynRecordHelper.Alpha (): Byte; inline; begin result := Byte(getFieldWithType('alpha', TDynField.TType.TUByte).ival); end;
 261 function TDynRecordHelper.Flags (): Byte; inline; begin result := Byte(getFieldWithType('flags', TDynField.TType.TUByte).ival); end;
 262 function TDynRecordHelper.Resource (): AnsiString; inline; begin result := utf2win(getFieldWithType('path', TDynField.TType.TChar).sval); end;
 263 function TDynRecordHelper.Anim (): Boolean; inline; begin result := (getFieldWithType('animated', TDynField.TType.TBool).ival <> 0); end;
 264 function TDynRecordHelper.ItemType (): Byte; inline; begin result := Byte(getFieldWithType('type', TDynField.TType.TUByte).ival); end;
 265 function TDynRecordHelper.Options (): Byte; inline; begin result := Byte(getFieldWithType('options', TDynField.TType.TUByte).ival); end;
 266 function TDynRecordHelper.MonsterType (): Byte; inline; begin result := Byte(getFieldWithType('type', TDynField.TType.TUByte).ival); end;
 267 function TDynRecordHelper.Direction (): Byte; inline; begin result := Byte(getFieldWithType('direction', TDynField.TType.TUByte).ival); end;
 268 function TDynRecordHelper.AreaType (): Byte; inline; begin result := Byte(getFieldWithType('type', TDynField.TType.TUByte).ival); end;
 269 function TDynRecordHelper.Enabled (): Boolean; inline; begin result := (getFieldWithType('enabled', TDynField.TType.TBool).ival <> 0); end;
 270 function TDynRecordHelper.TriggerType (): Byte; inline; begin result := Byte(getFieldWithType('type', TDynField.TType.TUByte).ival); end;
 271 function TDynRecordHelper.ActivateType (): Byte; inline; begin result := Byte(getFieldWithType('activatetype', TDynField.TType.TUByte).ival); end;
 272 function TDynRecordHelper.Keys (): Byte; inline; begin result := Byte(getFieldWithType('keys', TDynField.TType.TUByte).ival); end;
 273
 274 function TDynRecordHelper.getPanelId (): Integer; inline; begin result := getFieldWithType('panelid', TDynField.TType.TInt).recrefIndex; end;
 275 function TDynRecordHelper.getTexturePanel (): Integer; begin result := getFieldWithType('texturepanel', TDynField.TType.TInt).recrefIndex; end;
 276
 277 {$INCLUDE mapdef_impl.inc}
 278
 279
 280 end.