Synergies

Synergies are used to convey hint text regarding talent rank or equipment interaction. They are available on Talent Ranks, Frame Traits, Core Systems, and Equipment as an array of ISynergyData

"synergies": ISynergyData[]

The ISynergyData object contains two mandatory and three optional fields. Location and detail - are mandatory and contain the display location for the synergy hint (see below) and the text (detail) of the synergy hint. weapon_types and weapon_sizes are optional filters for displaying synergies on weapons, and take WeaponType and WeaponSize enum values, respectively. Omitting these fields on weapons will cause them to be set to any -- useful if you are looking for a synergy hint on eg. a Melee weapon of any size, or a Superheavy weapon of any type. Similarly system_types will filter system synergy hints to a specific type (eg. Drone) and will appear on all Systems if omitted (set to any).

{
  "locations": string[] // see below,
  "detail": string // v-html
  "weapon_types"?: WeaponType[]
  "system_types"?: SystemType[]
  "weapon_sizes"?: WeaponSize[]
}

COMP/CON Conventions

Synergies should be supplied for:

• Special rules that only apply within a specific context (eg. "This effect only applies when using Melee weapons")
• Interactions between multiple items (eg. "If you have both X and Y equipped, you gain Z effect")
• Rules hints that are not mechanically enforced by COMP/CON but are important for players to know (eg. "When you overcharge, you take 1 stress")

Synergies should not be supplied for:

• Rules that are otherwise represented in COMP/CON (eg. "This weapon deals 2d6 extra damage on hit" should be represented in the weapon's damage field, not as a synergy)
• Rules that are universally applicable and do not depend on context (eg. "You can only boost once per turn" should be represented in the core rules, not as a synergy)
• Rules that are already represented by the item's other fields, such as Actions or Active Effects.
• Bonuses that are already represented in the item's Bonuses field.

In general, always prefer to represent a rule or effect using the appropriate COMP/CON data structure (fields, actions, active effects, etc.) before resorting to synergies. Synergies should be used as a last resort for conveying important context-specific information that cannot be otherwise represented.

Synergy Locations

The following is a list of currently implemented synergy hint locations and their ID strings. To appear, a synergy must take at least one of these location IDs:

ID	Location
rest	A panel near the top of the Active Mode:Rest view
weapon	The body of the equipped weapon item panel in a loadout, as well as in the Skirmish/Barrage action modals
system	The body of the equipped system item panel in a loadout, as well as in the Activation Action modals
deployable	Deployment action for deployable, deployable panel body
drone	Deployment action for drone, drone panel body
move	Next to the move pip bar, also within the Move menu/move Action tab
boost	Next to the Boost button, within the Boost Action modal
structure	Next to the structure pip tracker in the Active Mode: Combat view
armor	Next to the armor pip tracker in the Active Mode: Combat view
hp	Next to the HP pip tracker in the Active Mode: Combat view
overshield	Next to the overshield pip tracker in the Active Mode: Combat view
stress	Next to the reactor stress pip tracker in the Active Mode: Combat view
heat	Next to the heat pip tracker in the Active Mode: Combat view
repair	Next to the repair capacity pip tracker in the Active Mode: Combat view
core_power	Next to the CORE power pip tracker in the Active Mode: Combat view
overcharge	Next to the overcharge pip tracker in the Active Mode: Combat view
action_X	Modal for action ID X
hull	mouseover tooltip for HULL stat
agility	mouseover tooltip for AGILITY stat
systems	mouseover tooltip for SYSTEMS stat
engineering	mouseover tooltip for ENGINEERING stat
pilot_weapon	Pilot Weapon panel and action modal
cascade	Cascade warning panel