Fire ClassRAGE Plugin Hook Documentation

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:Rage.Fire"]

Inheritance Hierarchy

SystemObject
  RageFire

Namespace: Rage
Assembly: RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.47.1037.9935)
Syntax

public class Fire : ISpatial, IDeletable

The Fire type exposes the following members.

Properties

  NameDescription
Public propertyDesiredBurnDuration
Public propertyElapsedBurnDuration
Public propertyOffset

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.

Public propertyOwningEntity

Gets or sets the entity this fire belongs to.

Damage inflicted by fires is attributed to the owner.

Public propertyParentEntity
Gets the entity this fire is attached to.
Public propertyPosition
Gets or sets the position of this instance.
Public propertySpreadRadius
Top
Methods

  NameDescription
Public methodDelete

Deletes this instance.

Any call to a non-existent instance is invalid and will cause an exception.

Public methodDistanceTo(ISpatial)
Gets the distance from this instance to the specified ISpatial instance.
Public methodDistanceTo(Vector3)
Gets the distance from this instance to the specified position.
Public methodDistanceTo2D(ISpatial)
Gets the distance from this instance to the specified ISpatial instance.
Public methodDistanceTo2D(Vector3)
Gets the distance from this instance to the specified position.
Public methodIsValid
Public methodTravelDistanceTo(ISpatial)
Gets the distance from this instance to the specified ISpatial instance, if using the road system.
Public methodTravelDistanceTo(Vector3)
Gets the distance from this instance to the specified position, if using the road system.
Top
Operators

  NameDescription
Public operatorStatic member(Fire to Boolean)
Top
See Also

Reference