a7da312c8207b4ef8650d2291355c7796da91b44
[sheet.git] / sc.plp
1 <(common.inc.plp)><:
2 use List::Util qw(max sum);
3
4 my %scver = (
5         id => 'bw',
6         name => 'Brood War',
7         title => 'starcraft',
8         game => 'StarCraft',
9         major => 1,
10 );
11
12 if ($ENV{PATH_INFO} and $ENV{PATH_INFO} eq '/2') {
13         %scver = (
14                 id => 'hots',
15                 name => 'Heart of the Swarm',
16                 title => 'starcraft2',
17                 game => 'StarCraft II',
18                 major => 2,
19         );
20 }
21 my $datafile = "sc-units-$scver{id}.inc.pl";
22
23 Html({
24         title => "$scver{title} unit cheat sheet",
25         version => 'v1.1',
26         description => [
27                 "Reference of $scver{game} unit properties,"
28                 . " comparing various statistics of all the units in $scver{name}"
29                 . ' including costs, damage, defense, speed, ranges, and abilities.',
30         ],
31         keywords => [
32                 qw'
33                 starcraft game unit statistics stats comparison table sheet cheat
34                 reference software attributes properties
35                 ',
36                 $scver{major} < 2 ? qw' bw broodwar brood war ' : qw' starcraft2 hots ',
37         ],
38         stylesheet => [qw'light'],
39         raw => '<link rel="stylesheet" type="text/css" media="all" href="/sc.css?1.1" title="light">',
40         data => [$datafile],
41 });
42
43 print "<h1>$scver{game} units</h1>\n\n";
44
45 my $units = do $datafile;
46 die "Cannot open unit data: $_\n" for $@ || $! || ();
47 my $patch = shift @{$units}
48         or die "Cannot open unit data: metadata not found\n";
49
50 print "<p>Unit properties as seen or measured in $scver{name}\n$patch.\n";
51 print "Also see the $_ table.\n" for join(', ',
52         ('<a href="/sc/2">StarCraft 2: HotS</a>')    x ($scver{major} < 2),
53         ('<a href="/sc">original SC: Brood War</a>') x ($scver{major} > 1),
54 );
55 print "</p>\n\n";
56
57 sub addupgrade {
58         my ($ref, $increase) = @_;
59         if (ref $increase eq 'HASH') {
60                 addupgrade(\${$ref}->{$_}, $increase->{$_}) for keys %{$increase};
61         }
62         elsif (ref $increase eq 'ARRAY') {
63                 addupgrade(\${$ref}->[$_], $increase->[$_]) for 0 .. $#{$increase};
64         }
65         ${$ref} += $increase if $increase =~ /^-?[0-9.]+/;
66 }
67
68 for my $unit (@{$units}) {
69         for my $upgrade (@{ $unit->{upgrade} }) {
70                 while (my ($col, $increase) = each %{$upgrade}) {
71                         defined $unit->{$col} or next;
72                         addupgrade(\( $unit->{upgraded}->{$col} //= $unit->{$col} ), $increase);
73                 }
74         }
75 }
76
77 sub coltoggle {
78         my ($name, $id, $nolink) = @_;
79         return sprintf(
80                 (defined $get{order} ? $get{order} eq $id : !$id) ? '%2$s ▼'
81                         : $nolink ? '%2$s' : '<a href="?%s">%s</a>',
82                 $id && "order=$id", $name
83         );
84 }
85 :><table class="units">
86 <thead><tr>
87         <th></th>
88         <th><:= coltoggle('name', '') :></th>
89         <th class="val min"><img src="/minerals.png" alt="min"></th>
90         <th class="val gas"><img src="/gas.png" alt="gas"></th>
91         <th class="val time"><:= coltoggle(qw'build cost') :></th>
92         <th class="unit" colspan="4"><:= coltoggle(qw'size size') :></th>
93         <th class="val unit-hp">HP</th>
94         <th class="val unit-shield">shield</th>
95         <th class="val unit-armor" title="armor">⛨</th>
96         <th class="val hurt">attack</th>
97         <th class="hurt hurtrel"><:= coltoggle(qw'dps attack 1') :></th>
98         <th class="val unit-range" colspan=3>range</th>
99         <th class="val unit-sight">sight</th>
100         <th class="val unit-speed">speed</th>
101         <th class="unit-magic">specials</th>
102 </tr></thead>
103 <:
104 sub showrange {
105         my ($min, $max) = @_;
106         return '' if not defined $min;
107         $_ &&= int($_ + .5) for $min, $max;  # round halves up
108         return $min if not defined $max or $min == $max;
109         return "$min-$max";
110 }
111
112         sub showattack {
113                 my ($row, $area) = @_;
114                 my $attack = $row->{attack}->[$area]
115                         or return '<td colspan=4 class="hurt">';
116
117                 my $upattack = $row->{upgraded}->{attack}->[$area];
118                 my $damage = $attack->{damage};
119                 my $maxdamage = $upattack->{damage} // $damage;
120                 $damage = $damage->[0] if ref $damage;
121                 $maxdamage = $maxdamage->[-1] if ref $maxdamage;
122
123                 my $out = '<td class="val hurt">';
124                 $out .= "<small>$attack->{count}× </small>" if $attack->{count} > 1;
125                 $out .= '<span class="unit-l" title="explosive">*</span>'
126                         if $attack->{type} eq 'explosive';
127                 $out .= '<span class="unit-s" title="implosive">~</span>'
128                         if $attack->{type} eq 'implosive';
129                 $out .= sprintf('<span class="%s" title="%s">&ge;</span>',
130                         (map {
131                                 $_ =~ /^light/ ? 'unit-s' :
132                                 $_ eq 'armored' ? 'unit-l' :
133                                 $_ eq 'organic' ? 'unit-o' :
134                                 $_ =~ /^massive/ ? 'unit-h' :
135                                 $_ eq 'shields' ? 'unit-shield' :
136                                 '',
137                         } join '_', keys %{ $attack->{bonus} }),
138                         join(', ', map {(
139                                 sprintf('+%s vs %s',
140                                         (map {
141                                                 ref $_ ? showrange($_->[0], $_->[-1]) : $_
142                                         } $attack->{bonus}->{$_}),
143                                         $_,
144                                 ),
145                         )} keys %{ $attack->{bonus} }),
146                 ) if $attack->{bonus};
147
148                 $out .= sprintf '<span title="%s">', $attack->{name} if $attack->{name};
149                 $out .= showrange($damage, $maxdamage);
150                 $out .= '</span>' if $attack->{name};
151                 $out .= sprintf('<span class="unit-splash" title="%s">%s</span>',
152                         $attack->{splash} eq 'line' ? ('linear', '×') : ('splash', '+')
153                 ) if $attack->{splash};
154
155                 $out .= '<td class="val hurt hurtrel">';
156                 if ($attack->{cooldown}) {
157                         if (my $type = $attack->{type}) {
158                                 if ($type eq 'explosive') {
159                                         $damage /= 2;
160                                 }
161                                 elsif ($type eq 'implosive') {
162                                         $damage /= 4;
163                                 }
164                         }
165                         $damage *= ($attack->{count} // 1) / $attack->{cooldown};
166                         if (my $bonus = $upattack->{bonus} // $attack->{bonus}) {
167                                 $maxdamage += $_ for max(
168                                         map { ref $_ ? $_->[-1] : $_ } values %{$bonus}
169                                 );
170                         }
171                         $maxdamage *= ($upattack->{count} // $attack->{count} // 1)
172                                     / ($upattack->{cooldown} // $attack->{cooldown});
173                         $out .= showrange($damage, $maxdamage);
174                 }
175
176                 $out .= '<td class="unit hurt-g">' . '▽' x !!($attack->{anti} & 1);
177                 $out .= '<td class="unit hurt-a">' . '△' x !!($attack->{anti} & 2);
178
179                 return $out;
180         }
181
182         sub showmagic {
183                 my ($row) = @_;
184                 my $specials = $row->{special} or return '';
185                 return join ' ', map {
186                         sprintf '<span%s title="%s">%s</span>',
187                                 $_->{duration} < 0 && ' class="magic-perma"',
188                                 join('',
189                                         $_->{name},
190                                         $_->{desc} ? ": $_->{desc}" : '',
191                                         (map { $_ && " ($_)" } join ', ',
192                                                 #TODO: apply upgrades
193                                                 $_->{range} ? "range $_->{range}" : (),
194                                                 $_->{cost} ? sprintf('cost %.0f%%%s',
195                                                         100 * $_->{cost} / $row->{energy},
196                                                         defined $_->{maint} && sprintf('+%.1f%%/s',
197                                                                 100 * $_->{maint} / $row->{energy},
198                                                         ),
199                                                 ) :
200                                                 $_->{cooldown} ? "cooldown $_->{cooldown}s" : (),
201                                         ),
202                                 ),
203                                 sprintf($_->{build} ? '(%s)' : '%s', $_->{abbr}),
204                 } grep { defined $_->{abbr} } @{$specials};
205         }
206
207         sub showunitcols {
208                 my ($row) = @_;
209                 local $_ = $row;
210                 $_->{hp} += $_->{shield} if $_->{shield};
211                 my $suitchar = '';
212                 if ($_->{attr}->{structure}) {
213                         $suitchar = 'b';
214                 }
215                 elsif ($_->{suit}) {
216                         $suitchar = [qw/? s m l/]->[$_->{suit}];
217                 }
218                 elsif ($_->{cargo} > 0) {
219                         $suitchar = [qw/? s m l l h h h h/]->[abs $_->{cargo}];
220                 }
221                 elsif ($_->{size}) {
222                         $suitchar = [qw/s m l h h h/]->[$_->{size}];
223                 }
224                 elsif ($_->{attr} and $_->{attr}->{light}) {
225                         $suitchar = 's';
226                 }
227                 elsif ($_->{attr} and $_->{attr}->{armored}) {
228                         $suitchar = 'l';
229                 }
230
231                 return (
232                         '<td class="val min">' . ($_->{min} // ''),
233                         '<td class="val gas">' . ($_->{gas} || ''),
234                         !defined $_->{build} ? '<td>' : sprintf('<td class="val time">%s%.0f',
235                                 !!$_->{base} && '<span class="unit-composed">+</span>',
236                                 $_->{build} || '0',
237                         ),
238                         !$suitchar ? '<td>' : sprintf('<td class="unit unit-%s">%s%s',
239                                 $suitchar, ucfirst $suitchar,
240                                 $_->{attr}->{massive}
241                                         && '<span class="unit-massive" title="massive">⚓</span>',
242                         ),
243                         '<td class="val unit">' . (
244                                 defined $_->{unit} && $_->{unit} == .5 ? '½' : $_->{unit}
245                         ),
246                         '<td class="unit unit-type">' . join('', grep { $_ }
247                                 (defined $_->{organic} ? !$_->{organic} : $_->{attr}->{mech})
248                                         && '<span class="unit-u" title="mechanic">m</span>',
249                                 ($_->{organic} || $_->{attr}->{organic})
250                                         && '<span class="unit-o" title="organic">o</span>',
251                                 $_->{attr}->{psionic}
252                                         && '<span class="unit-p" title="psionic">ψ</span>',
253                         ),
254                         '<td class="unit unit-attr">' . join('', grep { $_ }
255                                 $_->{attr}->{armored}
256                                         && '<span class="unit unit-l" title="armored">A</span>',
257                                 $_->{attr}->{light}
258                                         && '<span class="unit unit-s" title="light">L</span>',
259                         ),
260                         '<td class="val unit-hp">' . $_->{hp} // '',
261                         $_->{shield} ? sprintf('<td class="val unit-shield">%.0f%%<td',
262                                 100 * $_->{shield} / $_->{hp}
263                         ) : '<td colspan=2',
264                         ' class="val unit-armor">' .
265                                 showrange($_->{armor}, $_->{upgraded}->{armor}),
266                         showattack($_, 0),
267                         '<td class="val unit-range">' .
268                                 showrange(map { $_->{attack}->[0]->{range} } $_, $_->{upgraded}),
269                         '<td class="val unit-sight">' . sprintf(
270                                 $_->{detect} ? '<strong class="unit-detect">%s</strong>' : '%s',
271                                 showrange($_->{sight}, $_->{upgraded}->{sight})
272                         ),
273                         '<td class="val unit-speed">' .
274                                 showrange($_->{speed}, $_->{upgraded}->{speed}),
275                         $_->{attr}->{jump}
276                                 && qq'<span class="unit unit-jump" title="$_->{attr}->{jump}">↕</span>',
277                         $_->{attr}->{flying}
278                                 && qq'<span class="unit unit-jump" title="flying">↑</span>',
279                         '<td class="unit-magic">' . showmagic($_),
280                         !$_->{attack}->[1] ? () : (
281                                 '<tr><td colspan=12>', showattack($_, 1), '<td colspan=4>'
282                         ),
283                         "\n"
284                 );
285         }
286
287         my $grouped = 1;  # race headers
288         if (exists $get{order}) {
289                 $grouped = 0;
290                 $get{order} ||= '';
291                 if ($get{order} eq 'size') {
292                         $_->{order} = (
293                                 $_->{unit}*16 + ($_->{size} // $_->{suit}) + $_->{cargo}/8
294                                 + $_->{hp}/512 + $_->{min}/8192
295                         ) for @$units;
296                 }
297                 elsif ($get{order} eq 'cost') {
298                         $_->{order} = (
299                                 $_->{gas}*1.5 + $_->{min} + $_->{unit}/8 + $_->{build}/256/8
300                         ) for @$units;
301                 }
302                 elsif ($get{order} eq 'attack') {
303                         $_->{order} = $_->{hp} / 1024 + $_->{shield} / 1008 + max(
304                                 map {
305                                         ((map { ref $_ ? $_->[-1] : $_ } $_->{damage})[0])
306                                         * ($_->{count} // 1) / ($_->{cooldown} // 1)
307                                         * ($_->{splash} ? 1.01 : 1)
308                                         * ($_->{type} eq 'implosive' ? .96 : 1)
309                                         * ($_->{type} eq 'explosive' ? .98 : 1)
310                                 } @{ $_->{attack} }
311                         ) for @$units;
312                 }
313                 else {
314                         $units->[$_]->{order} = $_ for 0 .. $#$units;
315                 }
316         }
317         my @rows = @{$units};
318         @rows = sort {$a->{order} <=> $b->{order}} @rows unless $grouped;
319
320         my ($race, $cat) = ('', '');
321         for (@rows) {
322                 if ($grouped) {
323                         printf '<tbody id="%s"><tr class="race"><th colspan="20"><h2>%s</h2>'."\n",
324                                 $race = $_->{race}, ucfirst $race
325                                         unless $race eq $_->{race};
326                 }
327                 else {
328                         $_->{cat} = $_->{race};
329                 }
330
331                 print(
332                         '<tr>',
333                         '<th class="cat">', $cat ne $_->{cat} && ($cat = $_->{cat}),
334                         '<td>', $_->{name},
335                         showunitcols($_),
336                 );
337
338                 for my $subrow (@{ $_->{special} }) {
339                         $subrow->{alt} or next;
340                         print(
341                                 '<tr class="alt"><th class="cat"><td>', $subrow->{alt},
342                                 showunitcols($subrow),
343                         );
344                 }
345         }
346 :>
347 </table>
348
349 <div class="legend">
350 <h2>Legend</h2>
351
352 <dl>
353 <dt>cost
354         <dd>minerals+gas required to create one unit
355         <dd>includes total expenses if based on existing units
356 <dt>build
357         <dd>relative time needed to create at least one unit
358         <dd>excludes construction of dependencies such as buildings
359                 and <span class="unit-composed">+</span>parent units
360 <dt>size
361         <dd><:
362 if ($scver{major} > 1) {
363                 :>transports can fit 8 <span class="unit unit-s">S</span>mall,
364                 4 <span class="unit unit-m">M</span>edium,
365                 2 <span class="unit unit-l">L</span>arge,
366                 or a single <span class="unit unit-h">H</span>uge unit
367         <dd>massive <span class="unit-massive">⚓</span> units
368                 cannot be lifted or slowed and can break force fields<:
369 } else {
370                 :>affected by <span class="unit unit-s">S</span>mall,
371                 <span class="unit unit-m">M</span>edium, or
372                 <span class="unit unit-l">L</span>arge unit damage<:
373 } :>
374         <dd>number of command points taken per unit
375         <dd><:
376 if ($scver{major} > 1) {
377                 :>received damage depends on
378                 <span class="unit unit-o">o</span>rganic,
379                 <span class="unit unit-u">m</span>echanic,
380                 <span class="unit unit-p">ψ</span>(ps)ionic,
381                 <span class="unit unit-s">L</span>ight, and
382                 <span class="unit unit-l">A</span>rmored
383                 attributes<:
384 } else {
385                 :><span class="unit unit-o">o</span>rganic/<span class="unit unit-u">m</span>echanic unit<:
386 } :>
387 <dt>HP<dd>
388         total number of hitpoints (including shields)
389 <dt>shield
390         <dd>percentage of HP in shields
391         <dd>shields always take full damage, irrelevant of unit size
392         <dd>does not take armor bonuses, but upgrades can decrease damage to any shield hit by upto 3
393 <dt>armor
394         <dd>base unit armor
395         <dd>can be increased by upto 3 at various facilities
396         <dd>each point decreases damage per hit by one, upto a minimum of ½
397         <dd>reduction applies to initial damage, before size penalties
398                 <small>(so a plasma hit of 12 to 4 armor large deals 2 damage, not ½)</small>
399 <dt>attack
400         <dd>damage given per single hit
401         <dd><span class="hurtrel">dps</span> indicates relative amount of damage
402                 done in 1 second of in-game time
403         <dd>splash damage hits all objects nearby <span class="unit-splash">+</span>
404                 or in a straight line <span class="unit-splash">×</span>.
405         <dd><:
406 if ($scver{major} > 1) {
407                 :>does not include <span>&ge;</span>bonus damage
408                 dealt to susceptible unit types<:
409 } else {
410                 :><span class="unit-l">*</span>explosive damage does only
411                 50% damage to small units, 75% to medium, 100% to large
412         <dd><span class="unit-s">~</span>concussive/plasma damage does
413                 25% to large, 50% medium, 100% to small units<:
414 } :>
415         <dd>targets <span class="hurt-g">▽</span>&nbsp;ground
416                 and/or  <span class="hurt-a">△</span>&nbsp;air
417 <dt>range
418         <dd>maximum range of weapon (note siege tank also has a minimum range)
419 <dt>sight
420         <dd>range in which the unit detects other units
421         <dd><strong class="unit-detect">emphasis</strong> indicates ability to detect cloaked units
422 <dt>speed
423         <dd>relative speed of movement (when in full motion, startup speed ignored)
424 <dt>specials
425         <dd>parentheses () indicate that it needs to be researched first
426         <dd><span class="magic-perma">passive</span> abilities are always enabled
427         <dd>hover for description
428         <dd>range is maximum range required to activate
429         <dd>cost is percentage of total energy lost
430 </dl>
431
432 <p>
433 When two values are given (1-2), second value indicates attribute after all
434 possible upgrades.
435 </p>
436
437 </div>
438