tools/findAllCollideableObjects.pl

   1 #!/usr/bin/perl
   2
   3 use strict;
   4 use warnings;
   5 use perllib::Iff;
   6
   7 #       Things to look for:
   8 #
   9 #       object templates
  10 #               forceNoCollision
  11 #
  12 #       appearance templtaes
  13 #               FORM 0003
  14 #                       Extents
  15 #                       NULL collision extent means not collideable
  16 #                       1163416400 - EXSP
  17 #                       1163412056 - EXBX
  18 #                       1480808780 - XCYL
  19 #                       1129140308 - CMPT
  20 #                       1146372428 - DTAL
  21 #                       1129141064 - CMSH
  22 #                       1314212940 - NULL
  23 #
  24 #       Path:
  25 #               objectTemplate (probably have to go up heirarchy / shared)
  26 #                       - scan for forceNoCollision
  27 #                       - scan for appearanceTemplate (server side)
  28 #               appearanceTemplate
  29 #                       - scan for ssa
  30 #               serverSideAppearance
  31 #                       - scan for collision extent
  32
  33 use constant DEBUG              => 1;
  34
  35 use constant UNTESTED           => -1;
  36 use constant NOT_COLLIDEABLE    => 0;
  37 use constant COLLIDEABLE        => 1;
  38
  39 sub usage
  40 {
  41         die "\n\tfindAllCollideableObjects.pl <branch>\n\n";
  42 }
  43
  44 usage if (!@ARGV);
  45
  46 my $branch = shift;
  47
  48 my $branchDir = "";
  49 open (P4, "p4 -ztag where //depot/swg/$branch/... |") || die "Can't run p4 where for $branch\n";
  50 while (<P4>)
  51 {
  52         $branchDir = $1 if (m!\.\.\. path (\S+)[\\\/]\.\.\.!);
  53 }
  54 close (P4);
  55
  56 $branchDir =~ s![\\\/]+!/!g;
  57
  58 my %appearanceTemplates;
  59 my %objectTemplates;
  60
  61 print "\nBuilding list of all object templates...\n";
  62 open (P4, "p4 files //depot/swg/$branch/dsrc/*/sys.s*/compiled/game/object/... |") || die "Can't run p4 files for $branch\n";
  63 while (<P4>)
  64 {
  65         next if (/ - delete/);
  66
  67         chomp;
  68         s!\#.*$!!;
  69
  70         # element maps to : [ <absolute path>, <collideable> ]
  71         my $path = $_;
  72         $path =~ s!//depot/swg/$branch/!$branchDir/!;
  73         $_ =~ s!^.*/dsrc/sku[^\\\/]+/sys[^\\\/]+/compiled/game/!!;
  74
  75         $objectTemplates{$_} = [$path, UNTESTED];
  76 }
  77 close (P4);
  78
  79 print "\nBuilding list of all appearance files...\n";
  80 open (P4, "p4 files //depot/swg/$branch/data/*/sys.*/.../appearance/... |") || die "Can't run p4 files for $branch\n";
  81 while (<P4>)
  82 {
  83         next if (/ - delete/);
  84
  85         chomp;
  86         s!\#.*$!!;
  87
  88         my $path = $_;
  89         $path =~ s!//depot/swg/$branch/!$branchDir/!;
  90         $_ =~ s!^.*/data/sku[^\\\/]+/sys[^\\\/]+/[^\\\/]+/[^\\\/]+/!!;
  91
  92         $appearanceTemplates{$_} = [$path, UNTESTED];
  93 }
  94 close (P4);
  95
  96 print "\nScanning all object templates...\n";
  97 foreach my $objectTemplate (sort keys %objectTemplates)
  98 {
  99         # skip this element if we've tested it
 100         next if ($objectTemplates{$objectTemplate}->[1] != UNTESTED);
 101
 102         if ($objectTemplate =~ m!/base/! || $objectTemplate =~ m!/base/!)
 103         {
 104                 print "$objectTemplate : not collideable : because it's a base object\n" if (DEBUG);
 105                 $objectTemplates{$objectTemplate}->[1] = NOT_COLLIDEABLE;
 106                 next;
 107         }
 108
 109         if ($objectTemplate =~ m!\.(btm)|(me)|(txt)!)
 110         {
 111                 print "$objectTemplate : not collideable : because it's a file I don't care about\n" if (DEBUG);
 112                 $objectTemplates{$objectTemplate}->[1] = NOT_COLLIDEABLE;
 113                 next;
 114         }
 115
 116         my $collideable = UNTESTED;
 117         my $analyzingObjectTemplate = $objectTemplate;
 118         my $debugTabs = "";
 119
 120         while ($collideable == UNTESTED)
 121         {
 122                 my $forceNoCollision = 0;
 123                 my $appearanceTemplate = "";
 124                 my $baseObjectTemplate = "";
 125                 my $sharedObjectTemplate = "";
 126                 my $portalLayoutFile = "";
 127
 128                 if (DEBUG)
 129                 {
 130                         print "${debugTabs}Scanning $analyzingObjectTemplate...\n";
 131                         $debugTabs .= "\t";
 132                 }
 133
 134                 my $analyzingObjectTemplateDisk = $objectTemplates{$analyzingObjectTemplate}->[0];
 135                 open (OT, $analyzingObjectTemplateDisk) || die "Can't open $analyzingObjectTemplateDisk\n";
 136                 while (<OT>)
 137                 {
 138                         $baseObjectTemplate = $1 if (m/^\s*\@base\s+(\S+)/i);
 139                         $forceNoCollision = 1 if (m/^\s*forceNoCollision\s*=\s*true/i);
 140                         $appearanceTemplate = $1 if (m/^\s*appearanceFilename\s*=\s*\"(\S+)\"/i);
 141                         $sharedObjectTemplate = $1 if (m/^\s*(?:crafted)?sharedTemplate\s*=\s*\"(\S+)\"/i);
 142                         $portalLayoutFile = $1 if (m/^\s*portalLayoutFilename\s*=\s*\"(\S+)\"/i);
 143                 }
 144                 close (OT);
 145
 146                 if ($forceNoCollision)
 147                 {
 148                         print "$objectTemplate : not collideable : forceNoCollision specified\n" if (DEBUG);
 149                         $collideable = NOT_COLLIDEABLE;
 150                         last;
 151                 }
 152
 153                 if ($portalLayoutFile)
 154                 {
 155                         print "$objectTemplate : collideable : portal layout found\n" if (DEBUG);
 156                         $collideable = COLLIDEABLE;
 157                         last;
 158                 }
 159
 160                 if ($appearanceTemplate)
 161                 {
 162                         my $appearanceTemplateDisk = (exists $appearanceTemplates{$appearanceTemplate}) ? $appearanceTemplates{$appearanceTemplate}->[0] : "";
 163
 164                         if ($appearanceTemplateDisk =~ m!/sys\.client/!)
 165                         {
 166                                 print "$objectTemplate : not collideable : appearance is client side only\n" if (DEBUG);
 167                                 $collideable = NOT_COLLIDEABLE;
 168                                 last;
 169                         }
 170                         else
 171                         {
 172                                 print "${debugTabs}Scanning appearance $appearanceTemplate...\n" if (DEBUG);
 173                                 if ($appearanceTemplateDisk)
 174                                 {
 175                                         my $appearanceFileHandle;
 176                                         open ($appearanceFileHandle, $appearanceTemplateDisk) || die "Can't open $appearanceTemplateDisk\n";
 177                                         my $iff = Iff->createFromFileHandle($appearanceFileHandle);
 178                                         close ($appearanceFileHandle);
 179
 180                                         # Handle Iff contents.
 181                                         my $name = $iff->getCurrentName();
 182                                         if ($name eq "APT " && $iff->isCurrentForm())
 183                                         {
 184                                                 $iff->enterForm();
 185
 186                                                 $name = $iff->getCurrentName();
 187                                                 if ($name eq "0000" && $iff->isCurrentForm())
 188                                                 {
 189                                                         $iff->enterForm();
 190
 191                                                         $name = $iff->getCurrentName();
 192
 193                                                         if ($name eq "NAME" && !$iff->isCurrentForm())
 194                                                         {
 195                                                                 $iff->enterChunk();
 196
 197                                                                 my $ssaFileName = $iff->read_string();
 198                                                                 print "${debugTabs}Scanning ssa $ssaFileName...\n" if (DEBUG);
 199                                                                 my $ssaFileNameDisk = (exists $appearanceTemplates{$ssaFileName}) ? $appearanceTemplates{$ssaFileName}->[0] : "";
 200                                                                 if ($ssaFileNameDisk)
 201                                                                 {
 202                                                                         my $ssaFileHandle;
 203                                                                         open ($ssaFileHandle, $ssaFileNameDisk) || die "Can't open $ssaFileNameDisk\n";
 204                                                                         $iff = Iff->createFromFileHandle($ssaFileHandle);
 205                                                                         close ($ssaFileHandle);
 206
 207                                                                         # Handle Iff contents
 208                                                                         my $name = $iff->getCurrentName();
 209                                                                         if ($name eq "APPR" && $iff->isCurrentForm())
 210                                                                         {
 211                                                                                 $iff->enterForm();
 212
 213                                                                                 $name = $iff->getCurrentName();
 214                                                                                 if ($name eq "0003" && $iff->isCurrentForm())
 215                                                                                 {
 216                                                                                         $iff->enterForm();
 217
 218                                                                                         # enter / exit past extent block
 219                                                                                         $iff->enterForm();
 220                                                                                         $iff->exitForm();
 221
 222                                                                                         # we should now be pointing to the collision property form
 223                                                                                         $name = $iff->getCurrentName();
 224
 225                                                                                         if ($name eq "NULL")
 226                                                                                         {
 227                                                                                                 # enter / exit past collision property block
 228                                                                                                 $iff->enterForm();
 229                                                                                                 $iff->exitForm();
 230
 231                                                                                                 # enter / exit past hardpoint block
 232                                                                                                 $iff->enterForm();
 233                                                                                                 $iff->exitForm();
 234
 235                                                                                                 $name = $iff->getCurrentName();
 236
 237                                                                                                 if ($name eq "FLOR" && $iff->isCurrentForm())
 238                                                                                                 {
 239                                                                                                         $iff->enterForm();
 240
 241                                                                                                         $name = $iff->getCurrentName();
 242                                                                                                         if ($name eq "DATA" && !$iff->isCurrentForm())
 243                                                                                                         {
 244                                                                                                                 $iff->enterChunk();
 245
 246                                                                                                                 my $hasFloor = $iff->read_uint8();
 247
 248                                                                                                                 if ($hasFloor == 0)
 249                                                                                                                 {
 250                                                                                                                         print "$objectTemplate : not collideable : null collision property and null floor\n" if (DEBUG);
 251                                                                                                                         $collideable = NOT_COLLIDEABLE;
 252                                                                                                                 }
 253                                                                                                                 else
 254                                                                                                                 {
 255                                                                                                                         print "$objectTemplate : collideable : non-null floor\n" if (DEBUG);
 256                                                                                                                         $collideable = COLLIDEABLE;
 257                                                                                                                 }
 258                                                                                                         }
 259                                                                                                 }
 260                                                                                         }
 261                                                                                         else
 262                                                                                         {
 263                                                                                                 print "$objectTemplate : collideable : non-null collision property\n" if (DEBUG);
 264                                                                                                 $collideable = COLLIDEABLE;
 265                                                                                         }
 266                                                                                 }
 267                                                                                 else
 268                                                                                 {
 269                                                                                         # for all other forms of this piece of data, we assume not collideable
 270                                                                                         print "$objectTemplate : not collideable : null collision property\n" if (DEBUG);
 271                                                                                         $collideable = NOT_COLLIDEABLE;
 272                                                                                 }
 273                                                                         }
 274                                                                 }
 275                                                         }
 276                                                 }
 277                                         }
 278
 279                                         # if we got here and didn't get a solution, default to collideable
 280                                         if ($collideable == UNTESTED)
 281                                         {
 282                                                 print "$objectTemplate : collideable : couldn't get appearance template info\n" if (DEBUG);
 283                                                 $collideable = COLLIDEABLE;
 284                                                 last;
 285                                         }
 286                                 }
 287                         }
 288                 }
 289
 290                 $sharedObjectTemplate =~ s!\.iff!\.tpf!;
 291                 $baseObjectTemplate =~ s!\.iff!\.tpf!;
 292
 293                 if (!$sharedObjectTemplate || !exists $objectTemplates{$sharedObjectTemplate})
 294                 {
 295                         if (!$baseObjectTemplate || !exists $objectTemplates{$baseObjectTemplate})
 296                         {
 297                                 print "$objectTemplate : collideable : no base, no shared, no appearance specified, defaulting\n" if (DEBUG);
 298                                 $collideable = COLLIDEABLE;
 299                                 last;
 300                         }
 301                         else
 302                         {
 303                                 $sharedObjectTemplate = "";
 304                         }
 305                 }
 306
 307                 $analyzingObjectTemplate = ($sharedObjectTemplate) ? $sharedObjectTemplate : $baseObjectTemplate;
 308         }
 309
 310         $objectTemplates{$objectTemplate}->[1] = $collideable;
 311 }
 312
 313 print "\nPrinting out object templates with collision...\n";
 314 foreach my $template (sort keys %objectTemplates)
 315 {
 316         print "$template\n" if ($objectTemplates{$template}->[1] == COLLIDEABLE && $template !~ /shared_/);
 317 }