Heroic Lands

Interface VehicleOccupantRow

One row of a vehicle's complement, as the Occupants tab lists it: the stored entry joined to whatever its handle resolves to.

A row is produced for every stored occupant, including one whose actor no longer resolves — a vehicle must be able to show, and remove, someone it can no longer see. Such a row is named by its raw handle and reports isResolved: false.

Deliberately has no leader flag. A vehicle's complement has roles but no single head the way a Cohort has a leader — a ship's master is expressed as a title, not a rank the system tracks.

interface VehicleOccupantRow {
    healthBand: undefined | HealthBand;
    healthBandLabel: undefined | string;
    healthPct: undefined | number;
    img: string;
    isResolved: boolean;
    name: string;
    ref: string;
    role: VehicleOccupantRole;
    roleLabel: string;
    title: null | string;
    uuid: null | string;
}

Properties

healthBand healthBandLabel healthPct img isResolved name ref role roleLabel title uuid

Properties

healthBand

healthBand: undefined | HealthBand

The band healthPct falls in, or undefined.

healthBandLabel

healthBandLabel: undefined | string

Localization key for healthBand, or undefined.

healthPct

healthPct: undefined | number

Health as a whole percentage of maximum, or undefined.

img

img: string

The resolved actor's portrait, or "".

isResolved

isResolved: boolean

Whether the handle resolved to an actor this client can see.

name

name: string

The resolved actor's name, falling back to the raw handle.

ref

ref: string

The stored handle: a system.shortcode, or a UUID for a Token Actor.

role

role: VehicleOccupantRole

This occupant's role aboard.

roleLabel

roleLabel: string

Localization key for role.

title

title: null | string

The occupant's style aboard ("Bosun"), or null.

uuid

uuid: null | string

The resolved actor's UUID, or null when it does not resolve.

Settings

Member Visibility

On This Page

Properties