Vehicle Class |
Represents a component which provides the data and functionality of a vehicle.
Inheritance HierarchyNamespace: SampSharp.Entities.SAMP
Assembly: SampSharp.Entities (in SampSharp.Entities.dll) Version: 0.0.0-localbuild+05637d43e9f34d872e453289d4e240c843e43b09
SyntaxC#
public sealed class Vehicle : Component
The Vehicle type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Alarm |
Gets or sets this vehicle's alarm state. If True the alarm is (or was) sounding.
|
| Angle |
Gets or sets the Z angle of this vehicle.
|
| Bonnet |
Gets or sets the bonnet/hood status of this vehicle. If True, it's open.
|
| Boot |
Gets or sets the boot/trunk status of this vehicle. True means it is open.
|
| Doors |
Gets or sets the lock status of the doors of this vehicle. If True the doors are locked.
|
| Engine |
Gets or sets this vehicle's engine status. If True, the engine is running.
|
| Entity |
Gets the entity to which this component has been attached.
(Inherited from Component.) |
| HasTrailer |
Gets whether this vehicle has a trailer attached to it.
|
| Health |
Gets or sets the health of this vehicle.
|
| IsBackLeftDoorOpen |
Gets or sets a value indicating whether the driver door is open.
|
| IsBackLeftWindowClosed |
Gets or sets a value indicating whether the driver window is closed.
|
| IsBackRightDoorOpen |
Gets or sets a value indicating whether the driver door is open.
|
| IsBackRightWindowClosed |
Gets or sets a value indicating whether the driver window is closed.
|
| IsComponentAlive |
Gets a value indicating whether this component is alive (has not been destroyed).
(Inherited from Component.) |
| IsDriverDoorOpen |
Gets or sets a value indicating whether the driver door is open.
|
| IsDriverWindowClosed |
Gets or sets a value indicating whether the driver window is closed.
|
| IsPassengerDoorOpen |
Gets or sets a value indicating whether the passenger door is open.
|
| IsPassengerWindowClosed |
Gets or sets a value indicating whether the passenger window is closed.
|
| IsSirenOn |
Gets a value indicating whether this Vehicle's siren is on.
|
| Lights |
Gets or sets this vehicle's lights' state. If True the lights are on.
|
| Model |
Gets the model ID of this vehicle.
|
| Objective |
Gets or sets the objective status of this vehicle. True means the objective is on.
|
| Parent |
Gets the parent entity of the entity to which this component has been attached.
(Inherited from Component.) |
| Position |
Gets or sets the position of this vehicle.
|
| Rotation |
Gets or sets the rotation of this vehicle.
|
| RotationQuaternion |
Gets this vehicle's rotation on all axis as a quaternion.
|
| Trailer |
Gets or sets the the trailer attached to this vehicle.
|
| Velocity |
Gets or sets the velocity at which this vehicle is moving.
|
| VirtualWorld |
Gets or sets the virtual world of this vehicle.
|
Methods| Name | Description | |
|---|---|---|
 | AddComponent(Int32) |
Adds a 'component' (often referred to as a 'mod' (modification)) to this Vehicle.
|
| AddComponentT |
Adds a component of the specified type T to the entity.
(Inherited from Component.) |
| AddComponentT(Object) |
Adds a component of the specified type T to the entity with the specified constructor args.
(Inherited from Component.) |
| ChangeColor |
Change this vehicle's primary and secondary colors.
|
| ChangePaintjob |
Change this vehicle's paintjob (for plain colors see ChangeColor(Int32, Int32)).
|
| Destroy |
Destroys this component.
(Inherited from Component.) |
| DestroyComponentsT |
Destroys the components of the specified type T attached to the entity.
(Inherited from Component.) |
| DestroyEntity |
Destroys the entity.
(Inherited from Component.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetComponentT |
Gets a component of the specified type T attached to the entity.
(Inherited from Component.) |
| GetComponentInChildrenT |
Gets a component of the specified type T attached to a child entity of the entity using a depth first search.
(Inherited from Component.) |
| GetComponentInParentT |
Gets a component of the specified type T attached to a parent entity of the entity.
(Inherited from Component.) |
| GetComponentInSlot |
Retrieves the installed component ID from this vehicle in a specific slot.
|
| GetComponentsT |
Gets all components of the specified type T attached to the entity.
(Inherited from Component.) |
| GetComponentsInChildrenT |
Gets all components of the specified type T attached to a child entity of the entity.
(Inherited from Component.) |
| GetComponentsInParentT |
Gets all components of the specified type T attached to a parent entity of the entity.
(Inherited from Component.) |
| GetDamageStatus |
Retrieve the damage statuses of this vehicle.
|
| GetDistanceFromPoint |
This function can be used to calculate the distance (as a float) between this vehicle and
another
map coordinate.
This can be useful to detect how far a vehicle away is from a location.
|
| GetDoorsParameters(Boolean, Boolean, Boolean, Boolean) |
Gets the doors parameters.
|
| GetDoorsParameters(VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue) |
Gets the doors parameters.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetParameters(Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean) |
Gets this vehicle's parameters.
|
| GetParameters(VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue) |
Gets this vehicle's parameters.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetWindowsParameters(Boolean, Boolean, Boolean, Boolean) |
Gets the windows parameters.
|
| GetWindowsParameters(VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue) |
Gets the windows parameters.
|
| IsStreamedIn |
Checks if this vehicle is streamed in for the specified player.
|
| LinkToInterior |
Links this vehicle to the interior. This can be used for example for an arena/stadium.
|
| RemoveComponent |
Remove a component from the vehicle.
|
| Repair |
Fully repairs this vehicle, including visual damage (bumps, dents, scratches, popped tires
etc.).
|
| Respawn |
Sets this vehicle back to the position at where it was created.
|
| SetAngularVelocity |
Sets the angular velocity of this vehicle.
|
| SetDoorsParameters(Boolean, Boolean, Boolean, Boolean) |
Sets the doors parameters.
|
| SetDoorsParameters(VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue) |
Sets the doors parameters.
|
| SetNumberPlate |
Set this vehicle's numberplate, which supports color embedding.
|
| SetParameters(Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean) |
Sets this vehicle's parameters for all players.
|
| SetParameters(VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue) |
Sets this vehicle's parameters for all players.
|
| SetParametersForPlayer |
Set the parameters of this vehicle for a player.
|
| SetWindowsParameters(Boolean, Boolean, Boolean, Boolean) |
Sets the windows parameters.
|
| SetWindowsParameters(VehicleParameterValue, VehicleParameterValue, VehicleParameterValue, VehicleParameterValue) |
Sets the windows parameters.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateDamageStatus |
Sets the various visual damage statuses of this vehicle, such as popped tires, broken lights and
damaged panels.
|
See Also