Utils.d overview

The static class that defines utility methods.

Table of contents

• utils
  • Utils (class)
    • checkRMVersion (static method)
    • isOptionValid (static method)
    • isNwjs (static method)
    • isMobileDevice (static method)
    • isMobileSafari (static method)
    • isAndroidChrome (static method)
    • isLocal (static method)
    • canUseWebGL (static method)
    • canUseWebAudioAPI (static method)
    • canUseCssFontLoading (static method)
    • canUseIndexedDB (static method)
    • canPlayOgg (static method)
    • canPlayWebm (static method)
    • encodeURI (static method)
    • extractFileName (static method)
    • escapeHtml (static method)
    • containsArabic (static method)
    • setEncryptionInfo (static method)
    • hasEncryptedImages (static method)
    • hasEncryptedAudio (static method)
    • decryptArrayBuffer (static method)

utils

Utils (class)

The static class that defines utility methods.

Signature

export declare class Utils {
  constructor()
}

checkRMVersion (static method)

Checks whether the current RPG Maker version is greater than or equal to the given version.

Signature

static checkRMVersion(version: string): boolean

isOptionValid (static method)

Checks whether the option is in the query string.

Signature

static isOptionValid(name: string): boolean

isNwjs (static method)

Checks whether the platform is NW.js.

Signature

static isNwjs(): boolean

isMobileDevice (static method)

Checks whether the platform is a mobile device.

Signature

static isMobileDevice(): boolean

isMobileSafari (static method)

Checks whether the browser is Mobile Safari.

Signature

static isMobileSafari(): boolean

isAndroidChrome (static method)

Checks whether the browser is Android Chrome.

Signature

static isAndroidChrome(): boolean

isLocal (static method)

Checks whether the browser is accessing local files.

Signature

static isLocal(): boolean

canUseWebGL (static method)

Checks whether the browser supports WebGL.

Signature

static canUseWebGL(): boolean

canUseWebAudioAPI (static method)

Checks whether the browser supports Web Audio API.

Signature

static canUseWebAudioAPI(): boolean

canUseCssFontLoading (static method)

Checks whether the browser supports CSS Font Loading.

Signature

static canUseCssFontLoading(): boolean

canUseIndexedDB (static method)

Checks whether the browser supports IndexedDB.

Signature

static canUseIndexedDB(): boolean

canPlayOgg (static method)

Checks whether the browser can play ogg files.

Signature

static canPlayOgg(): boolean

canPlayWebm (static method)

Checks whether the browser can play webm files.

Signature

static canPlayWebm(): boolean

encodeURI (static method)

Encodes a URI component without escaping slash characters.

Signature

static encodeURI(str: string): string

extractFileName (static method)

Gets the filename that does not include subfolders.

Signature

static extractFileName(filename: string): string

escapeHtml (static method)

Escapes special characters for HTML.

Signature

static escapeHtml(str: string): string

containsArabic (static method)

Checks whether the string contains any Arabic characters.

Signature

static containsArabic(str: string): boolean

setEncryptionInfo (static method)

Sets information related to encryption.

Signature

static setEncryptionInfo(hasImages: boolean, hasAudio: boolean, key: string): void

hasEncryptedImages (static method)

Checks whether the image files in the game are encrypted.

Signature

static hasEncryptedImages(): boolean

hasEncryptedAudio (static method)

Checks whether the audio files in the game are encrypted.

Signature

static hasEncryptedAudio(): boolean

decryptArrayBuffer (static method)

Decrypts encrypted data.

Signature

static decryptArrayBuffer(source: ArrayBuffer): ArrayBuffer