RSX Code Reference
    Preparing search index...

    Class MacPlatformInformation

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

    Hierarchy (View Summary)

    Index
    • get defines(): string

      A list of semicolon separated defines injected when compiling scripts.

      Returns string

    • set defines(value: string): void

      Parameters

      • value: string

      Returns void

    • get executableName(): string

      The name of the executable.

      Returns string

    • set executableName(value: string): void

      Parameters

      • value: string

      Returns void

    • get icon(): Texture

      The application and window icon texture.

      Returns Texture

    • set icon(value: Texture): 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: boolean): 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: boolean): 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: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get licenseInformation(): string

      The custom license information for the deployment.

      Returns string

    • set licenseInformation(value: string): void

      Parameters

      • value: string

      Returns void

    • get mainScene(): Scene

      Default scene that is loaded when the application is started.

      Returns Scene

    • set mainScene(value: Scene): void

      Default scene that is loaded when the application is started.

      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: string): void

      Parameters

      • value: string

      Returns void

    • The project logo is used during startup and when the launch options are presented.

      Returns Texture

    • set projectLogo(value: Texture): void

      The project logo is used during startup and when the launch options are presented.

      Parameters

      Returns void

    • get runtimeVersion(): string

      If isStreaming is enabled, the RSX version to target when deploying.

      Returns string

    • set runtimeVersion(value: string): void

      Parameters

      • value: string

      Returns void

    • get showLoadingMessages(): boolean

      If true the application will show launch options upon starting.

      Returns boolean

    • set showLoadingMessages(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • If true the application will show launch options upon starting.

      Returns boolean

    • set showRSXEngineLogo(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get showUserLaunchOptions(): boolean

      If true the application will show launch options upon starting.

      Returns boolean

    • set showUserLaunchOptions(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get titlebarText(): string

      Window title bar text.

      Returns string

    • set titlebarText(value: string): void

      Parameters

      • value: string

      Returns void

    • get version(): string

      The version identifier for the deployment.

      Returns string

    • set version(value: string): 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: number): 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: number): void

      Parameters

      • value: number

      Returns void

    • Copies the settings from the specified object.

      Parameters

      • information: PlatformInformation

      Returns void