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