[This is preliminary documentation and is subject to change.]
Represents a fire.
Inheritance Hierarchy
RageFire
Namespace: Rage
Assembly: RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
Syntax
The Fire type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | DesiredBurnDuration |
Gets or sets the desired burn duration.
|
| ElapsedBurnDuration |
Gets or sets how long this fire has been burning for.
|
| Offset | Gets or sets the position of this instance. If ParentEntity is null, this property has the same value as Position; the position is in world space; otherwise it is relative to the parent entity. |
| OwningEntity | Gets or sets the entity this fire belongs to. Damage inflicted by fires is attributed to the owner. |
| ParentEntity |
Gets the entity this fire is attached to.
|
| Position |
Gets or sets the position of this instance.
|
| SpreadRadius |
Gets or sets how far the fire spreads.
|
Methods
| Name | Description | |
|---|---|---|
 | Delete | Deletes this instance. Any call to a non-existent instance is invalid and will cause an exception. |
| DistanceTo(ISpatial) |
Gets the distance from this instance to the specified ISpatial instance.
|
| DistanceTo(Vector3) |
Gets the distance from this instance to the specified position.
|
| DistanceTo2D(ISpatial) |
Gets the distance from this instance to the specified ISpatial instance.
|
| DistanceTo2D(Vector3) |
Gets the distance from this instance to the specified position.
|
| IsValid |
Determines whether this instance still represents an existing fire within the game world. Calls to an invalid instance is illegal and will result in an exception.
|
| TravelDistanceTo(ISpatial) |
Gets the distance from this instance to the specified ISpatial instance, if using the road system.
|
| TravelDistanceTo(Vector3) |
Gets the distance from this instance to the specified position, if using the road system.
|
Operators
| Name | Description | |
|---|---|---|
  | (Fire to Boolean) |
See Also