Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Check state of a specific global property...

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
var result = Define.statusOf(name[, asString]);

Parameters

ParameterTypeMandatoryNotesAPI Version
nameString(tick)The name of the global property to test.1.0
asStringBoolean(error)

Should result be in string format?

  • true– yes, return a string
  • false – no, return a state constant

See "Return values" below for more information.

Default: false

 1.0

Return values

ValueTypeNotesAPI Version
<result>Boolean

The state of the property:

1.0
<string>String

The state of the property as a string – one of:

  • "Missing"
  • "Removed"
  • "Added"
  • "Replaced"
  • "Native"
1.0

Example

Code Block
themeRDark
languagejavascript
titleOutput state of scavengerPlayer property in human readable form...
linenumberstrue
console("scavengerPlayer is "+Define.stateOf("scavengerPlayer", true));

 

 

Div
classbox
Availability
Status
colourGreen
titleStable

Requires:

Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

Define API

Topics:

Child pages (Children Display)
alltrue
depthall
pageDefine API
excerpttrue