sys Class

Module: _decorator Parent Module: cc

System variables

Index

Properties

• LANGUAGE_ENGLISH String English language code
• LANGUAGE_CHINESE String Chinese language code
• LANGUAGE_FRENCH String French language code
• LANGUAGE_ITALIAN String Italian language code
• LANGUAGE_GERMAN String German language code
• LANGUAGE_SPANISH String Spanish language code
• LANGUAGE_DUTCH String Spanish language code
• LANGUAGE_RUSSIAN String Russian language code
• LANGUAGE_KOREAN String Korean language code
• LANGUAGE_JAPANESE String Japanese language code
• LANGUAGE_HUNGARIAN String Hungarian language code
• LANGUAGE_PORTUGUESE String Portuguese language code
• LANGUAGE_ARABIC String Arabic language code
• LANGUAGE_NORWEGIAN String Norwegian language code
• LANGUAGE_POLISH String Polish language code
• LANGUAGE_TURKISH String Turkish language code
• LANGUAGE_UKRAINIAN String Ukrainian language code
• LANGUAGE_ROMANIAN String Romanian language code
• LANGUAGE_BULGARIAN String Bulgarian language code
• LANGUAGE_UNKNOWN String Unknown language code
• OS_IOS String
• OS_ANDROID String
• OS_WINDOWS String
• OS_MARMALADE String
• OS_LINUX String
• OS_BADA String
• OS_BLACKBERRY String
• OS_OSX String
• OS_WP8 String
• OS_WINRT String
• OS_UNKNOWN String
• UNKNOWN Number
• WIN32 Number
• LINUX Number
• MACOS Number
• ANDROID Number
• IPHONE Number
• IPAD Number
• BLACKBERRY Number
• NACL Number
• EMSCRIPTEN Number
• TIZEN Number
• WINRT Number
• WP8 Number
• MOBILE_BROWSER Number
• DESKTOP_BROWSER Number
• EDITOR_PAGE Number Indicates whether executes in editor's window process (Electron's renderer context)
• EDITOR_CORE Number Indicates whether executes in editor's main process (Electron's browser context)
• WECHAT_GAME Number
• QQ_PLAY Number
• FB_PLAYABLE_ADS Number
• BAIDU_GAME Number
• VIVO_GAME Number
• OPPO_GAME Number
• BROWSER_TYPE_WECHAT String BROWSER_TYPE_WECHAT
• BROWSER_TYPE_WECHAT_GAME String BROWSER_TYPE_WECHAT_GAME
• BROWSER_TYPE_WECHAT_GAME_SUB String BROWSER_TYPE_WECHAT_GAME_SUB
• BROWSER_TYPE_BAIDU_GAME String BROWSER_TYPE_BAIDU_GAME
• BROWSER_TYPE_BAIDU_GAME_SUB String BROWSER_TYPE_BAIDU_GAME_SUB
• BROWSER_TYPE_QQ_PLAY String BROWSER_TYPE_QQ_PLAY
• BROWSER_TYPE_ANDROID String
• BROWSER_TYPE_IE String
• BROWSER_TYPE_QQ String
• BROWSER_TYPE_MOBILE_QQ String
• BROWSER_TYPE_UC String
• BROWSER_TYPE_UCBS String uc third party integration.
• BROWSER_TYPE_360 String
• BROWSER_TYPE_BAIDU_APP String
• BROWSER_TYPE_BAIDU String
• BROWSER_TYPE_MAXTHON String
• BROWSER_TYPE_OPERA String
• BROWSER_TYPE_OUPENG String
• BROWSER_TYPE_MIUI String
• BROWSER_TYPE_FIREFOX String
• BROWSER_TYPE_SAFARI String
• BROWSER_TYPE_CHROME String
• BROWSER_TYPE_LIEBAO String
• BROWSER_TYPE_QZONE String
• BROWSER_TYPE_SOUGOU String
• BROWSER_TYPE_UNKNOWN String
• isNative Boolean Is native ? This is set to be true in jsb auto.
• isBrowser Boolean Is web browser ?
• isMobile Boolean Indicate whether system is mobile system
• platform Number Indicate the running platform
• languageCode String Get current language iso 639-1 code.
• language String Indicate the current language of the running system
• os String Indicate the running os name
• osVersion String Indicate the running os version
• osMainVersion Number Indicate the running os main version
• browserType String Indicate the running browser type
• browserVersion String Indicate the running browser version
• windowPixelResolution Size Indicate the real pixel resolution of the whole game window
• localStorage Object cc.sys.localStorage is a local storage component.
• capabilities Object The capabilities of the current platform

Methods

• getNetworkType Get the network type of current device, return cc.sys.NetworkType.LAN if failure.
• getBatteryLevel Get the battery level of current device, return 1.0 if failure.
• garbageCollect Forces the garbage collection, only available in JSB
• restartVM Restart the JS VM, only available in JSB
• getSafeAreaRect Return the safe area rect.
• isObjectValid In web engine, it will return true if the object exist
• dump Dump system informations
• openURL Open a url in browser
• now Get the number of milliseconds elapsed since 1 January 1970 00:00:00 UTC.

Details

Properties

LANGUAGE_ENGLISH

English language code

LANGUAGE_CHINESE

Chinese language code

LANGUAGE_FRENCH

French language code

LANGUAGE_ITALIAN

Italian language code

LANGUAGE_GERMAN

German language code

LANGUAGE_SPANISH

Spanish language code

LANGUAGE_DUTCH

Spanish language code

LANGUAGE_RUSSIAN

Russian language code

LANGUAGE_KOREAN

Korean language code

LANGUAGE_JAPANESE

Japanese language code

LANGUAGE_HUNGARIAN

Hungarian language code

LANGUAGE_PORTUGUESE

Portuguese language code

LANGUAGE_ARABIC

Arabic language code

LANGUAGE_NORWEGIAN

Norwegian language code

LANGUAGE_POLISH

Polish language code

LANGUAGE_TURKISH

Turkish language code

LANGUAGE_UKRAINIAN

Ukrainian language code

LANGUAGE_ROMANIAN

Romanian language code

LANGUAGE_BULGARIAN

Bulgarian language code

LANGUAGE_UNKNOWN

Unknown language code

OS_IOS

OS_ANDROID

OS_WINDOWS

OS_MARMALADE

OS_LINUX

OS_BADA

OS_BLACKBERRY

OS_OSX

OS_WP8

OS_WINRT

OS_UNKNOWN

UNKNOWN

WIN32

LINUX

MACOS

ANDROID

IPHONE

IPAD

BLACKBERRY

NACL

EMSCRIPTEN

TIZEN

WINRT

WP8

MOBILE_BROWSER

DESKTOP_BROWSER

EDITOR_PAGE

Indicates whether executes in editor's window process (Electron's renderer context)

EDITOR_CORE

Indicates whether executes in editor's main process (Electron's browser context)

WECHAT_GAME

QQ_PLAY

FB_PLAYABLE_ADS

BAIDU_GAME

VIVO_GAME

OPPO_GAME

BROWSER_TYPE_WECHAT

BROWSER_TYPE_WECHAT

BROWSER_TYPE_WECHAT_GAME

BROWSER_TYPE_WECHAT_GAME

BROWSER_TYPE_WECHAT_GAME_SUB

BROWSER_TYPE_WECHAT_GAME_SUB

BROWSER_TYPE_BAIDU_GAME

BROWSER_TYPE_BAIDU_GAME

BROWSER_TYPE_BAIDU_GAME_SUB

BROWSER_TYPE_BAIDU_GAME_SUB

BROWSER_TYPE_QQ_PLAY

BROWSER_TYPE_QQ_PLAY

BROWSER_TYPE_ANDROID

BROWSER_TYPE_IE

BROWSER_TYPE_QQ

BROWSER_TYPE_MOBILE_QQ

BROWSER_TYPE_UC

BROWSER_TYPE_UCBS

uc third party integration.

BROWSER_TYPE_360

BROWSER_TYPE_BAIDU_APP

BROWSER_TYPE_BAIDU

BROWSER_TYPE_MAXTHON

BROWSER_TYPE_OPERA

BROWSER_TYPE_OUPENG

BROWSER_TYPE_MIUI

BROWSER_TYPE_FIREFOX

BROWSER_TYPE_SAFARI

BROWSER_TYPE_CHROME

BROWSER_TYPE_LIEBAO

BROWSER_TYPE_QZONE

BROWSER_TYPE_SOUGOU

BROWSER_TYPE_UNKNOWN

isNative

Is native ? This is set to be true in jsb auto.

isBrowser

Is web browser ?

isMobile

Indicate whether system is mobile system

platform

Indicate the running platform

languageCode

Get current language iso 639-1 code. Examples of valid language codes include "zh-tw", "en", "en-us", "fr", "fr-fr", "es-es", etc. The actual value totally depends on results provided by destination platform.

language

Indicate the current language of the running system

os

Indicate the running os name

osVersion

Indicate the running os version

osMainVersion

Indicate the running os main version

browserType

Indicate the running browser type

browserVersion

Indicate the running browser version

windowPixelResolution

Indicate the real pixel resolution of the whole game window

localStorage

cc.sys.localStorage is a local storage component.

capabilities

The capabilities of the current platform

Methods

getNetworkType

Get the network type of current device, return cc.sys.NetworkType.LAN if failure.

getBatteryLevel

Get the battery level of current device, return 1.0 if failure.

garbageCollect

Forces the garbage collection, only available in JSB

restartVM

Restart the JS VM, only available in JSB

getSafeAreaRect

Return the safe area rect.
only available on the iOS native platform, otherwise it will return a rect with design resolution size.

isObjectValid

Check whether an object is valid, In web engine, it will return true if the object exist In native engine, it will return true if the JS object and the correspond native object are both valid

Parameters

• obj Object

dump

Dump system informations

openURL

Open a url in browser

Parameters

• url String

now

Get the number of milliseconds elapsed since 1 January 1970 00:00:00 UTC.