Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Visualizer

Hierarchy

  • Visualizer

Index

Accessors

Methods

Accessors

Static enabled

  • get enabled(): boolean

Methods

Static barGraph

  • barGraph(progress: number | [number, number], pos: object, width?: number, scale?: number): void

  • Parameters

    • progress: number | [number, number]
    • pos: object
    • Default value width: number = 7
    • Default value scale: number = 1

    Returns void

Static circle

  • circle(pos: RoomPosition, color?: string, opts?: object): RoomVisual

  • Parameters

    • pos: RoomPosition
    • Default value color: string = "red"
    • Default value opts: object = {}

    Returns RoomVisual

Static drawGraphs

  • drawGraphs(): void

Static drawHUD

  • drawHUD(): void

Static drawLayout

  • drawLayout(layout: StructureLayout, anchor: RoomPosition, opts?: object): void

Static drawLogo

  • drawLogo(): void

Static drawNotifications

  • drawNotifications(notificationMessages: string[]): void

Static drawPath

  • drawPath(path: RoomPosition[], style?: PolyStyle): void

Static drawRoads

  • drawRoads(positoins: RoomPosition[]): void

Static drawStructureMap

Static infoBox

  • infoBox(header: string, content: string[] | string[][], pos: object, width: number): number

  • Parameters

    • header: string
    • content: string[] | string[][]
    • pos: object
    • width: number

    Returns number

Static marker

  • marker(pos: RoomPosition, opts?: object): RoomVisual

Static multitext

  • multitext(lines: string[], pos: object): void

Static section

  • section(title: string, pos: object, width: number, height: number): object

Static showInfo

  • showInfo(info: string[], calledFrom: object, opts?: object): RoomVisual

  • Parameters

    • info: string[]
    • calledFrom: object
    • Default value opts: object = {}

    Returns RoomVisual

Static summary

  • summary(): void

Static table

  • table(data: string[][], pos: object): void

Static text

  • text(text: string, pos: object, size?: number, style?: TextStyle): void

  • Parameters

    • text: string
    • pos: object
    • Default value size: number = 1
    • Default value style: TextStyle = {}

    Returns void

Static Private textStyle

  • textStyle(size?: number, style?: TextStyle): Object

  • Parameters

    • Default value size: number = 1
    • Default value style: TextStyle = {}

    Returns Object

Static visuals

  • visuals(): void

Generated using TypeDoc