Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Screen

Hierarchy

  • Screen

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

Static AspectRatio

  • get AspectRatio(): number

Static Height

  • get Height(): number

Static Resolution

  • get Resolution(): Size

Static ScaledResolution

  • get ScaledResolution(): Size

Static ScaledWidth

  • get ScaledWidth(): number

Static Width

  • get Width(): number

Methods

Static displayHelpTextThisFrame

  • displayHelpTextThisFrame(message: string): void

Static showAdvancedNotification

  • showAdvancedNotification(message: string, title: string, subtitle: string, iconSet: string, icon: string, bgColor?: HudColor, flashColor?: Color, blinking?: boolean, type?: NotificationType, showInBrief?: boolean, sound?: boolean): Notification

  • Parameters

    • message: string
    • title: string
    • subtitle: string
    • iconSet: string
    • icon: string
    • bgColor: HudColor = HudColor.NONE
    • flashColor: Color = Color.empty
    • blinking: boolean = false
    • type: NotificationType = NotificationType.Default
    • showInBrief: boolean = true
    • sound: boolean = true

    Returns Notification

Static showNotification

  • showNotification(message: string, blinking?: boolean): Notification

Static showSubtitle

  • showSubtitle(message: string, duration?: number): void

  • Parameters

    • message: string
    • duration: number = 2500

    Returns void

Static worldToScreen

  • worldToScreen(position: Vector3, scaleWidth?: boolean): Size

Generated using TypeDoc