Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SystemUtil

A utility class with methods related to the current platform and runtime.

Hierarchy

  • SystemUtil

Index

Properties

Static isAIR

isAIR: boolean

Indicates if the code is executed in an Adobe AIR runtime (true) or Flash plugin/projector (false).

Static isAndroid

isAndroid: boolean

Indicates if the code is executed on an Android device, based on the platform string.

Static isApplicationActive

isApplicationActive: boolean

Indicates if the application is currently active. On Desktop, this means that it has the focus; on mobile, that it is in the foreground. In the Flash Plugin, always returns true.

Static isDesktop

isDesktop: boolean

Indicates if the code is executed on a Desktop computer with Windows, macOS or Linux operating system. If the method returns 'false', it's probably a mobile device or a Smart TV.

Static isIOS

isIOS: boolean

Indicates if the code is executed on an iOS device, based on the platform string.

Static isMac

isMac: boolean

Indicates if the code is executed on a Macintosh, based on the platform string.

Static isWindows

isWindows: boolean

Indicates if the code is executed on Windows, based on the platform string.

Static platform

platform: string

Returns the three-letter platform string of the current system. These are the most common platforms: WIN, MAC, LNX, IOS, AND, QNX. Except for the last one, which indicates "Blackberry", all should be self-explanatory.

Static supportsDepthAndStencil

supportsDepthAndStencil: boolean

Returns the value of the 'initialWindow.depthAndStencil' node of the application descriptor, if this in an AIR app; otherwise always true.

Static supportsVideoTexture

supportsVideoTexture: boolean

Indicates if Context3D supports video textures. At the time of this writing, video textures are only supported on Windows, OS X and iOS, and only in AIR applications (not the Flash Player).

Static version

version: string

Returns the Flash Player/AIR version string. The format of the version number is: majorVersion,minorVersion,buildNumber,internalBuildNumber.

Methods

Static executeWhenApplicationIsActive

  • executeWhenApplicationIsActive(call: Function, args?: Array<any>): void
  • Executes the given with its arguments the next time the application is active. (If it is active already, the call will be executed right away.)

    Parameters

    • call: Function
    • Optional args: Array<any>

    Returns void

Static Protected get_isAIR

  • get_isAIR(): boolean

Static Protected get_isAndroid

  • get_isAndroid(): boolean

Static Protected get_isApplicationActive

  • get_isApplicationActive(): boolean

Static Protected get_isDesktop

  • get_isDesktop(): boolean

Static Protected get_isIOS

  • get_isIOS(): boolean

Static Protected get_isMac

  • get_isMac(): boolean

Static Protected get_isWindows

  • get_isWindows(): boolean

Static Protected get_platform

  • get_platform(): string

Static Protected get_supportsDepthAndStencil

  • get_supportsDepthAndStencil(): boolean

Static Protected get_supportsVideoTexture

  • get_supportsVideoTexture(): boolean

Static Protected get_version

  • get_version(): string

Static initialize

  • initialize(): void
  • Initializes the ACTIVATE/DEACTIVATE event handlers on the native application. This method is automatically called by the Starling constructor.

    Returns void

Static isEmbeddedFont

  • isEmbeddedFont(fontName: string, bold?: boolean, italic?: boolean, fontType?: string): boolean
  • Figures out if an embedded font with the specified style is available. The fonts are enumerated only once; if you load a font at runtime, be sure to call 'updateEmbeddedFonts' before calling this method.

    @param fontName the name of the font @param bold indicates if the font has a bold style @param italic indicates if the font has an italic style @param fontType the type of the font (one of the constants defined in the FontType class)

    Parameters

    • fontName: string
    • Optional bold: boolean
    • Optional italic: boolean
    • Optional fontType: string

    Returns boolean

Static Protected set_platform

  • set_platform(value: string): string

Static updateEmbeddedFonts

  • updateEmbeddedFonts(): void

Generated using TypeDoc