Class MacPlatformInformation

Contains Mac specific per-platform information used primarily for build purposes.

Hierarchy (view full)

Constructors

Accessors

  • get defines(): string
  • A list of semicolon separated defines injected when compiling scripts.

    Returns string

  • set defines(value): void
  • Parameters

    • value: string

    Returns void

  • get executableName(): string
  • The name of the executable.

    Returns string

  • set executableName(value): void
  • Parameters

    • value: string

    Returns void

  • get icon(): Texture
  • The application and window icon texture.

    Returns Texture

  • set icon(value): void
  • The application and window icon texture.

    Parameters

    Returns void

  • get isDebug(): boolean
  • Determines whether the runtime is executed in debug mode (Impacts performance).

    Returns boolean

  • set isDebug(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isFullscreen(): boolean
  • If true the application will be started in fullscreen using user's desktop resolution.

    Returns boolean

  • set isFullscreen(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isStreaming(): boolean
  • If true, the application data will be streamed from a network location. The user will only be able to start the application if connected to the internet. The startup time depends on the user's internet connection. If false, the application data will be stored together with the runtime. The user will be able to start the application without an internet connection.

    Returns boolean

  • set isStreaming(value): void
  • Parameters

    • value: boolean

    Returns void

  • get licenseInformation(): string
  • The custom license information for the deployment.

    Returns string

  • set licenseInformation(value): void
  • Parameters

    • value: string

    Returns void

  • get mainScene(): Scene
  • Default scene that is loaded when the application is started.

    Returns Scene

  • set mainScene(value): void
  • Default scene that is loaded when the application is started.

    Parameters

    Returns void

  • get mainSceneHandle(): ResourceHandle<Scene>
  • Default scene that is loaded when the application is started.

    Returns ResourceHandle<Scene>

  • set mainSceneHandle(value): void
  • Parameters

    Returns void

  • get polyverseLibraryID(): string
  • If isStreaming is enabled, specifies the ID of the Polyverse library to deploy to.

    Returns string

  • set polyverseLibraryID(value): void
  • Parameters

    • value: string

    Returns void

  • get projectLogo(): Texture
  • The project logo is used during startup and when the launch options are presented.

    Returns Texture

  • set projectLogo(value): void
  • The project logo is used during startup and when the launch options are presented.

    Parameters

    Returns void

  • get projectLogoHandle(): ResourceHandle<Texture>
  • The project logo is used during startup and when the launch options are presented.

    Returns ResourceHandle<Texture>

  • set projectLogoHandle(value): void
  • Parameters

    Returns void

  • get runtimeVersion(): string
  • If isStreaming is enabled, the RSX version to target when deploying.

    Returns string

  • set runtimeVersion(value): void
  • Parameters

    • value: string

    Returns void

  • get showLoadingMessages(): boolean
  • If true the application will show launch options upon starting.

    Returns boolean

  • set showLoadingMessages(value): void
  • Parameters

    • value: boolean

    Returns void

  • get showRSXEngineLogo(): boolean
  • If true the application will show launch options upon starting.

    Returns boolean

  • set showRSXEngineLogo(value): void
  • Parameters

    • value: boolean

    Returns void

  • get showUserLaunchOptions(): boolean
  • If true the application will show launch options upon starting.

    Returns boolean

  • set showUserLaunchOptions(value): void
  • Parameters

    • value: boolean

    Returns void

  • get titlebarText(): string
  • Window title bar text.

    Returns string

  • set titlebarText(value): void
  • Parameters

    • value: string

    Returns void

  • get version(): string
  • The version identifier for the deployment.

    Returns string

  • set version(value): void
  • Parameters

    • value: string

    Returns void

  • get windowedHeight(): number
  • Height of the window if not starting the application in fullscreen.

    Returns number

  • set windowedHeight(value): void
  • Parameters

    • value: number

    Returns void

  • get windowedWidth(): number
  • Width of the window if not starting the application in fullscreen.

    Returns number

  • set windowedWidth(value): void
  • Parameters

    • value: number

    Returns void

Methods

  • Copies the settings from the specified object.

    Parameters

    • information: PlatformInformation

    Returns void