getBurnTime()

(info) Other great resources: Official JS API docs, Scripting Forum

getBurnTime()

Define how long units burn for when they catch fire...

 

Syntax

var time = getBurnTime(player);

Parameters

Parameter

Type

Mandatory

Notes

Game Version

player

Number

The player to inspect.

3.2

Return values

Value

Type

Notes

Game Version

<time>

Number

The player's current burn time setting, in milliseconds.

3.2

<error>

Error

Invalid parameters.

3.2

Example

var time = getBurnTime(me);