Blip ClassRAGE Plugin Hook Documentation

[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

SystemObject
  RageBlip

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

[SerializableAttribute]
public sealed class Blip : IHandleable, IAddressable, 
	ISpatial, IDeletable

The Blip type exposes the following members.

Constructors

  NameDescription
Public methodBlip(Entity)
Initializes a new instance of the Blip class.
Public methodBlip(Vector3)
Initializes a new instance of the Blip class.
Public methodBlip(Vector3, Single)
Initializes a new instance of the Blip class.
Top
Properties

  NameDescription
Public propertyAlpha
Gets or sets the alpha of this Blip.
Public propertyAngle
Sets the angle of this Blip, in degrees.
Public propertyColor
Gets or sets the color of this Blip.
Public propertyEntity
Gets the Entity that this Blip is attached to.
Public propertyHandle
Gets the handle of this instance. Used to identify the instance within its pool.
Public propertyIsFriendly
Public propertyIsRouteEnabled
Sets a value indicating whether a route to this Blip is currently active.
Public propertyMemoryAddress
Gets the memory address of this instance.
Public propertyName
Gets or sets the name of this Blip. The name is what appears in the legends list on the map.
Public propertyNumberLabel
Sets the number to be shown on this blip.
Public propertyOrder
Sets the order of this Blip. Blip with a higher order will be drawn on top of Blips with a lower order.
Public propertyPosition
Gets or sets the position of this instance.
Public propertyRouteColor
Gets or sets the color of the route to this Blip.
Public propertyScale
Sets the scale of this Blip.
Public propertySprite
Gets or sets the sprite of this Blip.
Top
Methods

  NameDescription
Public methodDelete

Deletes this instance.

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

Public methodDisableRoute
Disables the current route to this Blip.
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 methodEnableRoute
Enables a route to this Blip with the specified color.
Public methodEquals(Blip)
Indicates whether this instance equals the specified Blip instance.
Public methodEquals(IHandleable)
Indicates whether this instance equals the specified IHandleable instance.
Public methodFlash
Makes Blip blip flash at the specified interval for the specified duration.
Public methodIsValid
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.
Public methodRemoveNumberLabel
Removes the number label from this blip.
Public methodStopFlashing
Stops the flashing of this Blip.
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 memberEquality
Determines whether the the first Blip instance represents the same blip as the second Blip instance.
Public operatorStatic member(Blip to Boolean)
Public operatorStatic memberInequality
Determines whether the the first Blip instance represents a different blip than the second Blip instance.
Top
See Also

Reference