ThemeParks.wiki Parks API - v2.0.0
    Preparing search index...

    Class TagBuilder

    TagBuilder provides a fluent API for creating validated entity tags

    const tags = [
    TagBuilder.fastPass(),
    TagBuilder.minimumHeight(107, 'cm'),
    TagBuilder.location(28.4743, -81.4677),
    ];
    Index

    Constructors

    Methods

    • Create a Location tag

      Location tags mark DISTINCT named sub-points of interest for an entity, such as "Main Entrance", "Exit", "Single Rider Entrance", etc. They are additional to the entity's primary location — never a duplicate of it.

      Do not use this tag to mirror entity.location. The entity's main coordinate belongs in entity.location (populated via mapEntities' locationFields). A LOCATION tag with the same coordinates as the main location adds nothing and should be omitted. If your API only exposes one point per entity, do not emit any LOCATION tag — the primary entity.location is sufficient.

      For standard POIs like baby care centres, first aid, smoking areas, prefer the dedicated TagBuilder.mainEntrance(), TagBuilder.babyCareCenter(), etc. helpers.

      Parameters

      • latitude: number

        Latitude coordinate

      • longitude: number

        Longitude coordinate

      • tagName: string

        Human-readable name for this location (required) - e.g., "Main Entrance", "Exit", "Single Rider Queue"

      • Optionalid: string

        Optional unique identifier

      Returns TagData

      If latitude or longitude are invalid

      If tagName is not provided

      // Correct: distinct sub-locations beyond the primary entity.location
      TagBuilder.location(28.4743, -81.4677, 'Main Entrance')
      TagBuilder.location(28.4744, -81.4678, 'Single Rider Entrance')
      TagBuilder.location(28.4745, -81.4679, 'Exit')

      // Wrong: duplicates entity.location — don't do this
      // TagBuilder.location(ride.lat, ride.lng, ride.name)
    • Create a Maximum Height tag

      Parameters

      • height: number

        The maximum height value

      • unit: "cm" | "in"

        The unit of measurement ('cm' or 'in')

      • OptionaltagName: string

        Optional custom tag name

      • Optionalid: string

        Optional unique identifier

      Returns TagData

      If height or unit are invalid

    • Create a Minimum Height tag

      Parameters

      • height: number

        The minimum height value

      • unit: "cm" | "in"

        The unit of measurement ('cm' or 'in')

      • OptionaltagName: string

        Optional custom tag name

      • Optionalid: string

        Optional unique identifier

      Returns TagData

      If height or unit are invalid

    • Create a Minimum Height (Unaccompanied) tag

      The minimum height for a rider to ride without an accompanying adult. Typically higher than the standard minimum height.

      Parameters

      • height: number

        The minimum unaccompanied height value

      • unit: "cm" | "in"

        The unit of measurement ('cm' or 'in')

      • OptionaltagName: string

        Optional custom tag name

      • Optionalid: string

        Optional unique identifier

      Returns TagData

      If height or unit are invalid

    • Create a Paid Return Time tag (Express Pass, Lightning Lane, etc.)

      Parameters

      • OptionaltagName: string
      • Optionalid: string

      Returns TagData

    • Create an Unsuitable for Pregnant People tag

      Parameters

      • OptionaltagName: string
      • Optionalid: string

      Returns TagData

    • Validate a single tag

      Parameters

      Returns boolean

      True if the tag is valid

      If the tag is invalid

    • Validate an array of tags

      Parameters

      • tags: TagData[]

        The tags to validate

      Returns boolean

      True if all tags are valid

      If any tag is invalid