Statuses & Conditions - massif-press/lancer-data GitHub Wiki

Overview

Adds additional Statuses and Conditions. These must be stored under a file named statuses.json that contains a single array of status data objects.

Definition

statuses.json

IStatusData: {
  "id": string,
  "name": string,
  "type": "Status" | "Condition",
  "effects": string // v-html
  "terse"?: string, // prefer fewest characters
  "icon_svg"?: string
  "icon_url"?: string
  "exclusive"?: "Mech" | "Pilot",
},

Required Fields

id

Internal identifier. This must be globally unique. See Item ID Guidelines for more information.

name

The display name of the status or condition.

type

This must be either the string Status or Condition, case-sensitive.

effects

Rules text. HTML syntax is allowed.

Optional Fields

terse

A short form of the status or condition name, used in situations where space is limited. Prefer fewest characters.

icon_svg

Raw inline SVG for use as the status icon. SVG data will be purified.

icon_url

A URL to an image to use as the icon for this status or condition.

exclusive

If present, this status or condition can only be applied to either Mechs or Pilots, depending on the value. Must be either the string Mech or Pilot, case-sensitive.

Example

from lancer-data/lib/statuses.json

{
  "id": "shut-down",
  "name": "Shut Down",
  "icon": "shut-down",
  "type": "Status",
  "terse": "While SHUT DOWN, mechs are STUNNED indefinitely.",
  "exclusive": "Mech",
  "effects": "When a mech is SHUT DOWN:<br>• all heat is cleared and the EXPOSED status is removed;<br>• any cascading NHPs are stabilised and no longer cascading;<br>• any statuses and conditions affecting the mech caused by tech actions, such as LOCK ON, immediately end.<br>SHUT DOWN mechs have IMMUNITY to all tech actions and attacks, including any from allied characters.<br>While SHUT DOWN, mechs are STUNNED indefinitely. Nothing can prevent this condition, and it remains until the mech ceases to be SHUT DOWN."
}