[This is preliminary documentation and is subject to change.]
Represents a Blip in the game world.
Blips are used to mark entities of interest in either the game world, on the radar or both.
Inheritance Hierarchy
RageBlip
Namespace: Rage
Assembly: RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
Syntax
[SerializableAttribute] public sealed class Blip : IHandleable, IAddressable, ISpatial, IDeletable
The Blip type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Blip(Entity) |
Initializes a new instance of the Blip class.
|
| Blip(Vector3) |
Initializes a new instance of the Blip class.
|
| Blip(Vector3, Single) |
Initializes a new instance of the Blip class.
|
Properties
| Name | Description | |
|---|---|---|
 | Alpha |
Gets or sets the alpha of this Blip.
|
| Angle |
Sets the angle of this Blip, in degrees.
|
| Color |
Gets or sets the color of this Blip.
|
| Entity |
Gets the Entity that this Blip is attached to.
|
| Handle |
Gets the handle of this instance. Used to identify the instance within its pool.
|
| IsFriendly | |
| IsRouteEnabled |
Sets a value indicating whether a route to this Blip is currently active.
|
| MemoryAddress |
Gets the memory address of this instance.
|
| Name |
Gets or sets the name of this Blip. The name is what appears in the legends list on the map.
|
| NumberLabel |
Sets the number to be shown on this blip.
|
| Order |
Sets the order of this Blip. Blip with a higher order will be drawn on top of Blips with a lower order.
|
| Position |
Gets or sets the position of this instance.
|
| RouteColor |
Gets or sets the color of the route to this Blip.
|
| Scale |
Sets the scale of this Blip.
|
| Sprite |
Gets or sets the sprite of this Blip.
|
Methods
| Name | Description | |
|---|---|---|
| Delete | Deletes this instance. Any call to a non-existent instance is invalid and will cause an exception. |
| DisableRoute |
Disables the current route to this Blip.
|
| 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.
|
| EnableRoute |
Enables a route to this Blip with the specified color.
|
| Equals(Blip) |
Indicates whether this instance equals the specified Blip instance.
|
| Equals(IHandleable) |
Indicates whether this instance equals the specified IHandleable instance.
|
| Flash |
Makes Blip blip flash at the specified interval for the specified duration.
|
| IsValid |
Determines whether this instance still represents an existing entity within the game world. Calls to an invalid instance is illegal and will result in an exception.
|
| RemoveNumberLabel |
Removes the number label from this blip.
|
| StopFlashing |
Stops the flashing of this Blip.
|
| 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 | |
|---|---|---|
  | Equality |
Determines whether the the first Blip instance represents the same blip as the second Blip instance.
|
| (Blip to Boolean) | |
| Inequality |
Determines whether the the first Blip instance represents a different blip than the second Blip instance.
|
See Also