View source for Shield Definition

The Shield Definition is used to create a shield which can be used by a [[Add a Player|Player]]. The Shield Definition for the Player is set in the [[Player General Tab|General Tab]].


The Shield Definition list is displayed when you select ''Shield Definition'' on the [[Define Menu|Define Menu]] in the [[Level Editor|Level Editor]].  


[[File:ShieldDefMenu.png|link=]]


Select a definition to edit it or select ''Create New'' to create a new one.  You can also [[File:copybtn.png|link=]] ''Copy'' or [[File:deletebtn.png|link=]] ''Delete'' an existing definition.


Selecting a new or existing definition will open the ''Shield Definition'' window:


{|class="wikitable"
!rowspan="26" style="width:270px;vertical-align:top;" |[[File:ShieldDef.png|link=]]
|style="width:195px;vertical-align:top;" | '''Name'''
|Name of the shield definition
|-
|style="vertical-align:top;" | '''Entity'''	
|Entity item that will displayed when the shield is active.  If no entity is specified then the shield will be invisible.
|-
|style="vertical-align:top;" | '''Scale'''	
|Amount to grow or shrink the shield entity when it is displayed
|-
|style="vertical-align:top;" | '''Rotation'''	
|Rotation to apply to the shield entity when it is displayed
|-
|style="vertical-align:top;" | '''Strength'''	
|Strength of the shield.  If the amount of damage inflicted is greater than the shield strength any remaining damage is inflicted on the player entity.
|-
|style="vertical-align:top;" | '''Always Active?'''	
|Whether the shield is always active or activated with a controller button
|-
|style="vertical-align:top;" | '''Min Active Duration'''	
|Minimum time the shield will remain active if activated by a button press.  If the button is held down for longer than the ''Min Active Duration'' then the shield will be deactivated as soon as the button is released.
|-
|style="vertical-align:top;" | '''Time before Re-use'''	
|Time delay before the shield can be used again
|-
|style="vertical-align:top;" | '''Time to drain power'''	
|Time taken for the shield to lose all its power from full state
|-
|style="vertical-align:top;" | '''Time before restore power'''	
|style="vertical-align:top;" | Time delay before the shield starts to restore its power.
|-
|style="vertical-align:top;" | '''Time to restore to full power'''	
|style="vertical-align:top;" | Time taken for the shield to regain full power from empty
|-
|style="vertical-align:top;" | '''Can the shield be repaired?'''	
|style="vertical-align:top;" | Whether the shield can restore its strength.
|-
|style="vertical-align:top;" | '''Number of Segments'''	
|The shield can be repaired in stages.  If there are two segments, for example, then the shield will repair itself to 50% strength and then wait before restoring the other 50%.
|-
|style="vertical-align:top;" | '''Time before repair'''	
|Set how much time must pass before the shield starts to repair itself.  This timer is reset every time the shield receives damage.
|-
|style="vertical-align:top;" | '''Time to repair full segment'''	
|Time taken to restore a segment (or the full shield if there is only one segment) from 0% strength to 100% strength.
|-
|style="vertical-align:top;" | '''Time before repair next segment'''	
|Time delay between finishing repairing a segment and starting to repair the next segment if there are multiple segments
|-
|style="vertical-align:top;" | '''Reset when lost life?'''	
|Whether the shield will be restored to full strength after losing a life.
|-
|style="vertical-align:top;" | '''Reset on new level?'''	
|Whether the shield will be restored to full strength when starting a new level
|-
|style="vertical-align:top;" | '''Collision Action'''	
|Action the shield will take when it collides with an object - ''Do Nothing'', ''Bounce'', ''Turn 90 degrees'', ''Turn 180 degrees'', ''Turn 270 degrees'', ''Stop''
|-
|style="vertical-align:top;" | '''Shield Active Particle'''	
|[[Particle Editor|Particle system]] to display when the shield is active
|-
|style="vertical-align:top;" | '''Shield Active Sound Cue'''	
|[[Sound Editor#Creating a Sound Cue|Sound Cue]] to play when the shield is active
|-
|style="vertical-align:top;" | '''Shield Damage Particle'''	
|[[Particle Editor|Particle system]] to display when the shield receives damage
|-
|style="vertical-align:top;" | '''Shield Damage Sound Cue'''	
|style="vertical-align:top;" | [[Sound Editor#Creating a Sound Cue|Sound Cue]] to play when the shield receives damage
|-
|style="vertical-align:top;" | '''Shield Repair Particle'''	
|[[Particle Editor|Particle system]] to display when the shield is being repaired
|-
|style="vertical-align:top;" | '''Shield Repair Sound Cue'''	
|[[Sound Editor#Creating a Sound Cue|Sound Cue]] to play when the shield is being repaired
|-
|style="vertical-align:top;" | '''Chip Damage Min & Max'''	
|Amount of damage that will be passed on to the player entity when the shield is hit.  This allows some damage to occur to the player even when the shield is active.  The amount of damage is a random amount between the Min and Max values but no more than the original damage value.
|}