Heroic Lands

Function blankBodyLocation

  • blankBodyLocation(
        name?: string,
        shortcode?: string,
        bodyPartCode?: string,
    ): sohl.entity.body.BodyLocation.Data

  • Build a blank, schema-valid body location.

    Every field is seeded to the same default the corresponding DataModel schema field (BeingDataModel body.structure.locations[]) initializes to, so the returned object round-trips a Foundry update() into the structure's flat locations array without validation churn. Kept Foundry-free so the sohl.entity.body.BodyLocation editor can seed a valid blank without a live DataModel.

    Parameters

    • name: string = "Location"

      The display name for the new location (defaults to "Location").

    • shortcode: string = ""

      The location's shortcode (defaults to blank; assigned by the caller's add flow).

    • bodyPartCode: string = ""

      Shortcode of the owning part (defaults to blank; stamped by sohl.entity.body.BodyPart.addLocationUpdate).

    Returns sohl.entity.body.BodyLocation.Data

    A fully-populated BodyLocation.Data with default values.

Settings

Member Visibility