Fire

Defined in: server/api.d.ts:2128

Replicated burning volume that damages players and pedestrians standing in it.

Extends

• Entity

Constructors

Constructor

new Fire(id): Fire

Defined in: server/api.d.ts:2133

Creates a script wrapper for an existing fire with this ID; use Fire.create() to light one.

Parameters

id

number

Network entity identifier.

Returns

Fire

Inherited from

Entity.constructor

Methods

destroy()

destroy(): void

Defined in: server/api.d.ts:2164

Puts this fire out and removes it from every client.

Returns

void

---

setEnabled()

setEnabled(enabled): void

Defined in: server/api.d.ts:2188

Sets whether this fire is currently burning.

Parameters

enabled

boolean

True to burn; false to stop burning without destroying the fire.

Returns

void

---

setIntensity()

setIntensity(intensity): void

Defined in: server/api.d.ts:2176

Sets how fiercely this fire burns whoever stands in it.

Parameters

intensity

number

Percent of a victim’s maximum health burned away per second, from 0 to 100.

Returns

void

---

setRadius()

setRadius(radius): void

Defined in: server/api.d.ts:2170

Sets how far this fire reaches.

Parameters

radius

number

Burning radius in world units; must be greater than 0 and at most 100.

Returns

void

---

setVirtualWorld()

setVirtualWorld(world): void

Defined in: server/api.d.ts:4371

Moves this entity into another virtual world.

Parameters

world

number

Virtual-world identifier used to partition replication and visibility.

Returns

void

Inherited from

Entity.setVirtualWorld

---

setVisible()

setVisible(visible): void

Defined in: server/api.d.ts:2182

Sets whether this fire is drawn and heard.

Parameters

visible

boolean

True for flames and sound; false for an invisible, silent damage zone.

Returns

void

---

setVisibleTo()

setVisibleTo(player): void

Defined in: server/api.d.ts:4377

Restricts replication of this entity to one owning connection while preserving normal range and visibility checks.

Parameters

player

Entity | null

Player-owned entity whose connection should exclusively receive this entity, or null to clear the restriction.

Returns

void

Inherited from

Entity.setVisibleTo

---

toString()

toString(): string

Defined in: server/api.d.ts:2159

Returns a readable representation of this fire.

Returns

string

The fire’s ID and shape formatted for logging or debugging.

Inherited from

Entity.toString

---

create()

static create(x, y, z, radius?, intensity?, virtualWorld?): Fire

Defined in: server/api.d.ts:2200

Lights a fire that burns until it is destroyed.

Parameters

x

number

World-space X coordinate of the fire’s centre.

y

number

World-space Y coordinate of the fire’s centre.

z

number

World-space Z coordinate of the fire’s centre.

radius?

number

Optional burning radius in world units; defaults to 3.

intensity?

number

Optional percent of a victim’s maximum health burned away per second; defaults to 8, what a molotov pool burns at.

virtualWorld?

number

Optional virtual-world ID used for visibility filtering.

Returns

Fire

The newly created fire handle.

---

extinguishAll()

static extinguishAll(): number

Defined in: server/api.d.ts:2206

Puts out every fire in the world.

Returns

number

The number of fires that were put out.

---

extinguishInRadius()

static extinguishInRadius(x, y, z, radius): number

Defined in: server/api.d.ts:2216

Puts out every fire whose centre lies inside the given sphere.

Parameters

x

number

World-space X coordinate of the area’s centre.

y

number

World-space Y coordinate of the area’s centre.

z

number

World-space Z coordinate of the area’s centre.

radius

number

Radius of the area to clear, in world units.

Returns

number

The number of fires that were put out.

Properties

enabled

readonly enabled: boolean

Defined in: server/api.d.ts:2153

Whether the fire is currently burning.

---

id

readonly id: number

Defined in: server/api.d.ts:4339

Immutable network entity identifier.

Inherited from

Entity.id

---

intensity

readonly intensity: number

Defined in: server/api.d.ts:2143

Percent of a victim’s maximum health burned away per second.

---

position

position: Vector3

Defined in: server/api.d.ts:4349

Authoritative world-space position; assignment forces replicated state.

Inherited from

Entity.position

---

radius

readonly radius: number

Defined in: server/api.d.ts:2138

Burning radius in world units.

---

rotation

rotation: Vector3 | Quaternion

Defined in: server/api.d.ts:4354

Authoritative rotation; reads return a quaternion and assignments accept a quaternion or Euler angles in degrees.

Inherited from

Entity.rotation

---

state

readonly state: StateBag

Defined in: server/api.d.ts:4359

Arbitrary key/value state carried by this entity. The server writes it and every client that can see the entity receives it; see StateBag.

Inherited from

Entity.state

---

virtualWorld

readonly virtualWorld: number

Defined in: server/api.d.ts:4344

Current virtual-world identifier.

Inherited from

Entity.virtualWorld

---

visible

readonly visible: boolean

Defined in: server/api.d.ts:2148

Whether flames and sound are drawn.