StarMade Wiki - User contributions [en]

Defense Systems

2017-01-19T02:22:18Z

Jojomo: /* Shield Rules */ Regen under fire percentage was wrong, also made the language of that sentence a little clearer - part 2

{{WIP}}

In [[StarMade]], players will often face a variety of threats to the safety of themselves and their entities (ships, stations, turrets or otherwise). Regardless of whether the attackers are players, NPCs, or both at once, the ways in which a player can ensure their survival are the same. This page details these mechanics by which a player can ensure the safety of their entities.

==Summary==

Here is a brief breakdown of the various mechanics which are relevant to defense.
*'''Shields:''' A regenerating HP pool which absorbs all incoming damage until depleted. When depleted, they enter a brief "outage" phase (wherein they do not recharge) before beginning to regenerate again.
**'''Defensive Ion Effect:''' Decreases damage dealt to shields by up to 60% when active.
*'''Hit Points (HP):''' Every block has a set HP value, representing its own structural integrity. When the HP of a block is reduced to 0, it is destroyed.
*'''Armor:''' A flat percentage value granted to a range of blocks, which reduces damage dealt to that block by the stated percentage. Applied before AHP absorption.
*'''Armor HP (AHP):''' A non-regenerating HP pool which absorbs 50% (without defensive effects) of all damage dealt to any block which contributes to the AHP pool (in short, all tiers of hull and doors). Applied after armor reduction, and stacks multiplicatively with it.
**'''Defensive Piercing Effect:''' Increases the amount of damage absorbed by AHP to a maximum of 75% (from 50%)
**'''Defensive Punch-Through Effect:''' Reduces damage taken by AHP by up to 25%. Does not change amount of damage absorbed, but rather acts as an Armor value for the AHP pool itself.
*'''Structure HP (SHP):''' A non-regenerating HP pool which serves as a measure of an entity's integrity. As it decreases, various penalties are applied to the entity. When it is reduced to 50%, the entity will overheat: this ejects any pilot in its [[Ship Core]] and renders it inoperable. An overheating entity has a countdown, proportional to the entity's size, before it collapses, disappearing altogether. This countdown can be stopped, and the entity rendered operable again, by "rebooting" it.
*'''Turrets:''' Although not exclusively defensive in nature, AI-controlled turrets still play key roles in entity defense:
**Shooting down incoming missiles, neutralizing damage which would otherwise have to be mitigated by shields or armor.
**Allowing heavy, slow-turning ships to apply damage to smaller, more maneuverable vessels.

==Shields==

Shields are the first layer of an entity's defenses. A shield system relies on two blocks: the [[Shield Capacitor]] and the [[Shield-Recharger]]. The capacity of the shield is dependent on the number of Shield Capacitors, and its rate of regeneration is dependent on the number of Shield-Rechargers. While an entity has any shield remaining, it will not take block damage. Once the shield is depleted, it is rendered temporarily vulnerable.

Once a ship's shields have reached 0 HP, they will stop recharging for 10 seconds. After this 10 seconds has elapsed, the shields will begin recharging once more. However, if the ship is still taking damage, it is likely that they will be rapidly depleted again, and another 10 second recovery time will begin, leaving the ship open to continued damage.

Unlike most other ship systems, shield systems require no controller, nor do they have any placement rules which affect efficiency. This often serves to make them an ideal filler block, being used in small spaces where other blocks, which require efficient placement, would go to waste. The only design consideration is deciding what values of shield capacity and regeneration are desirable; bearing in mind the power demands the [[Shield-Recharger]]s will make on the ship's [[Power_Systems|power system]].

The strength of a shield can be increased using the [[Ion Effect Computer|Ion Effect system]]: this will reduce damage taken by shields by up to 60%, effectively functioning as an Armor value for shields. This is explained in more detail in the [[#Defensive Effects|Defensive Effects]] section below.

===Shield Rules===
{| class="wikitable"
|-
! '''LEGEND'''
|-
| '''C''' || Shield Capacity
|-
| '''NC''' || Number of Shield Capacitators
|-
| '''NR''' || Number of Shield-Rechargers
|-
| '''R''' || Shield Regeneration per Second
|-
| '''S''' || Current amount of shields
|-
| '''P''' || Power Usage
|}

The exact capacity, regeneration, and power consumption of a shield system can be calculated by using a few different formulas.
Any decimal results produced by these formulas should be rounded down to the nearest whole number.

The shield capacity, '''C''', of a ship with '''NC''' number of [[Shield Capacitor]]s, can be found by the formula: 
<tt style="font-size: large">'''C''' = '''NC'''0.9791797578 * '''110''' + '''220'''</tt>.

The shield regeneration per second, '''R''', of a ship with '''NR''' number of [[Shield-Recharger]]s, can be found by the formula: 
<tt style="font-size: large">'''R''' = '''NR''' * '''5.5'''</tt>

Upon taking a hit, the shield regeneration per second drops to 
<tt style="font-size: large">'''R''' = '''NR''' * '''5.5''' * '''0.25''' * ('''1''' - '''0.5''' * '''S''' / '''C''')</tt> 
for one minute, where '''S''' is the current amount of remaining shields (effectively reducing the shield regeneration to 12.5% when shields are at max capacity, increasing as shield levels drop, reaching 25% when your ship's shields are depleted)

The power usage per second, '''P''', for a given number of [[Shield-Recharger]]s changes depending on whether or not the ship's shields are fully charged.

If the shields are fully charged: 
<tt style="font-size: large">'''P''' = '''R''' </tt>

If the shields are not fully charged: 
<tt style="font-size: large">'''P''' = '''10''' * '''R''' </tt>

==Armor==
All blocks have an armor value, although in the majority of cases it is 0%. Non-0% armor values decrease damage dealt to that block by the given percentage. For example, consider a 400-damage cannon projectile striking a block of Advanced Armor (250HP, 75% armor reduction). 400 reduced by 75% is 100, and so the Advanced Armor block takes only 100HP of damage.

==Hit Points==
All blocks also have a Hit Points (HP) value, representative of that block's durability and integrity (stronger blocks, like armor, have higher HP). When the HP of a block reaches 0, it is destroyed.

Damaged blocks can be repaired by [[Astrotech Computer|Astrotech Beams]]. This is not common practice, however, as most significant battle damage destroys blocks altogether. Furthermore, the amount of effort required (piloting a repair vessel and firing at every damaged block) is not proportional to the reward received (minor cosmetic repairs, with no effect on missile craters or other significant damage).

As the HP of a block decreases, it appears progressively more dented and darkened, with almost-broken blocks approaching black in colouration and being very visibly crumpled. Destroyed blocks break into fragments which will bounce around for a duration before disappearing altogether.

As well as individual block HP, entities have two overall HP pools: Structure HP and Armor HP, both of which are detailed below.

===Structure HP===
Structure HP, abbreviated to "SHP", is a measure of the overall structural integrity of a ship. Its maximum value is the sum of each block in the ship's individual SHP contribution: systems blocks such as power, shields, and weapons are the primary contributors to the SHP total. Armor and miscellaneous blocks provide very small SHP contributions. Any block that is intangible, or can become intangible (such as door blocks) provide no SHP: this prevents the creation of effectively-invulnerable pools of hitpoints.

SHP, being the measure of a ship's integrity, also defines when it is destroyed. When blocks on a ship are destroyed, the ship loses SHP proportional to both the SHP contribution of the block, and the overall size of the ship (the maximum SHP value remains unchanged, so that how damaged the ship is can be measured). As SHP decreases, various penalties are applied to the ship.

Once SHP has decreased to 50% of its maximum, the ship enters an "overheating" state. When a ship begins overheating, any player who is piloting it, or in a block such as a weapon computer or [[Build Block]], will be ejected: there are no direct penalties to the pilot or crew, but they will likely be threatened by whatever force has overheated their ship. An overheating ship has a countdown, proportional to its size, before it "collapses", disappearing altogether: this countdown can be stopped by [[#Rebooting|rebooting]] the ship. Overheating ships are inoperable, and the core cannot be entered until rebooted.

While a ship's structure HP is at 100%, it can be edited normally, with no negative effect. However, when its SHP is below 100%, it cannot be edited without consequences: removing blocks will only remove their SHP value from the current HP amount, and adding blocks will only add their SHP value to the maximum SHP amount. In this way, any change made to a damaged ship will cause its current SHP% to decrease, eventually causing it to overheat if too many changes are made.

The table below displays the penalties applied to an entity as structure HP decreases. To ensure clarity, the definition of each term is explained beforehand:

*'''SHP %''': When the entity's current SHP % is less than this, the stated penalties are in effect.
*'''Power Recharge''': The percentage, of the normal value, which power regenerates at. Does not have any effect on [[Power Auxiliary|Power Auxiliaries]].
*'''Shield Recharge''': The percentage, of the normal value, which shields regenerate at.
*'''Thrust''': The percentage, of the normal value, which maximum speed is set to (thrust output, power cost, and thrust:mass ratio are seemingly unchanged)
*'''Control Loss''': Makes the entity unresponsive to player input of any sort, besides rebooting. Particularly harmful if the ship is part-way through a rotation, as the pilot will be unable to stop the rotation.

{|class="wikitable"
|+SHP Damage Penalties
|-
!SHP %
!Power Recharge
!Shield Recharge
!Thrust
!Control Loss
!Overheating
|-
|90%
|90%
|90%
|90%
|No
|No
|-
|80%
|80%
|80%
|80%
|No
|No
|-
|70%
|70%
|70%
|70%
|No
|No
|-
|60%
|50%
|50%
|50%
|No
|No
|- style="background-color:#e69500"
|55%
|50%
|50%
|50%
|Yes
|No
|- style="background-color:#e60000"
|50%
|0%
|0%
|50%
|Yes
|Yes
|}
===Armor HP===
Armor HP, abbreviated AHP, is a damage mitigation pool which applies only to armored blocks. As with SHP, its maximum value is the sum of individual blocks' AHP values. Comparatively few blocks contribute to AHP: Only door blocks (Glass Doors, Plex Doors, Blast Doors, and Forcefields) and all types of hull/armor (Basic, Standard, Advanced and Crystal). AHP absorbs 50% of damage dealt to any block which contributes to the AHP pool; this absorption takes place after per-block armor reduction. Note that AHP will only apply its absorption to blocks which have an AHP value themselves, and will not affect damage dealt to systems such as power or shields.

For example, consider a 400-damage cannon projectile striking a block of Advanced Armor (as mentioned in the Armor section), but this time factoring in AHP as well. The Advanced Armor block reduces the 400 damage by 75%, to 100 damage, but this is not actually dealt to the block yet. Armor HP absorbs 50% of this reduced amount, and so 50 damage is dealt to the Advanced Armor block, with the other 50 damage being taken by the AHP pool instead.

The amount which armor HP absorbs can be increased by using the Piercing Effect defensively, and Punch-Through Effect will reduce the damage taken by the AHP pool, effectively negating up to 25% of all damage which it absorbs. These are explained in more detail in the [[#Defensive Effects|Defensive Effects]] section.

Because AHP takes damage based on incoming damage, ''not'' block destruction (Like SHP), it can often be depleted far in advance of all armor blocks on a ship being destroyed. When AHP reaches 0, it will no longer be able to absorb any of the damage dealt to armor blocks.

===Effective HP===
An important concept to understand, when designing a ship's defenses, is that of Effective HP (EHP). This is the amount of damage it takes to destroy a block, accounting for armor and armor HP reductions. For a given block, its EHP can be found by the following formula. ''Note that percentages should be expressed as their decimal forms, in order to produce correct results. Armor HP reduction is 50% (0.5) by default, and reaches a maximum of 75% (0.75) with 25% Piercing Effect.''

<big>'''EHP''' = '''BlockHP''' / ( '''1''' - '''Armor%''' ) / ( '''0.5''' - '''Piercing%''' )</big>

The table below lists effective HP values for hull, standard armor and advanced armor. EHP values are displayed for 3 distinct states of damage reduction: AHP+25% Piercing Effect, AHP, and no AHP.

{|class="wikitable"
|+ Armor EHP
! Armor Tier !! AHP+Piercing !! AHP Only !! No AHP
|-
| [[:Category:Hull|Hull]] ||style="text-align:right"| 300 ||style="text-align:right"| 150 ||style="text-align:right"| 75
|-
| [[:Category:Standard|Standard Armor]] ||style="text-align:right"| 1,000 ||style="text-align:right"| 500 ||style="text-align:right"| 250
|-
| [[:Category:Advanced|Advanced Armor]] ||style="text-align:right"| 4,000 ||style="text-align:right"| 2,000 ||style="text-align:right"| 1,000
|}

A simple [https://www.desmos.com/calculator/scuhccyzn5 Desmos graph] displays the change in an armor block's EHP as Piercing Effect is added to AHP absorption.

===Rebooting===
A ship can be "rebooted" to reset its current SHP to 100%, also stopping it from overheating, if it currently is. Specifically, this sets the maximum SHP value of the ship to the sum of every remaining block's SHP value. Rebooting is accomplished by pressing {{K|Reboot}}, if in the ship, or simply activating the core by pressing {{K|Activate module}}. Rebooting takes a minimum of 30 seconds, with larger ships taking proportionally longer to reboot.

The formula below is believed to accurately express the reboot time, in seconds, of a given ship. This value is partially dependent on the current SHP, as a percentage, of the ship being rebooted. Mass is the most significant driver of reboot time, and very large ships can take exceedingly long periods to reboot.

<big>'''RebootTime''' = '''40''' - '''CurrentSHP%''' * '''10''' + '''ShipMass''' * '''0.0002'''</big>

Note that rebooting a ship will not reset its AHP value. AHP must be repaired at any station with shop capabilities; this includes player-made stations with [[Shop Module|Shop Modules]]. Repairs cost 1 credit per AHP repaired.

==Turrets==
Any entity can have turrets docked to it; separate entities which rotate freely about a [[Rail Turret Axis]], usually working in pairs to provide both axes of motion. Although not exclusively a defensive weapon, turrets play some key roles in defending an entity, both in shooting down missiles, and in protecting large, lumbering ships from more nimble harrassers.

===Anti-Missile===
The foremost defensive use of turrets is in shooting down enemy missiles, readily negating often significant amounts of potential damage. Turrets used for this purpose are referred to as point-defense (PD), point-defense turrets (PDT), or sometimes anti-missile turrets (AMT). The term CIWS (Close-In Weapon System) also sees some use, as this is the real-world equivalent of such systems.

For a turret to shoot down missiles, it must be equipped with [[Cannon Computer|cannons]]: these are the only type of weapon which can damage missiles. Missiles have only 1 HP, and are therefore destroyed by any hit. Although a player operating a point-defense turret is technically possible, it is not advisable, as missiles do not have navigation markers, and players cannot reasonably match the rate at which AI can track and destroy them. Therefore, a point defense turret should also be equipped with a [[BOBBY AI Module]] set to behave as a turret, and ordered to target missiles in particular.

The weapons utilized by a point-defense turret have a few peculiarities, due to their specialized role. First and foremost, one must note that all [[Effects|tertiary effects]] are of no use on a point-defense turret: all it needs to do is deal 1 damage to each missile, and every tertiary effect simply modifies the effect of a weapon's damage, which is redundant when the target will die in one hit. As cannons are the only weapon type which can damage missiles, options are somewhat limited. The most important characteristic of a point-defense turret is to produce a great volume of fire, therefore increasing the chance of the turret hitting its target. The preeminent weapon combination, therefore, is cannon/cannon, due to its high rate of fire.

A useful supplementary (but not primary, especially for-point defense) choice of weapon is cannon/missile, owing to its shotgun-like effect (producing a spread of 10 projectiles per firing of the weapon). This spread can prove useful against missile/missile systems (which also launch many projectiles), as the large area of a cannon/missile spread makes them more likely to collide with such clusters of missiles. However, it has a lower rate of fire than cannon/cannon, and, due to its arbitrary and non-centered spread (none of the projectiles fired fire directly forwards), is unsuited for use in most cases, particularly with AI. This is because an AI does not recognize the pattern which cannon/missile fires in, and simply aims as though the projectile will fire directly forwards.

===Anti-Ship===
Turrets are, of course, of particular use in defending slow or stationary targets against faster-moving entities which a large ship cannot neccessarily bring its main guns to bear on. This is a fairly broad topic, of course, and design varies significantly as it is not such a specific role as point-defense. There are no particular specifications to be upheld, as long as the turret is effective within the relevant context.

A designer should, however, pay particular attention to the area which their turrets are able to target, and work to eliminate blind-spots where possible.

==Defensive Effects==

As well as modifying the behavior of weapons systems, [[Effects|effects]] can be used defensively, by simply placing the effect computer in the hotbar, instead of linking it to a weapon. All effects have some use within a defensive context, but the ones highlighted here are of the utmost importance.

[[Ion Effect Computer|Ion Effect]], used defensively, reduces damage dealt to shields by a maximum of 60%. This functions in the same way as Armor values do for blocks: For example, what might normally do 400 damage to a shield will, when reduced by 60% Ion, deal only 160 damage.

[[Piercing Effect Computer|Piercing Effect]], used defensively, increases how much damage the AHP pool of an entity absorbs, by up to 25% (resulting in a total absorption rate of 75%). In the previously-used example of a 400-damage projectile hitting an unshielded block, the 400 damage that might otherwise be dealt to the block is reduced to 100 rather than 200, with AHP taking the remaining 300 damage.

[[Punch-Through Effect Computer|Punch-Through Effect]] reduces the damage taken by the AHP pool when it absorbs damage, by a maximum amount of 25%. This does not affect the rate of absorption, and can be thought of as an Armor or Ion value for the AHP pool itself. Consider the above example: the 300 damage absorbed by Piercing-reinforced AHP is then reduced by 25% before being applied to the AHP pool, resulting in only 225 damage being dealt.

See the [[Effects#Defensive Use|Defensive Use]] section of the Effects page for more information.

[[Category:Ship]]
[[Category:Game Mechanics]]

Defense Systems

2017-01-19T02:19:35Z

Jojomo: /* Shield Rules */ Regen under fire percentage was wrong, also made the language of that sentence a little clearer

{{WIP}}

In [[StarMade]], players will often face a variety of threats to the safety of themselves and their entities (ships, stations, turrets or otherwise). Regardless of whether the attackers are players, NPCs, or both at once, the ways in which a player can ensure their survival are the same. This page details these mechanics by which a player can ensure the safety of their entities.

==Summary==

Here is a brief breakdown of the various mechanics which are relevant to defense.
*'''Shields:''' A regenerating HP pool which absorbs all incoming damage until depleted. When depleted, they enter a brief "outage" phase (wherein they do not recharge) before beginning to regenerate again.
**'''Defensive Ion Effect:''' Decreases damage dealt to shields by up to 60% when active.
*'''Hit Points (HP):''' Every block has a set HP value, representing its own structural integrity. When the HP of a block is reduced to 0, it is destroyed.
*'''Armor:''' A flat percentage value granted to a range of blocks, which reduces damage dealt to that block by the stated percentage. Applied before AHP absorption.
*'''Armor HP (AHP):''' A non-regenerating HP pool which absorbs 50% (without defensive effects) of all damage dealt to any block which contributes to the AHP pool (in short, all tiers of hull and doors). Applied after armor reduction, and stacks multiplicatively with it.
**'''Defensive Piercing Effect:''' Increases the amount of damage absorbed by AHP to a maximum of 75% (from 50%)
**'''Defensive Punch-Through Effect:''' Reduces damage taken by AHP by up to 25%. Does not change amount of damage absorbed, but rather acts as an Armor value for the AHP pool itself.
*'''Structure HP (SHP):''' A non-regenerating HP pool which serves as a measure of an entity's integrity. As it decreases, various penalties are applied to the entity. When it is reduced to 50%, the entity will overheat: this ejects any pilot in its [[Ship Core]] and renders it inoperable. An overheating entity has a countdown, proportional to the entity's size, before it collapses, disappearing altogether. This countdown can be stopped, and the entity rendered operable again, by "rebooting" it.
*'''Turrets:''' Although not exclusively defensive in nature, AI-controlled turrets still play key roles in entity defense:
**Shooting down incoming missiles, neutralizing damage which would otherwise have to be mitigated by shields or armor.
**Allowing heavy, slow-turning ships to apply damage to smaller, more maneuverable vessels.

==Shields==

Shields are the first layer of an entity's defenses. A shield system relies on two blocks: the [[Shield Capacitor]] and the [[Shield-Recharger]]. The capacity of the shield is dependent on the number of Shield Capacitors, and its rate of regeneration is dependent on the number of Shield-Rechargers. While an entity has any shield remaining, it will not take block damage. Once the shield is depleted, it is rendered temporarily vulnerable.

Once a ship's shields have reached 0 HP, they will stop recharging for 10 seconds. After this 10 seconds has elapsed, the shields will begin recharging once more. However, if the ship is still taking damage, it is likely that they will be rapidly depleted again, and another 10 second recovery time will begin, leaving the ship open to continued damage.

Unlike most other ship systems, shield systems require no controller, nor do they have any placement rules which affect efficiency. This often serves to make them an ideal filler block, being used in small spaces where other blocks, which require efficient placement, would go to waste. The only design consideration is deciding what values of shield capacity and regeneration are desirable; bearing in mind the power demands the [[Shield-Recharger]]s will make on the ship's [[Power_Systems|power system]].

The strength of a shield can be increased using the [[Ion Effect Computer|Ion Effect system]]: this will reduce damage taken by shields by up to 60%, effectively functioning as an Armor value for shields. This is explained in more detail in the [[#Defensive Effects|Defensive Effects]] section below.

===Shield Rules===
{| class="wikitable"
|-
! '''LEGEND'''
|-
| '''C''' || Shield Capacity
|-
| '''NC''' || Number of Shield Capacitators
|-
| '''NR''' || Number of Shield-Rechargers
|-
| '''R''' || Shield Regeneration per Second
|-
| '''S''' || Current amount of shields
|-
| '''P''' || Power Usage
|}

The exact capacity, regeneration, and power consumption of a shield system can be calculated by using a few different formulas.
Any decimal results produced by these formulas should be rounded down to the nearest whole number.

The shield capacity, '''C''', of a ship with '''NC''' number of [[Shield Capacitor]]s, can be found by the formula: 
<tt style="font-size: large">'''C''' = '''NC'''0.9791797578 * '''110''' + '''220'''</tt>.

The shield regeneration per second, '''R''', of a ship with '''NR''' number of [[Shield-Recharger]]s, can be found by the formula: 
<tt style="font-size: large">'''R''' = '''NR''' * '''5.5'''</tt>

Upon taking a hit, the shield regeneration per second drops to 
<tt style="font-size: large">'''R''' = '''NR''' * '''5.5''' * '''0.25''' * ('''1''' - '''0.5''' * '''S''' / '''C''')</tt> 
for one minute, where '''S''' is the current amount of remaining shields (effectively reducing the shield regeneration by 87.5% when shields are at max capacity, to 75% when your ship's shields are depleted)

The power usage per second, '''P''', for a given number of [[Shield-Recharger]]s changes depending on whether or not the ship's shields are fully charged.

If the shields are fully charged: 
<tt style="font-size: large">'''P''' = '''R''' </tt>

If the shields are not fully charged: 
<tt style="font-size: large">'''P''' = '''10''' * '''R''' </tt>

==Armor==
All blocks have an armor value, although in the majority of cases it is 0%. Non-0% armor values decrease damage dealt to that block by the given percentage. For example, consider a 400-damage cannon projectile striking a block of Advanced Armor (250HP, 75% armor reduction). 400 reduced by 75% is 100, and so the Advanced Armor block takes only 100HP of damage.

==Hit Points==
All blocks also have a Hit Points (HP) value, representative of that block's durability and integrity (stronger blocks, like armor, have higher HP). When the HP of a block reaches 0, it is destroyed.

Damaged blocks can be repaired by [[Astrotech Computer|Astrotech Beams]]. This is not common practice, however, as most significant battle damage destroys blocks altogether. Furthermore, the amount of effort required (piloting a repair vessel and firing at every damaged block) is not proportional to the reward received (minor cosmetic repairs, with no effect on missile craters or other significant damage).

As the HP of a block decreases, it appears progressively more dented and darkened, with almost-broken blocks approaching black in colouration and being very visibly crumpled. Destroyed blocks break into fragments which will bounce around for a duration before disappearing altogether.

As well as individual block HP, entities have two overall HP pools: Structure HP and Armor HP, both of which are detailed below.

===Structure HP===
Structure HP, abbreviated to "SHP", is a measure of the overall structural integrity of a ship. Its maximum value is the sum of each block in the ship's individual SHP contribution: systems blocks such as power, shields, and weapons are the primary contributors to the SHP total. Armor and miscellaneous blocks provide very small SHP contributions. Any block that is intangible, or can become intangible (such as door blocks) provide no SHP: this prevents the creation of effectively-invulnerable pools of hitpoints.

SHP, being the measure of a ship's integrity, also defines when it is destroyed. When blocks on a ship are destroyed, the ship loses SHP proportional to both the SHP contribution of the block, and the overall size of the ship (the maximum SHP value remains unchanged, so that how damaged the ship is can be measured). As SHP decreases, various penalties are applied to the ship.

Once SHP has decreased to 50% of its maximum, the ship enters an "overheating" state. When a ship begins overheating, any player who is piloting it, or in a block such as a weapon computer or [[Build Block]], will be ejected: there are no direct penalties to the pilot or crew, but they will likely be threatened by whatever force has overheated their ship. An overheating ship has a countdown, proportional to its size, before it "collapses", disappearing altogether: this countdown can be stopped by [[#Rebooting|rebooting]] the ship. Overheating ships are inoperable, and the core cannot be entered until rebooted.

While a ship's structure HP is at 100%, it can be edited normally, with no negative effect. However, when its SHP is below 100%, it cannot be edited without consequences: removing blocks will only remove their SHP value from the current HP amount, and adding blocks will only add their SHP value to the maximum SHP amount. In this way, any change made to a damaged ship will cause its current SHP% to decrease, eventually causing it to overheat if too many changes are made.

The table below displays the penalties applied to an entity as structure HP decreases. To ensure clarity, the definition of each term is explained beforehand:

*'''SHP %''': When the entity's current SHP % is less than this, the stated penalties are in effect.
*'''Power Recharge''': The percentage, of the normal value, which power regenerates at. Does not have any effect on [[Power Auxiliary|Power Auxiliaries]].
*'''Shield Recharge''': The percentage, of the normal value, which shields regenerate at.
*'''Thrust''': The percentage, of the normal value, which maximum speed is set to (thrust output, power cost, and thrust:mass ratio are seemingly unchanged)
*'''Control Loss''': Makes the entity unresponsive to player input of any sort, besides rebooting. Particularly harmful if the ship is part-way through a rotation, as the pilot will be unable to stop the rotation.

{|class="wikitable"
|+SHP Damage Penalties
|-
!SHP %
!Power Recharge
!Shield Recharge
!Thrust
!Control Loss
!Overheating
|-
|90%
|90%
|90%
|90%
|No
|No
|-
|80%
|80%
|80%
|80%
|No
|No
|-
|70%
|70%
|70%
|70%
|No
|No
|-
|60%
|50%
|50%
|50%
|No
|No
|- style="background-color:#e69500"
|55%
|50%
|50%
|50%
|Yes
|No
|- style="background-color:#e60000"
|50%
|0%
|0%
|50%
|Yes
|Yes
|}
===Armor HP===
Armor HP, abbreviated AHP, is a damage mitigation pool which applies only to armored blocks. As with SHP, its maximum value is the sum of individual blocks' AHP values. Comparatively few blocks contribute to AHP: Only door blocks (Glass Doors, Plex Doors, Blast Doors, and Forcefields) and all types of hull/armor (Basic, Standard, Advanced and Crystal). AHP absorbs 50% of damage dealt to any block which contributes to the AHP pool; this absorption takes place after per-block armor reduction. Note that AHP will only apply its absorption to blocks which have an AHP value themselves, and will not affect damage dealt to systems such as power or shields.

For example, consider a 400-damage cannon projectile striking a block of Advanced Armor (as mentioned in the Armor section), but this time factoring in AHP as well. The Advanced Armor block reduces the 400 damage by 75%, to 100 damage, but this is not actually dealt to the block yet. Armor HP absorbs 50% of this reduced amount, and so 50 damage is dealt to the Advanced Armor block, with the other 50 damage being taken by the AHP pool instead.

The amount which armor HP absorbs can be increased by using the Piercing Effect defensively, and Punch-Through Effect will reduce the damage taken by the AHP pool, effectively negating up to 25% of all damage which it absorbs. These are explained in more detail in the [[#Defensive Effects|Defensive Effects]] section.

Because AHP takes damage based on incoming damage, ''not'' block destruction (Like SHP), it can often be depleted far in advance of all armor blocks on a ship being destroyed. When AHP reaches 0, it will no longer be able to absorb any of the damage dealt to armor blocks.

===Effective HP===
An important concept to understand, when designing a ship's defenses, is that of Effective HP (EHP). This is the amount of damage it takes to destroy a block, accounting for armor and armor HP reductions. For a given block, its EHP can be found by the following formula. ''Note that percentages should be expressed as their decimal forms, in order to produce correct results. Armor HP reduction is 50% (0.5) by default, and reaches a maximum of 75% (0.75) with 25% Piercing Effect.''

<big>'''EHP''' = '''BlockHP''' / ( '''1''' - '''Armor%''' ) / ( '''0.5''' - '''Piercing%''' )</big>

The table below lists effective HP values for hull, standard armor and advanced armor. EHP values are displayed for 3 distinct states of damage reduction: AHP+25% Piercing Effect, AHP, and no AHP.

{|class="wikitable"
|+ Armor EHP
! Armor Tier !! AHP+Piercing !! AHP Only !! No AHP
|-
| [[:Category:Hull|Hull]] ||style="text-align:right"| 300 ||style="text-align:right"| 150 ||style="text-align:right"| 75
|-
| [[:Category:Standard|Standard Armor]] ||style="text-align:right"| 1,000 ||style="text-align:right"| 500 ||style="text-align:right"| 250
|-
| [[:Category:Advanced|Advanced Armor]] ||style="text-align:right"| 4,000 ||style="text-align:right"| 2,000 ||style="text-align:right"| 1,000
|}

A simple [https://www.desmos.com/calculator/scuhccyzn5 Desmos graph] displays the change in an armor block's EHP as Piercing Effect is added to AHP absorption.

===Rebooting===
A ship can be "rebooted" to reset its current SHP to 100%, also stopping it from overheating, if it currently is. Specifically, this sets the maximum SHP value of the ship to the sum of every remaining block's SHP value. Rebooting is accomplished by pressing {{K|Reboot}}, if in the ship, or simply activating the core by pressing {{K|Activate module}}. Rebooting takes a minimum of 30 seconds, with larger ships taking proportionally longer to reboot.

The formula below is believed to accurately express the reboot time, in seconds, of a given ship. This value is partially dependent on the current SHP, as a percentage, of the ship being rebooted. Mass is the most significant driver of reboot time, and very large ships can take exceedingly long periods to reboot.

<big>'''RebootTime''' = '''40''' - '''CurrentSHP%''' * '''10''' + '''ShipMass''' * '''0.0002'''</big>

Note that rebooting a ship will not reset its AHP value. AHP must be repaired at any station with shop capabilities; this includes player-made stations with [[Shop Module|Shop Modules]]. Repairs cost 1 credit per AHP repaired.

==Turrets==
Any entity can have turrets docked to it; separate entities which rotate freely about a [[Rail Turret Axis]], usually working in pairs to provide both axes of motion. Although not exclusively a defensive weapon, turrets play some key roles in defending an entity, both in shooting down missiles, and in protecting large, lumbering ships from more nimble harrassers.

===Anti-Missile===
The foremost defensive use of turrets is in shooting down enemy missiles, readily negating often significant amounts of potential damage. Turrets used for this purpose are referred to as point-defense (PD), point-defense turrets (PDT), or sometimes anti-missile turrets (AMT). The term CIWS (Close-In Weapon System) also sees some use, as this is the real-world equivalent of such systems.

For a turret to shoot down missiles, it must be equipped with [[Cannon Computer|cannons]]: these are the only type of weapon which can damage missiles. Missiles have only 1 HP, and are therefore destroyed by any hit. Although a player operating a point-defense turret is technically possible, it is not advisable, as missiles do not have navigation markers, and players cannot reasonably match the rate at which AI can track and destroy them. Therefore, a point defense turret should also be equipped with a [[BOBBY AI Module]] set to behave as a turret, and ordered to target missiles in particular.

The weapons utilized by a point-defense turret have a few peculiarities, due to their specialized role. First and foremost, one must note that all [[Effects|tertiary effects]] are of no use on a point-defense turret: all it needs to do is deal 1 damage to each missile, and every tertiary effect simply modifies the effect of a weapon's damage, which is redundant when the target will die in one hit. As cannons are the only weapon type which can damage missiles, options are somewhat limited. The most important characteristic of a point-defense turret is to produce a great volume of fire, therefore increasing the chance of the turret hitting its target. The preeminent weapon combination, therefore, is cannon/cannon, due to its high rate of fire.

A useful supplementary (but not primary, especially for-point defense) choice of weapon is cannon/missile, owing to its shotgun-like effect (producing a spread of 10 projectiles per firing of the weapon). This spread can prove useful against missile/missile systems (which also launch many projectiles), as the large area of a cannon/missile spread makes them more likely to collide with such clusters of missiles. However, it has a lower rate of fire than cannon/cannon, and, due to its arbitrary and non-centered spread (none of the projectiles fired fire directly forwards), is unsuited for use in most cases, particularly with AI. This is because an AI does not recognize the pattern which cannon/missile fires in, and simply aims as though the projectile will fire directly forwards.

===Anti-Ship===
Turrets are, of course, of particular use in defending slow or stationary targets against faster-moving entities which a large ship cannot neccessarily bring its main guns to bear on. This is a fairly broad topic, of course, and design varies significantly as it is not such a specific role as point-defense. There are no particular specifications to be upheld, as long as the turret is effective within the relevant context.

A designer should, however, pay particular attention to the area which their turrets are able to target, and work to eliminate blind-spots where possible.

==Defensive Effects==

As well as modifying the behavior of weapons systems, [[Effects|effects]] can be used defensively, by simply placing the effect computer in the hotbar, instead of linking it to a weapon. All effects have some use within a defensive context, but the ones highlighted here are of the utmost importance.

[[Ion Effect Computer|Ion Effect]], used defensively, reduces damage dealt to shields by a maximum of 60%. This functions in the same way as Armor values do for blocks: For example, what might normally do 400 damage to a shield will, when reduced by 60% Ion, deal only 160 damage.

[[Piercing Effect Computer|Piercing Effect]], used defensively, increases how much damage the AHP pool of an entity absorbs, by up to 25% (resulting in a total absorption rate of 75%). In the previously-used example of a 400-damage projectile hitting an unshielded block, the 400 damage that might otherwise be dealt to the block is reduced to 100 rather than 200, with AHP taking the remaining 300 damage.

[[Punch-Through Effect Computer|Punch-Through Effect]] reduces the damage taken by the AHP pool when it absorbs damage, by a maximum amount of 25%. This does not affect the rate of absorption, and can be thought of as an Armor or Ion value for the AHP pool itself. Consider the above example: the 300 damage absorbed by Piercing-reinforced AHP is then reduced by 25% before being applied to the AHP pool, resulting in only 225 damage being dealt.

See the [[Effects#Defensive Use|Defensive Use]] section of the Effects page for more information.

[[Category:Ship]]
[[Category:Game Mechanics]]

Blueprint File Formats

2016-09-10T06:30:04Z

Jojomo: /* smd3.bt */ Size of 'data' array in Region was wrong - it's less than 4096 if 4096 SegmentDatas aren't needed. The size of this array is now calculated automatically.

Below are the details of the blueprint data files. This information is intended for those who are interested in writing external tools to inspect and modify blueprints.

==Versions==
As '''StarMade''' is under active development, file formats and layouts could change with each version. As a result, the information on this page may become inaccurate over time. If you find errors in this information, please provide corrections and note the version and changes in the [[#Changelog|Changelog]] section at the bottom of this page.

==File Layout==
Blueprints are comprised of several files arranged in the blueprints directories in the StarMade installation directory. There are three such directories:
{| class="wikitable"
! Directory !! Purpose
|-
| blueprints || Player-saved blueprints (the local catalog) as well as the initial pirate ship blueprints
|-
| blueprints-default || Also contains pirate blueprints
|-
| blueprints-stations || Station blueprints, organized into directories for each of the NPC factions.
|}

Within each blueprint directory are directories for each ship or station. Within each of those directories are the following files:
{| class="wikitable"
! File Name !! Purpose
|-
| header.smbph || The [[#header|header]] file.
|-
| meta.smbpm || The [[#meta|metadata]] file.
|-
| logic.smbpl || The [[#logic|logic]] file.
|-
| DATA/ || A directory containing the *.smd2 block [[#data|chunk data]] files.
|}

==Header==

The header file describes the following basic bits of information about the blueprint:

; Entity Type : Indicates whether the blueprint is for a Ship, Shop, Space Station, Asteroid or Planet.
; Bounding Box : A pair of three-dimensional coordinates providing the minimum and maximum block coordinates for the blueprint. These are relative to a 0,0,0 base, so the minimum coordinates will be negative and the maximum coordinates will be positive. The size of the blueprint is determined by subtracting the minimum coordinates from the maximum ones in each dimension.
; Element Map: An array of structures describing the number and types of each block in the blueprint.

With the information from the header, it's possible to calculate the size and composition of the blueprint to, for example, produce a list of materials needed for construction or determine if a ship can fit in a particular space.

==Metadata==

The metadata file contains all the other information about a blueprint except for block positions. This includes things like docked turrets, contents of storage boxes on the ship, etc. It is arranged in two sections: docking and Tags.

; Docking : This section contains an array of structures describing the name of the blueprint for the docked entity, its size and position, the docking style and its docked orientation.
; Tags : This is a hierarchical data format which may contain binary information of several types, optionally named. See the file format section for additional details.

The Tags section may be compressed, requiring zlib compression functionality to work with. Each Tag contains the following information:
; Type : The type of data contained in the payload.
; Name (optional): If present this is the name of this tag
; Payload : A variable format data structure which describes one of the following values:
:* Byte (8-bit value)
:* Short (16-bit value)
:* Int (32-bit value)
:* Long (64-bit value)
:* Float (32-bit single-precision value)
:* Double (64-bit double-precision value)
:* Byte Array
:* String (UTF-encoded with a length prefix)
:* Vector3f (a vector of 3 floats)
:* Vector3i (a vector of 3 integers)
:* Vector3b (a vector of 3 bytes)
:* List (A list of Payloads which all contain the same type of data)
:* Structure (A list of Tags of varying types)
:* FactoryId (a 8-bit value used for factory registration)
:* Vector4f (A vector of 4 floats)

==Logic==

The logic file describes all of the [[Linking|linked]] module groups in the ship. It is structured as an array or arrays of block information.

; Controller Map : An array of Controller Entity structures, one for each linked master.
; Controller Entity : Contains the position of the controller (master) block and an array of Controller Group structures describing the master and slaved blocks.
; Controller Group : Contains the type of block and an array of positions of each slaved block of that type

There is a hierarchy of groups, starting with the Controller Entity with controller position 8, 8, 8 (corresponding to the [[Ship Core]]) which will contain a list of Controller Groups containing the master blocks (such as the various computers.) Within each of these groups will be the positions of those master blocks, and those positions will correspond to the Controller Entity positions of the other Entities in the Controller Map.

==Data==

Data files are contained within the DATA directory for a given blueprint. These files contain the actual block data - types, positions and orientations, organized into segments and further organized into regions. Each region will be in its own file named with the following format <blueprintname>.<regionX>.<regionY>.<regionZ>.smd2. For a blueprint called Alpha, the data file for region 0, 0, 0 would be called Alpha.0.0.0.smd2.

The region file contains the following information:
; Segment Index : A 16x16x16 array of segment indexes, pointing to Segment Data in the data array
; Segment Timestamps : A 16x16x16 array of timestamps.
; Segment Data : An array of up to 16x16x16 (4096) entries containing the data pointed to by the Segment Index. Each Segment Data contains the segment timestamp, the segment position within the region, the type of segment and a compressed array of Block Data.
; Block Data : A bit-packed structure describing the block id, orientation, hitpoints and whether the block is active.

===Block Data===
The Block Data structure consists of three bytes which contain a bit-packed representation of each block in the blueprint.

{| class=wikitable
! ||MSB !! colspan=22 | Bit Offsets !! LSB
|-
! Type !! 23 !! 22 !! 21 !! 20 !! 19 !! 18 !! 17 !! 16
! 15 !! 14 !! 13 !! 12 !! 11 !! 10 !! 9 !! 8 !! 7 !! 6 !! 5 !! 4 !! 3 !! 2 !! 1 !! 0
|-
| rowspan=2 | Type 1
| colspan=3 bgcolor=red align=center | Orientation
| bgcolor=teal align=center | Active
| colspan=9 bgcolor=blue align=center | Hit Points
| colspan=12 bgcolor=green align=center | Block ID
|-
| colspan=24 | For blocks with an activation status, like a [[Standard Factory]] or [[Activation Module]] 
|-
| rowspan=2 | Type 2
| colspan=4 bgcolor=red align=center | Orientation
| colspan=9 bgcolor=blue align=center | Hit Points
| colspan=12 bgcolor=green align=center | Block ID
|-
| colspan=24 | For all other blocks except [[Grey Standard Armor Corner|corners]] 
|-
| rowspan=2 | Type 3
| colspan=5 bgcolor=red align=center | Orientation
| colspan=8 bgcolor=blue align=center | Hit Points
| colspan=12 bgcolor=green align=center | Block ID
|-
| colspan=24 | For [[Grey Standard Armor Corner|corner]] blocks 
|}

The Orientation field represents how the block is facing in the blueprint. When all the bits in this field are zero, the block will be in its default orientation. The bits are interpeted as follows - if the bit is not part of the orientation :

{| class=wikitable padding=2
! Type !! colspan=3 | Bits !! Description
|-
| Type1 || 23 || 22 || 21 || The block facing
|-
| rowspan=2 | Type 2 || 23 || 22 || || The axis of rotation.
*00 : +Y
*01 : -Y
*10 : -Z
*11 : +Z
|-
| 21 || 20 || || The amount of clockwise rotation around the axis of rotation, in 90-degree steps
|-
| rowspan=2 | Type 3 || 19 || 23 || 22 || The axis of rotation.
*000 : +Y
*001 : -Y
*010 : -Z
*011 : +Z
*100 : -X
*101 : +X
|-
| 21 || 20 || || The amount of clockwise rotation around the axis of rotation, in 90-degree steps
|}

==Additional Resources==
In order to assist developers, the following files are provided to help understand and work with blueprint files.

===010 Editor===
The following *.bt files are format definitions for the [http://www.sweetscape.com/010editor 010 Hex Editor]. Their format is largely similar to C structures and should be easily translatable to your language of choice.

====smbph.bt====
<pre>
//--------------------------------------
//--- 010 Editor v6.0 Binary Template
//
// File: smbph.bt
// Author: Cliff Hudson
// Revision: 0.1867
// Purpose: StarMade Blueprint Header file
//--------------------------------------

struct Vector3f
{
float x;
float y;
float z;
};

enum <unsigned int> EntityType
{
Ship = 0,
Shop = 1,
SpaceStatiion = 2,
Asteroid = 3,
Planet = 4
};

typedef struct
{
Vector3f min;
Vector3f max;
} BoundingBox;

typedef struct
{
short blockId;
int blockCount;
} Element;

typedef struct
{
int numElements;
Element elements[numElements];
} ElementCountMap;

typedef struct
{
int version;
EntityType entityType;
BoundingBox boundingBox;
ElementCountMap elementCountMap;
} Header;

Header header;
</pre>

====smbpl.bt====
<pre>
//--------------------------------------
//--- 010 Editor v6.0 Binary Template
//
// File: smbpl.bt
// Author: Cliff Hudson
// Revision: 0.1867
// Purpose: StarMade Blueprint Logic file
//--------------------------------------

struct Vector3s
{
short x;
short y;
short z;
};

typedef struct
{
short blockId;
int numBlocks;
Vector3s blockPositions[numBlocks];
} ControllerGroup <optimize=false>;

typedef struct
{
Vector3s controllerPosition;
int numGroups;
ControllerGroup groups[numGroups];
} ControllerEntity <optimize=false>;

typedef struct
{
int version;
int numControllers;
ControllerEntity entities[numControllers];
} ControllerMap <optimize=false>;

ControllerMap controllerMap;
</pre>

====smbpm.bt====
<pre>
//--------------------------------------
//--- 010 Editor v6.0 Binary Template
//
// File: smbpm.bt
// Author: Cliff Hudson
// Revision: 0.1867
// Purpose: StarMade Blueprint Meta file
//--------------------------------------
enum <byte> TagType
{
Finish = 1,
SegManager = 2,
Docking = 3
};

struct TagList;
struct TagStructure;
struct Payload;

typedef struct
{
byte x;
byte y;
byte z;
} Vector3b;

typedef struct
{
int x;
int y;
int z;
} Vector3i;

typedef struct
{
float x;
float y;
float z;
} Vector3f;

typedef struct
{
float x;
float y;
float z;
float w;
} Vector4f;

typedef struct
{
short nameLen;
char name[nameLen];
Vector3i dockingPos;
Vector3f dockingSize;
short dockingStyle;
byte dockingOrientation;
} DockedEntry <optimize=false>;

typedef struct
{
int dockedCount;
DockedEntry dockedEntry[dockedCount];
} DockedBlueprints <optimize=false>;

typedef struct
{
unsigned short stringLen;
char str[stringLen];
} String <optimize=false>;

typedef struct
{
int length;
byte data[length];
} ByteArray <optimize=false>;

typedef struct (byte type)
{
switch(type)
{
case 0:
break;
case 1: // Byte
byte dataByte;
break;
case 2: // Short
short dataShort;
break;
case 3: // Int
int dataInt;
break;
case 4: //Long
int64 dataLong;
break;
case 5: // Float
float dataFloat;
break;
case 6: // Double
double dataDouble;
break;
case 7: // Byte array
ByteArray byteArray;
break;
case 8: // String
String dataString;
break;
case 9: // Float vector
Vector3f floatVector;
break;
case 10: // int vector
Vector3i intVector;
break;
case 11: // Byte vector
Vector3b byteVector;
break;
case 12: // List
TagList list;
break;
case 13: // Struct
TagStructure structure;
break;
case 14: // Factory registration
byte factoryId;
break;
case 15: // Float4 vector
Vector4f float4Vector;
break;
}
} Payload <optimize=false>;

typedef struct
{
byte type;
if(type > 0)
{
String name;
}
if(type != 0)
{
Payload payload(Abs(type));
}
} Tag <optimize=false>;

typedef struct
{
byte listType;
int listLength;
Payload payload(listType)[listLength];
} TagList <optimize=false>;

typedef struct
{
do
{
Tag tag;
}
while(tag.type != 0);
} TagStructure<optimize=false>;

typedef struct
{
short version; // Current unused. If this value is 0x1f8b, then from here
// forward - including these bytes - is a gzip compressed stream
// whose contents follow the same structure as the uncompressed
// version.
Tag tag;
} TagRoot <optimize=false>;

typedef struct
{
unsigned int version;
do
{
byte tagType;
switch(tagType)
{
case Finish:
break;

case SegManager:
TagRoot segmentManager;
return;

case Docking:
DockedBlueprints dockedBlueprints;
break;
}
} while(tagType != Finish);
} Metadata;

Metadata metadata;
</pre>

====smd2.bt====
<pre>
//--------------------------------------
//--- 010 Editor v6.0 Binary Template
//
// File: smd2.bt
// Author: Cliff Hudson
// Revision: 0.1867
// Purpose: Starmade Region Data file
//--------------------------------------

typedef struct
{
BitfieldDisablePadding();
BitfieldLeftToRight();
byte orientation : 3;
byte hitpoints: 8;
byte isActive: 1;
ushort blockId: 12;
} BlockData;

typedef struct
{
int x;
int y;
int z;
} Vector3i;

typedef struct
{
int segmentId;
int segmentSize;
} SegmentIndex;

typedef struct
{
int version;
SegmentIndex indices[16*16*16];
int64 timestamps[16*16*16];
} RegionHeader;

typedef struct
{
// NOTE: This struct will always come out to 5120 bytes total, even if the
// data field ends up being shorter (it will simply be padded out.)
// This allows the SegmentIndex to trivially find the data on disk without
// loading the entire file.
// No longer the newest format, though this format may apply to blueprints with
// an SMD file version of 0.
int64 timestamp;
Vector3i segmentPosition;
int dataLength;
unsigned byte segmentType;
byte data[5120-25]; // zlib compressed array of BlockData
} SegmentDataOld;

typedef struct
{
byte version;
// NOTE: This struct will always come out to 5120 bytes total, even if the
// data field ends up being shorter (it will simply be padded out.)
// This allows the SegmentIndex to trivially find the data on disk without
// loading the entire file.
// Valid as of 0.1867, smd file version 1 (RegionHeader.version).
int64 timestamp;
Vector3i segmentPosition;
unsigned byte dataByte; // If 1, there is valid data here
int compressedSize;
byte data[5120-26]; // zlib compressed array of BlockData
} SegmentData;

typedef struct
{
RegionHeader header;
SegmentData data[4096];
} Region;

Region region;
</pre>

====smd3.bt====
<pre>
//--------------------------------------
//--- 010 Editor v6.0 Binary Template
//
// File: smd3.bt
// Revision: 0.199.159
// Purpose: Starmade Region Data file
//--------------------------------------

typedef struct
{
BitfieldDisablePadding();
BitfieldLeftToRight();
byte orientation : 3;
byte isActive: 1;
byte hitpoints: 9;
ushort blockId: 11;
} BlockData;

typedef struct
{
int32 x;
int32 y;
int32 z;
} Vector3i;

typedef struct
{
int16 segmentId;
int16 segmentSize;
} SegmentIndex;

typedef struct
{
int32 version;
SegmentIndex indices[16*16*16];
} RegionHeader;

typedef struct
{
// NOTE: This struct will always come out to 49152 bytes total, even if the
// data field ends up being shorter (it will simply be padded out.)
// This allows the SegmentIndex to trivially find the data on disk without
// loading the entire file.
byte version;
int64 timestamp;
Vector3i segmentPosition;
unsigned byte dataByte; // If 1, there is valid data here
int compressedSize;
byte data[49152-26]; // zlib compressed array of (32x32x32) BlockData
} SegmentData;

typedef struct
{
RegionHeader header;
SegmentData data[ ( FileSize() - 16388 ) / 49152 ];
} Region;

Region region;
</pre>

==Changelog==
Added SegmentDataOld to smd2 format, reflecting the previous format for block data for this file. It changed somewhere prior to v0.1867, but this is verified correct on 0.1867.
Initial creation for version 0.1867.