sc: inline damage type indicators in html
[sheet.git] / sc.plp
diff --git a/sc.plp b/sc.plp
index 9a9a12a2e8af7ac4ff7e9e0e14382ac077404bcd..b06f22ec11f38b5ba190f174a78323f2f7abedfc 100644 (file)
--- a/sc.plp
+++ b/sc.plp
 <(common.inc.plp)><:
 
+my %scver = (
+       id => 'bw',
+       name => 'Brood War',
+       title => 'starcraft',
+       game => 'StarCraft',
+       major => 1,
+);
+
+if ($ENV{PATH_INFO} and $ENV{PATH_INFO} eq '/2') {
+       %scver = (
+               id => 'hots',
+               name => 'Heart of the Swarm',
+               title => 'starcraft2',
+               game => 'StarCraft II',
+               major => 2,
+       );
+}
+my $datafile = "sc-units-$scver{id}.inc.pl";
+
 Html({
-       title => 'starcraft unit cheat sheet',
-       version => 'v1.0',
+       title => "$scver{title} unit cheat sheet",
+       version => 'v1.1',
        description => [
-               'Reference of StarCraft unit properties,'
-               . ' comparing various statistics of all the units in Brood War'
+               "Reference of $scver{game} unit properties,"
+               . " comparing various statistics of all the units in $scver{name}"
                . ' including costs, damage, defense, speed, ranges, and abilities.',
        ],
-       keywords => [qw'
+       keywords => [
+               qw'
                starcraft game unit statistics stats comparison table sheet cheat
                reference software attributes properties
-       '],
+               ',
+               $scver{major} < 2 ? qw' bw broodwar brood war ' : qw' starcraft2 hots ',
+       ],
        stylesheet => [qw'light'],
+       raw => '<link rel="stylesheet" type="text/css" media="all" href="/sc.css?1.1" title="light">',
+       data => [$datafile],
 });
 
-:>
-<h1>StarCraft units</h1>
-
-<p>
-Unit properties as seen or measured in Brood War
-<span title="no known changes as of v1.16.1">version≥1.08</span>.
-</p>
+print "<h1>$scver{game} units</h1>\n\n";
 
-<style type="text/css">
-       .units {
-               border-collapse: separate;
-               border-spacing: 0;
-               margin: 0 auto;
-               white-space: nowrap;
-       }
-       .units th, .units td {
-               border: 0;
-               padding: 0 0.2em;
-               background: transparent;
-               text-align: left;
-       }
-       tr.alt td {
-               font-size: 70%;
-               border-top-style: dashed;
-       }
-       .units tr th:first-child {
-               padding-left: 0;
-       }
-       .units tr:hover:not(.race) {
-               background: #EEE;
-       }
-
-       table h2 {
-               padding: 1ex 0;
-               margin: 0;
-               text-align: center;
-       }
-       .units thead th, .units tfoot th {
-               font-size: 70%;
-               font-weight: normal;
-       }
-
-       .unit-o {color: #C08} /* organic */
-       .unit-u {color: #44C} /* mechanic */
-       img.unit-o, img.unit-u {
-               margin-left: 0.2em;
-               vertical-align: middle;
-       }
-       .unit-composed {
-               color: #C88;
-               font-size: 70%;
-       }
-       .unit {
-               text-align: center;
-               white-space: nowrap;
-       }
-       .unit.unit-s {color: #770}
-       .unit.unit-m {color: #C70}
-       .unit.unit-l {color: #D22}
-       .hurt.unit-s::before {
-               content: '~';
-               color: #773;
-       }
-       .hurt.unit-l::before {
-               content: '*';
-               color: #C66;
-       }
-       .hurt .unit-splash {
-               position: absolute;
-       }
-       .hurtrel, .units .hurtrel {
-               padding-left: 1em;
-               font-size: 70%;
-               color: #778;
-       }
-       .unit-splash {
-               color: #4A0;
-       }
-       .unit-detect::before {
-               content: '!';
-               color: #0A8;
-               font-size: 70%;
-               vertical-align: super;
-       }
-       .unit-magic {
-               padding-left: 0.5em;
-       }
+my $units = do $datafile;
+die "Cannot open unit data: $_\n" for $@ || $! || ();
+my $patch = shift @{$units}
+       or die "Cannot open unit data: metadata not found\n";
 
-       .units .val {
-               text-align: right;
-       }
+print "<p>Unit properties as seen or measured in $scver{name}\n$patch.\n</p>\n\n";
 
-       .legend dt {
-               float: none;
-               text-align: left;
-               margin-top: 1ex;
-               font-weight: bold;
+sub addupgrade {
+       my ($ref, $increase) = @_;
+       if (ref $increase eq 'HASH') {
+               addupgrade(\${$ref}->{$_}, $increase->{$_}) for keys %{$increase};
        }
-       .legend dd:before {
-               content: '• ';
-       }
-       .legend dd {
-               text-indent: -1em;
-               margin-left: 1em;
-               break-before: avoid;
-               -webkit-column-break-before: avoid;
+       elsif (ref $increase eq 'ARRAY') {
+               addupgrade(\${$ref}->[$_], $increase->[$_]) for 0 .. $#{$increase};
        }
+       ${$ref} += $increase if $increase =~ /^-?[0-9.]+/;
+}
 
-       .units, .legend {
-               display: table-cell;
-       }
-       .legend {
-               min-width: 20em;
-               text-align: left;
-       }
-       .units {
-               float: left;
-               padding-bottom: 1em;
-               margin-right: 2em;
-       }
-       .footer {
-               clear: left;
+for my $unit (@{$units}) {
+       for my $upgrade (@{ $unit->{upgrade} }) {
+               while (my ($col, $increase) = each %{$upgrade}) {
+                       defined $unit->{$col} or next;
+                       addupgrade(\( $unit->{upgraded}->{$col} //= $unit->{$col} ), $increase);
+               }
        }
-</style>
+}
 
-<:
 sub coltoggle {
        my ($name, $id) = @_;
        return sprintf(
@@ -156,12 +83,12 @@ sub coltoggle {
        <th class="val min"><img src="/minerals.png" alt="min"></th>
        <th class="val gas"><img src="/gas.png" alt="gas"></th>
        <th class="val time"><:= coltoggle(qw'build cost') :></th>
-       <th class="unit" colspan="2"><:= coltoggle(qw'size size') :></th>
+       <th class="unit" colspan="4"><:= coltoggle(qw'size size') :></th>
        <th class="val unit-hp">HP</th>
        <th class="val unit-shield">shield</th>
-       <th class="val unit-armor">armor</th>
-       <th class="val hurt" colspan="2">ground</th>
-       <th class="val hurt" colspan="2">air</th>
+       <th class="val unit-armor" title="armor">⛨</th>
+       <th class="val hurt" colspan=3>attack</th>
+       <th class="hurt hurtrel">dps</th>
        <th class="val unit-range">range</th>
        <th class="val unit-sight">sight</th>
        <th class="val unit-speed">speed</th>
@@ -169,87 +96,164 @@ sub coltoggle {
 </tr></thead>
 <:
 sub showrange {
-       my ($row, @elements) = @_;
-       my ($min, $max);
-
-       my $value = $row;
-       $value = ref $value eq 'HASH' && $value->{$_} or last for @elements;
-       if (ref $value eq 'ARRAY') {
-               $min = $value->[0];
-               $max = $value->[-1];
-       }
-       else {
-               $min = $max = $value;
-       }
-       defined $min or return '';
-
-       if ($row->{upgrade}) {
-               for (@{ $row->{upgrade} }) {
-                       my $increase = $_ or next;
-                       $increase = ref $increase eq 'HASH' && $increase->{$_} or last for @elements;
-                       $increase = $increase->[-1] if ref $increase eq 'ARRAY';
-                       $max += $increase if $increase;
-               }
-       }
-
-       if ($elements[0] eq 'attack' and $elements[1] ne 'range' and $elements[2] eq 'cmp') {{
-               my $type = $row->{$elements[0]}->{$elements[1]}->{type} or next;
-               if ($type eq 'explosive') {
-                       $min /= 2;
-               }
-               elsif ($type eq 'implosive') {
-                       $min /= 4;
-               }
-       }}
-       $_ = int($_ + .5) for $min, $max;  # round halves up
-
-       return $min == $max ? $min : "$min-$max";
+       my ($min, $max) = @_;
+       return '' if not defined $min;
+       $_ &&= int($_ + .5) for $min, $max;  # round halves up
+       return $min if not defined $max or $min == $max;
+       return "$min-$max";
 }
 
        sub showattack {
                my ($row, $area) = @_;
-               local $_ = $row->{attack}->{$area};
+               my $attack = $row->{attack}->[$area]
+                       or return '<td colspan=4 class="hurt">';
 
-               return '<td colspan="2" class="hurt">' unless $_;
+               my $out = '';
+               $out .= '<td class="unit hurt-g">' . '▽' x !!($attack->{anti} & 1);
+               $out .= '<td class="unit hurt-a">' . '△' x !!($attack->{anti} & 2);
+               $out .= '<td class="val hurt">';
 
-               my $tagbase = '<td class="val hurt';
-               if (ref $_ and $_->{type}) {
-                       if ($_->{type} eq 'explosive') {
-                               $tagbase .= ' unit-l';
-                       }
-                       elsif ($_->{type} eq 'implosive') {
-                               $tagbase .= ' unit-s';
+               my $upattack = $row->{upgraded}->{attack}->[$area];
+               my $damage = $attack->{damage};
+               my $maxdamage = $upattack->{damage} // $damage;
+               $damage = $damage->[0] if ref $damage;
+               $maxdamage = $maxdamage->[-1] if ref $maxdamage;
+
+               $out .= "<small>$attack->{count}× </small>" if $attack->{count} > 1;
+               $out .= '<span class="unit-l" title="explosive">*</span>'
+                       if $attack->{type} eq 'explosive';
+               $out .= '<span class="unit-s" title="implosive">~</span>'
+                       if $attack->{type} eq 'implosive';
+               $out .= showrange($damage, $maxdamage);
+               $out .= sprintf('<span class="unit-splash" title="%s">%s</span>',
+                       $attack->{splash} eq 'line' ? ('linear', '×') : ('splash', '+')
+               ) if $attack->{splash};
+
+               $out .= '<td class="val hurt hurtrel">';
+               if ($attack->{cooldown}) {
+                       if (my $type = $attack->{type}) {
+                               if ($type eq 'explosive') {
+                                       $damage /= 2;
+                               }
+                               elsif ($type eq 'implosive') {
+                                       $damage /= 4;
+                               }
                        }
+                       $damage *= ($attack->{count} // 1) / $attack->{cooldown};
+                       $maxdamage *= ($upattack->{count} // $attack->{count} // 1)
+                                   / ($upattack->{cooldown} // $attack->{cooldown});
+                       $out .= showrange($damage, $maxdamage);
                }
-               $tagbase .= '">';
 
-               my $out = showrange($row, 'attack', $area, 'damage');
-               $out .= '<span class="unit-splash">+</span>' if $_->{splash};
-               $out .= '<td class="val hurt hurtrel">' . showrange($row, 'attack', $area, 'cmp');
-               return $tagbase . $out;
+               return $out;
        }
 
        sub showmagic {
                my ($row) = @_;
                my $specials = $row->{special} or return '';
                return join ' ', map {
-                       sprintf '<span title="%s">%s</span>',
+                       sprintf '<span%s title="%s">%s</span>',
+                               $_->{duration} < 0 && ' class="magic-perma"',
                                join('',
                                        $_->{name},
                                        $_->{desc} ? ": $_->{desc}" : '',
-                                       $_->{range} ? sprintf(' (%s)', join ', ',
-                                               "range $_->{range}",
-#                                              "cost $_->{cost}",
+                                       $_->{range} || $_->{cost} ? sprintf(' (%s)', join ', ',
+                                               $_->{range} ? "range $_->{range}" : (),
+                                               $_->{cost} ? sprintf('cost %.0f%%%s',
+                                                       100 * $_->{cost} / $row->{energy},
+                                                       defined $_->{maint} && sprintf('+%.1f%%/s',
+                                                               100 * $_->{maint} / $row->{energy},
+                                                       ),
+                                               ) : (),
                                        ) : '',
                                ),
-                               $_->{abbr},
-               } @$specials;
+                               sprintf($_->{build} ? '(%s)' : '%s', $_->{abbr}),
+               } grep { defined $_->{abbr} } @{$specials};
+       }
+
+       sub showunitcols {
+               my ($row) = @_;
+               local $_ = $row;
+               $_->{hp} += $_->{shield} if $_->{shield};
+               my $suitchar = '';
+               if ($_->{attr}->{structure}) {
+                       $suitchar = 'b';
+               }
+               elsif ($_->{suit}) {
+                       $suitchar = [qw/? s m l/]->[$_->{suit}];
+               }
+               elsif ($_->{cargo} > 0) {
+                       $suitchar = [qw/? s m l l h h h h/]->[abs $_->{cargo}];
+               }
+               elsif ($_->{size}) {
+                       $suitchar = [qw/s m l h h h/]->[$_->{size}];
+               }
+               elsif ($_->{attr} and $_->{attr}->{light}) {
+                       $suitchar = 's';
+               }
+               elsif ($_->{attr} and $_->{attr}->{armored}) {
+                       $suitchar = 'l';
+               }
+
+               return (
+                       '<td class="val min">' . ($_->{min} // ''),
+                       '<td class="val gas">' . ($_->{gas} || ''),
+                       !defined $_->{build} ? '<td>' : sprintf('<td class="val time">%s%.0f',
+                               !!$_->{base} && '<span class="unit-composed">+</span>',
+                               $_->{build} || '0',
+                       ),
+                       !$suitchar ? '<td>' : sprintf('<td class="unit unit-%s">%s%s',
+                               $suitchar, ucfirst $suitchar,
+                               $_->{attr}->{massive}
+                                       && '<span class="unit-massive" title="massive">⚓</span>',
+                       ),
+                       '<td class="val unit">' . (
+                               defined $_->{unit} && $_->{unit} == .5 ? '½' : $_->{unit}
+                       ),
+                       '<td class="unit unit-type">' . join('', grep { $_ }
+                               (defined $_->{organic} ? !$_->{organic} : $_->{attr}->{mech})
+                                       && '<span class="unit-u" title="mechanic">m</span>',
+                               ($_->{organic} || $_->{attr}->{organic})
+                                       && '<span class="unit-o" title="organic">o</span>',
+                               $_->{attr}->{psionic}
+                                       && '<span class="unit-p" title="psionic">ψ</span>',
+                       ),
+                       '<td class="unit unit-attr">' . join('', grep { $_ }
+                               $_->{attr}->{armored}
+                                       && '<span class="unit unit-l" title="armored">A</span>',
+                               $_->{attr}->{light}
+                                       && '<span class="unit unit-s" title="light">L</span>',
+                       ),
+                       '<td class="val unit-hp">' . $_->{hp} // '',
+                       $_->{shield} ? sprintf('<td class="val unit-shield">%.0f%%<td',
+                               100 * $_->{shield} / $_->{hp}
+                       ) : '<td colspan=2',
+                       ' class="val unit-armor">' .
+                               showrange($_->{armor}, $_->{upgraded}->{armor}),
+                       showattack($_, 0),
+                       '<td class="val unit-range">' .
+                               showrange(map { $_->{attack}->[0]->{range} } $_, $_->{upgraded}),
+                       '<td class="val unit-sight">' . sprintf(
+                               $_->{detect} ? '<strong class="unit-detect">%s</strong>' : '%s',
+                               showrange($_->{sight}, $_->{upgraded}->{sight})
+                       ),
+                       '<td class="val unit-speed">' .
+                               showrange($_->{speed}, $_->{upgraded}->{speed}),
+                       $_->{attr}->{jump}
+                               && qq'<span class="unit unit-jump" title="$_->{attr}->{jump}">↕</span>',
+                       $_->{attr}->{flying}
+                               && qq'<span class="unit unit-jump" title="flying">↑</span>',
+                       '<td class="unit-magic">' . showmagic($_),
+                       !$_->{attack}->[1] ? () : (
+                               '<tr><td colspan=12>', showattack($_, 1), '<td colspan=4>'
+                       ),
+                       "\n"
+               );
        }
 
-       my $units = do 'sc-units.inc.pl';
-       die "Cannot open unit data: $_\n" for $@ || $! || ();
-       my $grouped = !exists $get{order};
+       my $grouped = 1;  # race headers
        if (exists $get{order}) {
+               $grouped = 0;
                $get{order} ||= '';
                if ($get{order} eq 'size') {
                        $_->{order} = $_->{unit}*8 + $_->{suit} + $_->{hp}/512 + $_->{min}/8192 for @$units;
@@ -261,66 +265,32 @@ sub showrange {
                        $units->[$_]->{order} = $_ for 0 .. $#$units;
                }
        }
-       my @rows = $grouped ? @$units : sort {$a->{order} <=> $b->{order}} @$units;
+       my @rows = @{$units};
+       @rows = sort {$a->{order} <=> $b->{order}} @rows unless $grouped;
 
        my ($race, $cat) = ('', '');
        for (@rows) {
-               $race = $_->{race},
-               printf '<tbody id="%s"><tr class="race"><th colspan="18"><h2>%s</h2>'."\n", $race, ucfirst $race
-                       if $grouped and $race ne $_->{race};
-               $_->{cat} = $_->{race} if not $grouped;
-               $_->{hp} += $_->{shield};
-               my $suitchar = [qw/? s m l/]->[$_->{suit}];
+               if ($grouped) {
+                       printf '<tbody id="%s"><tr class="race"><th colspan="20"><h2>%s</h2>'."\n",
+                               $race = $_->{race}, ucfirst $race
+                                       unless $race eq $_->{race};
+               }
+               else {
+                       $_->{cat} = $_->{race};
+               }
+
                print(
                        '<tr>',
-                       sprintf('<t%s class="cat">%s', $cat ne $_->{cat} ? ('h', $cat = $_->{cat}) : ('d', '&nbsp;')),
-                       '<td>' . $_->{name},
-                       '<td class="val min">' . ($_->{min} || '0'),
-                       '<td class="val gas">' . ($_->{gas} || ''),
-                       sprintf('<td class="val time">%s%.0f',
-                               !!$_->{base} && '<span class="unit-composed">+</span>',
-                               $_->{build} || '0',
-                       ),
-                       sprintf('<td class="unit unit-%s">%s', $suitchar, ucfirst $suitchar),
-                       '<td class="val unit">' . join('',
-                               $_->{unit} ? $_->{unit} == .5 ? '½' : $_->{unit} : '&nbsp;',
-                               defined $_->{organic} && sprintf(
-                                       '<span class="unit-%s" title="%s">%s</span>',
-                                       $_->{organic} ? 'o' : 'u',
-                                       $_->{organic} ? 'organic' : 'mechanic',
-                                       $_->{organic} ? 'o' : 'm',
-                               ),
-                       ),
-                       '<td class="val unit-hp">' . $_->{hp},
-                       '<td class="val unit-shield">' . (
-                               $_->{shield} ? sprintf('%.0f%%', 100 * $_->{shield} / $_->{hp}) : '&nbsp;'
-                       ),
-                       '<td class="val unit-armor">' . showrange($_, 'armor'),
-                       showattack($_, 'ground'),
-                       showattack($_, 'air'),
-                       '<td class="val unit-range">' . showrange($_, 'attack', 'range'),
-                       '<td class="val unit-sight">' . sprintf(
-                               $_->{detect} ? '<strong class="unit-detect">%s</strong>' : '%s',
-                               showrange($_, 'sight')
-                       ),
-                       '<td class="val unit-speed">' . showrange($_, 'speed'),
-                       '<td class="unit-magic">' . showmagic($_),
-                       "\n"
+                       '<th class="cat">', $cat ne $_->{cat} && ($cat = $_->{cat}),
+                       '<td>', $_->{name},
+                       showunitcols($_),
                );
 
-               for my $alt (grep { $_->{alt} } @{ $_->{special} }) {
+               for my $subrow (@{ $_->{special} }) {
+                       $subrow->{alt} or next;
                        print(
-                               '<tr class="alt"><td class="cat"><td colspan="9">' . $alt->{alt},
-                               showattack($alt, 'ground'),
-                               showattack($alt, 'air'),
-                               '<td class="val unit-range">' . showrange($alt, 'attack', 'range'),
-                               '<td class="val unit-sight">' . sprintf(
-                                       $alt->{detect} ? '<strong class="unit-detect">%s</strong>' : '%s',
-                                       showrange($alt, 'sight')
-                               ),
-                               '<td class="val unit-speed">' . showrange($alt, 'speed'),
-                               '<td>',
-                               "\n",
+                               '<tr class="alt"><th class="cat"><td>', $subrow->{alt},
+                               showunitcols($subrow),
                        );
                }
        }
@@ -339,11 +309,32 @@ sub showrange {
        <dd>excludes construction of dependencies such as buildings
                and <span class="unit-composed">+</span>parent units
 <dt>size
-       <dd>affected by <span class="unit unit-s">S</span>mall,
-               <span class="unit unit-m">M</span>edium,
-               or <span class="unit unit-l">L</span>arge unit damage
+       <dd><:
+if ($scver{major} > 1) {
+               :>transports can fit 8 <span class="unit unit-s">S</span>mall,
+               4 <span class="unit unit-m">M</span>edium,
+               2 <span class="unit unit-l">L</span>arge,
+               or a single <span class="unit unit-h">H</span>uge unit
+       <dd>massive <span class="unit-massive">⚓</span> units
+               cannot be lifted or slowed and can break force fields<:
+} else {
+               :>affected by <span class="unit unit-s">S</span>mall,
+               <span class="unit unit-m">M</span>edium, or
+               <span class="unit unit-l">L</span>arge unit damage<:
+} :>
        <dd>number of command points taken per unit
-       <dd><span class="unit unit-o">o</span>rganic/<span class="unit unit-u">m</span>echanic unit
+       <dd><:
+if ($scver{major} > 1) {
+               :>received damage depends on
+               <span class="unit unit-o">o</span>rganic,
+               <span class="unit unit-u">m</span>echanic,
+               <span class="unit unit-p">ψ</span>(ps)ionic,
+               <span class="unit unit-s">L</span>ight, and
+               <span class="unit unit-l">A</span>rmored
+               attributes<:
+} else {
+               :><span class="unit unit-o">o</span>rganic/<span class="unit unit-u">m</span>echanic unit<:
+} :>
 <dt>HP<dd>
        total number of hitpoints (including shields)
 <dt>shield
@@ -354,16 +345,19 @@ sub showrange {
        <dd>base unit armor
        <dd>can be increased by upto 3 at various facilities
        <dd>each point decreases damage per hit by one, upto a minimum of ½
-       <dd>reduction applies to initial damage, before size penalties <small>(so a plasma hit of 12 to 4 armor large deals 2 damage, not ½)</small>
-<dt>ground/air
-       <dd>damage done per single attack against ground/air units
-       <dd>2nd column indicates relative amount of damage done in
-               <span title="the time in which a dragoon fires a shot">a certain
-               amount</span> of time
-       <dd>splash damage<span class="unit-splash">+</span> hits nearby objects as well
-       <dd><span class="hurt unit-l">explosive</span> damage does only
+       <dd>reduction applies to initial damage, before size penalties
+               <small>(so a plasma hit of 12 to 4 armor large deals 2 damage, not ½)</small>
+<dt>attack
+       <dd>targets <span class="hurt-g">▽</span>&nbsp;ground
+               and/or  <span class="hurt-a">△</span>&nbsp;air
+       <dd>damage given per single hit
+       <dd><em>dps</em> indicates relative amount of damage done in
+               1 second of in-game time
+       <dd>splash damage hits all objects nearby <span class="unit-splash">+</span>
+               or in a straight line <span class="unit-splash">×</span>.
+       <dd><span class="unit-l">*</span>explosive damage does only
                50% damage to small units, 75% to medium, 100% to large
-       <dd><span class="hurt unit-s">concussive/plasma</span> damage does
+       <dd><span class="unit-s">~</span>concussive/plasma damage does
                25% to large, 50% medium, 100% to small units
 <dt>sight
        <dd>range in which the unit detects other units
@@ -373,7 +367,7 @@ sub showrange {
 <dt>speed
        <dd>relative speed of movement (when in full motion, startup speed ignored)
 <dt>specials
-       <dd>special abilities
+       <dd>special abilities are usually casted manually, but some are <span class="magic-perma">always active</span>
        <dd>parentheses () indicate that it needs to be researched first
        <dd>hover for description
        <dd>range is maximum range required to activate