Class WaypointLabelOptions

Allows customization of auto-generated waypoint descriptions

Since

1.0.0

Hierarchy

  • WaypointLabelOptions

Constructors

Properties

buildingEntranceName: string = ...

Name used to describe a building entrance. Defaults to "the entrance to the building".

distanceForRoom: number = 20.0

Max distance (in feet) for labeling waypoints as the entrance to a room. Defaults to 20 (feet).

the distance in FEET

doNotDescribeAngleOfImportance: number = 60

Angle used to indicate when a waypoint is considered unimportant, therefore not being described at all. Defaults to 60 (degrees).

elevatorAreaName: string = ...

Name used to describe waypoints immediately adjacent to elevators. Defaults to "elevator area".

elevatorName: string = 'the elevator'

Name used to describe elevators. Defaults to "elevator"

roomEntrancePrefix: string = 'the entrance to the'

Name used to describe the entrance to rooms. Defaults to "the entrance to the".

showDebugInLabels: boolean = false

Enable for debugging. If true, additional debug information will be generated in the labels text.

true if debugging is enabled

stairwellAreaName: string = ...

Name used to describe waypoints immediately adjacent to stairwells. Defaults to "the entrance to the stairwell".

stairwellName: string = 'the stairwell'

Name used to describe stairwells. Defaults to "stairwell".

Generated using TypeDoc