/
getBurnDamage()
Other great resources: Official JS API docs, Scripting Forum
getBurnDamage()
- Aubergine
Owned by Aubergine
Get the base damage applied per second to a player's burning objects...
Syntax
amount = getBurnDamage(player);
Parameters
| Parameter | Type | Mandatory | Notes | Game Version |
|---|---|---|---|---|
| player | Number |  | The player who's burn damage setting should be changed. | 3.2 |
Return values
| Value | Type | Notes | Game Version |
|---|---|---|---|
| <amount> | Number | The base amount of damage the player's objects will receive per second when they are on fire. | 3.2 |
| <error> | Error | Invalid parameters. | 3.2 |
Notes
This setting affects the base damage applied per second. Modifiers such as flamer upgrades, etc., will multiply this setting to apply more damage per second.
Thermal armour upgrades reduce the amount of damage an object actually receives.
Example
var amount = getBurnDamage(me);
Availability DEV
Requires:
- Warzone 3.2 or above
Contents
Jump to:
See also
Related articles:
- getBurnTime() – get the current burn time setting for a player
- setBurnTime() – set the amount of time a player's objects burn for when they catch fire
- setBurnDamage() – define the amount of damage a burning object receives
, multiple selections available,