Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class VehicleModel

    Vehicle actor data model

    Hierarchy (View Summary)

    Index

    General

    _rollData attributes crew currency details driver material resources squares traits system _onItemReady _prepareDriverData _prepareOverlandSpeeds _updateResources displayDefenseCard getDefenses getMovement getSourceDetails getTotalCurrency prepareBaseData prepareCMB prepareDerivedData rollSave

    Document

    _updateResource

    Extension API

    _finalizeData _prepareChangeFlags _prepareChanges _prepareDependentData _preparePostChanges getChangeTargets getInitiativeOptions getLabels getTokenSize

    General

    _rollData

    _rollData: any
    attributes: {
        ac: {
            normal: { bonus: number };
            stopped: { bonus: number };
            touch: { bonus: number };
        };
        hardness: { base: number; bonus: number };
        hp: { bonus: number; offset: number };
        init: { value: number };
        savingThrows: { save: { base: number } };
    }
    crew: { max: number; passengers: number; value: number }
    currency: Record<CoinType, number>
    details: {
        acceleration: number;
        cost: number;
        currentSpeed: number;
        decks: number;
        description: HTML;
        drivingCheck: FreeText;
        drivingDevice: FreeText;
        drivingSpace: FreeText;
        forwardFacing: FreeText;
        maxSpeed: number;
        notes: HTML;
        propulsion: FreeText;
    }
    driver: {
        skill:
            | "int"
            | "wis"
            | "crf"
            | "acr"
            | "swm"
            | "clm"
            | "fly"
            | "lor"
            | "art"
            | "apr"
            | "blf"
            | "dip"
            | "dev"
            | "dis"
            | "esc"
            | "han"
            | "hea"
            | "kar"
            | "kdu"
            | "ken"
            | "kge"
            | "khi"
            | "klo"
            | "kna"
            | "kno"
            | "kpl"
            | "kre"
            | "lin"
            | "per"
            | "prf"
            | "pro"
            | "rid"
            | "sen"
            | "slt"
            | "spl"
            | "ste"
            | "sur"
            | "umd";
        uuid: UUID;
    }
    material: {
        base: "leather" | "wood" | "stone" | "metal";
        magicallyHardened: boolean;
    }
    resources: any
    squares: number
    traits: { size: "lg" | "huge" | "grg" | "col"; type: "land" | "air" | "sea" }
    • get system(): this

      Returns this

      REMOVE BEFORE RELEASE

    Abstract_onItemReady

    _prepareDriverData

    • _prepareDriverData(): void

      Returns void

    _prepareOverlandSpeeds

    • _prepareOverlandSpeeds(): void
      Internal

      Calculate overland speeds.

      Returns void

    _updateResources

    • _updateResources(error: boolean): void
      Internal

      Parameters

      • error: boolean

      Returns void

    • Show defenses in chat

      Parameters

      • Optionaloptions: { rollMode?: string | null; token?: any } = {}

        Additional options

        • OptionalrollMode?: string | null

          The roll mode to use for the roll; defaults to the user's current preference when null.

        • Optionaltoken?: any

          Relevant token if any.

      Returns Promise<any>

      • Created message

    • Called by ActorPF.getDefenses

      Returns { h: any }

    • Parameters

      • type: any

      Returns { run: boolean; speed: number; step: boolean }

    • Parameters

      • path: any
      • sources: any

      Returns void

    • Parameters

      • __namedParameters: { inLowestDenomination?: boolean } = {}

      Returns number

      • Vehicles don't have weightless currency

    • Returns void

    • Roll a specific saving throw

      Parameters

      • savingThrowId: "fort" | "ref" | "will"

        Identifier for saving throw type.

      • Optionaloptions: ActorRollOptions = {}

        Roll options.

      Returns Promise<any>

      The chat message if one was created, or its data if not. void if the roll was cancelled.

      await actor.system.rollSave("ref", { skipDialog: true, dice: "2d20kh", bonus: "4" });

    Document

    _updateResource

    • _updateResource(
          item: ItemPF<BaseItemModel>,
          options?: { warnOnDuplicate?: boolean },
      ): boolean
      Internal

      Update Item Resource

      Parameters

      • item: ItemPF<BaseItemModel>

        the item to add to the actor's resources

      • Optionaloptions: { warnOnDuplicate?: boolean } = {}

        extra options

        • OptionalwarnOnDuplicate?: boolean

          Skips warning if item tag already exists in dictionary flags

      Returns boolean

      True if resources were set

    Extension API

    Abstract_finalizeData

    • _finalizeData(): void

      Returns void

    Abstract_prepareChangeFlags

    • _prepareChangeFlags(): void

      Prepare actor.changeFlags alterations.

      Returns void

    _prepareChanges

    • _prepareChanges(changes: any): void

      Prepare changes specific to this actor type

      Parameters

      • changes: any

      Returns void

    Abstract_prepareDependentData

    • _prepareDependentData(): void

      Prepare data post embedded documents have been prepared.

      This is before changes and before prepareDerivedData()

      Returns void

    _preparePostChanges

    • _preparePostChanges(): void

      Prepare data post change application.

      This is called inside prepareDerivedData()

      Returns void

    • Custom change targets for this actor type

      Returns string[]

    • Initiative rolling options

      Returns object

    • Generate generic labels.

      Returns object

    Settings

    Member Visibility

    On This Page

    General
    Document
    Extension API