ScriptHookVDotNet

https://nitanmarcel.github.io/scripthookvdotnet/
Admin
ScriptHookVDotNet is a scripting framework for Grand Theft Auto V that allows developers to create...
Tokens:141,540
Snippets:1,576
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Vehicle ModKit

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.VehicleModCollection.InstallModKit.html

Installs a vehicle mod kit. This method does not take any parameters.

```csharp
public void InstallModKit()
```

--------------------------------

### IsEngineStarting Property

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Vehicle.IsEngineStarting.html

Gets a value indicating whether this vehicle's engine is currently starting.

```APIDOC
## IsEngineStarting

### Description
Gets a value indicating whether this vehicle's engine is currently starting.

### Declaration
```csharp
public bool IsEngineStarting { get; }
```

### Property Value
Type | Description
---|---
System.Boolean | `true` if this vehicle's engine is starting; otherwise, `false`.
```

--------------------------------

### Start Screen Effect

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Screen.StartEffect.html

Starts applying a specified screen effect. Use duration to control how long the effect lasts, or set looped to true to keep it active until explicitly stopped.

```csharp
ScreenEffect.StartEffect(ScreenEffect.Blur, 5000, false);
```

--------------------------------

### Start Looping Screen Effect

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Screen.StartEffect.html

Starts a screen effect that will continue indefinitely until StopEffect is called. This is useful for persistent effects.

```csharp
ScreenEffect.StartEffect(ScreenEffect.Shake, 0, true);
```

--------------------------------

### VehicleToggleMod.IsInstalled

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.VehicleToggleMod.IsInstalled.html

Gets or sets a value indicating whether the toggle mod is installed on the vehicle.

```APIDOC
## Property IsInstalled

### Description
Gets or sets a value indicating whether the toggle mod is installed on the vehicle.

### Declaration
```csharp
public bool IsInstalled { get; set; }
```

### Property Value
Type | Description
---|---
System.Boolean | Indicates if the mod is installed.
```

--------------------------------

### AspectRatio

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Screen.AspectRatio.html

Gets the current screen aspect ratio.

```APIDOC
## Property AspectRatio

### Description
Gets the current screen aspect ratio.

### Declaration
```csharp
public static float AspectRatio { get; }
```

### Property Value
Type | Description
---|---
System.Single |
```

--------------------------------

### Get Localized Wheel Type Name

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.VehicleModCollection.GetLocalizedWheelTypeName.html

Use this method to get the localized name for a given vehicle wheel type. No specific setup is required beyond having access to the VehicleModCollection.

```csharp
public string GetLocalizedWheelTypeName(VehicleWheelType wheelType)
```

--------------------------------

### StartScenario(string name, Vector3 position, float heading)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.TaskInvoker.StartScenario.html

Starts a scenario with a specified name, position, and heading.

```APIDOC
## StartScenario(string name, Vector3 position, float heading)

### Description
Starts a scenario with the given name, position, and heading.

### Method Signature
public void StartScenario(string name, Vector3 position, float heading)

### Parameters
#### Path Parameters
- **name** (System.String) - The name of the scenario to start.
- **position** (Vector3) - The position where the scenario should start.
- **heading** (System.Single) - The heading for the scenario.
```

--------------------------------

### StartScenario(string name, float heading)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.TaskInvoker.StartScenario.html

Starts a scenario with a specified name and heading.

```APIDOC
## StartScenario(string name, float heading)

### Description
Starts a scenario with the given name and heading.

### Method Signature
public void StartScenario(string name, float heading)

### Parameters
#### Path Parameters
- **name** (System.String) - The name of the scenario to start.
- **heading** (System.Single) - The heading for the scenario.
```

--------------------------------

### HasNeonLights Property

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.VehicleModCollection.HasNeonLights.html

Gets a value indicating whether the vehicle has neon lights installed.

```APIDOC
## HasNeonLights

### Description
Gets a value indicating whether the vehicle has neon lights installed.

### Property Value
Type | Description
---|---
System.Boolean | Indicates if neon lights are present.
```

--------------------------------

### Get All Models of a Vehicle Class

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Vehicle.GetAllModelsOfClass.html

Use this method to get an array of all vehicle model hashes for a given vehicle class. No specific setup is required beyond having access to the GTA.Vehicle namespace.

```csharp
VehicleHash[] vehicleModels = GTA.Vehicle.GetAllModelsOfClass(VehicleClass.Heli);

```

--------------------------------

### LoadingPrompt.Show(String, LoadingSpinnerType)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.LoadingPrompt.html

Creates a loading prompt with specified text and spinner type.

```APIDOC
## Show(String, LoadingSpinnerType)

### Description
Creates a loading prompt at the bottom right of the screen with the given text and spinner type.

### Method
`static void Show(string text, LoadingSpinnerType spinnerType)`

### Parameters
#### Parameters
- **text** (string) - Required - The text to display with the loading prompt.
- **spinnerType** (LoadingSpinnerType) - Required - The type of spinner to display.

### Returns
None
```

--------------------------------

### ShowHelpTextThisFrame(String)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Screen.ShowHelpTextThisFrame.html

Displays a help message in the top corner of the screen for the current frame. A beeping sound will be played.

```APIDOC
## Method ShowHelpTextThisFrame(String)

### Description
Displays a help message in the top corner of the screen this frame. A beeping sound will be played.

### Parameters
- **helpText** (System.String) - The text to display.
```

--------------------------------

### LoadingPrompt.Show

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.LoadingPrompt.Show.html

Creates a loading prompt at the bottom right of the screen with the given text and spinner type. The `loadingText` parameter is optional and defaults to null. The `spinnerType` parameter is optional and defaults to `LoadingSpinnerType.RegularClockwise`.

```APIDOC
## Method Show

### Description
Creates a loading prompt at the bottom right of the screen with the given text and spinner type.

### Signature
```csharp
public static void Show(string loadingText = null, LoadingSpinnerType spinnerType = LoadingSpinnerType.RegularClockwise)
```

### Parameters
#### Path Parameters
- **loadingText** (System.String) - Optional - The text to display next to the spinner.
- **spinnerType** (LoadingSpinnerType) - Optional - The style of spinner to draw. Possible values include Clockwise1, Clockwise2, Clockwise3, and RegularClockwise. Rockstar typically uses RegularClockwise.

### Remarks
Clockwise1, Clockwise2, Clockwise3 and RegularClockwise all appear to be the same. Rockstar apparently always uses RegularClockwise in their scripts.
```

--------------------------------

### Get and Set SuspensionBiasFront

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.HandlingData.SuspensionBiasFront.html

Accesses the SuspensionBiasFront property to get or set the suspension bias between front and rear wheels. Use this to adjust handling, for example, by increasing front suspension strength for vehicles with more weight at the rear.

```csharp
public float SuspensionBiasFront { get; set; }
```

--------------------------------

### GameplayCamera.MemoryAddress

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.GameplayCamera.MemoryAddress.html

Gets the memory address of the GameplayCamera.

```APIDOC
## Property MemoryAddress

### Description
Gets the memory address of the GameplayCamera.

### Declaration
```csharp
public static IntPtr MemoryAddress { get; }
```

### Property Value
Type | Description
---|---
System.IntPtr |
```

--------------------------------

### Accessing the North Blip

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Game.NorthBlip.html

Use this property to get the Blip object representing the north blip on the radar. No setup is required as it is a static property.

```csharp
public static Blip NorthBlip { get; }
```

--------------------------------

### StartScenario with Name, Position, and Heading

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.TaskInvoker.StartScenario.html

Initiates a game scenario at a precise location defined by a Vector3 position and a heading. Use this overload when you need to control the exact starting point of the scenario.

```csharp
public void StartScenario(string name, Vector3 position, float heading)
```

--------------------------------

### StartEffect

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Screen.StartEffect.html

Starts applying the specified effect to the screen. You can control the duration and whether the effect loops.

```APIDOC
## StartEffect

### Description
Starts applying the specified effect to the screen. You can control the duration and whether the effect loops.

### Method Signature
`public static void StartEffect(ScreenEffect effectName, int duration = 0, bool looped = false)`

### Parameters
#### Parameters
- **effectName** (ScreenEffect) - Required - The ScreenEffect to start playing.
- **duration** (System.Int32) - Optional - The duration of the effect in milliseconds or zero to use the default length.
- **looped** (System.Boolean) - Optional - If `true` the effect won't stop until StopEffect(ScreenEffect) is called.
```

--------------------------------

### PlayerBlip

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Game.PlayerBlip.html

Gets the blip of the Player that you are controlling.

```APIDOC
## Property PlayerBlip

### Description
Gets the blip of the Player that you are controlling.

### Declaration
```csharp
public static Blip PlayerBlip { get; }
```

### Property Value
Type | Description  
---|---
Blip | The player's blip.
```

--------------------------------

### VehicleColor SecondaryColor { get; set; }

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.VehicleModCollection.SecondaryColor.html

Gets or sets the secondary color of the vehicle. This property is of type VehicleColor.

```APIDOC
## Property SecondaryColor

### Declaration
```csharp
public VehicleColor SecondaryColor { get; set; }
```

### Property Value
Type | Description  
---|---
VehicleColor | The secondary color of the vehicle.
```

--------------------------------

### StartScenario with Name and Heading

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.TaskInvoker.StartScenario.html

Initiates a game scenario using its name and a specified heading. This overload is useful when the scenario's starting position is implicitly defined by the scenario itself.

```csharp
public void StartScenario(string name, float heading)
```

--------------------------------

### Sprite Constructor Example

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Sprite.html

Initializes a new instance of the Sprite class. This constructor is used for drawing in-game textures on the screen.

```csharp
new Sprite("textureName", "textureName", new SizeF(100f, 100f), new PointF(100f, 100f))
```

--------------------------------

### GTA.Vehicle.ClassDisplayName

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Vehicle.ClassDisplayName.html

Gets the display name of this Vehicles VehicleClass. Use GetLocalizedString(String) to get the localized class name.

```APIDOC
## Property ClassDisplayName

### Description
Gets the display name of this Vehicles VehicleClass. Use GetLocalizedString(String) to get the localized class name.

### Declaration
```csharp
public string ClassDisplayName { get; }
```

### Property Value
Type | Description
---|---
System.String | 
```

--------------------------------

### Get and Set SuspensionUpperLimit

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.HandlingData.SuspensionUpperLimit.html

Gets or sets how far the wheels can move up from their original position. This property is of type System.Single.

```csharp
public float SuspensionUpperLimit { get; set; }
```

--------------------------------

### CustomSprite Constructor (filename, size, position, color)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.CustomSprite.-ctor.html

Initializes a new instance of the CustomSprite class with the specified filename, size, position, and color.

```APIDOC
## CustomSprite(String, SizeF, PointF, Color)

### Description
Initializes a new instance of the CustomSprite class used for drawing external textures on the screen.

### Parameters
#### Path Parameters
- **filename** (System.String) - Required - Full path to location of the CustomSprite on the disc.
- **size** (System.Drawing.SizeF) - Required - Set the Size of the CustomSprite.
- **position** (System.Drawing.PointF) - Required - Set the Position on screen where to draw the CustomSprite.
- **color** (System.Drawing.Color) - Required - Set the Color used to draw the CustomSprite.

### Exceptions
- System.IO.FileNotFoundException: Thrown if the specified file doesn't exist
```

--------------------------------

### Get and Set SuspensionReboundDamping

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.HandlingData.SuspensionReboundDamping.html

This snippet shows how to get and set the SuspensionReboundDamping property for a vehicle. This property is a float value.

```csharp
public float SuspensionReboundDamping { get; set; }
```

--------------------------------

### ShowHelpTextThisFrame(String, Boolean)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Screen.ShowHelpTextThisFrame.html

Displays a help message in the top corner of the screen for the current frame. Allows specifying whether a beeping sound should play.

```APIDOC
## Method ShowHelpTextThisFrame(String, Boolean)

### Description
Displays a help message in the top corner of the screen this frame. Specify whether beeping sound plays.

### Parameters
- **helpText** (System.String) - The text to display.
- **beep** (System.Boolean) - Whether to play beeping sound.
```

--------------------------------

### Get Total Vehicle Count

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.World.VehicleCount.html

Use the VehicleCount property to get the current number of spawned vehicles. This is a read-only property.

```csharp
public static int VehicleCount { get; }
```

--------------------------------

### Get or Set OilVolume

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.HandlingData.OilVolume.html

Use this property to get or set the amount of oil in a vehicle. The value is a single-precision floating-point number.

```csharp
public float OilVolume { get; set; }
```

--------------------------------

### Create ParticleEffectAsset

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.ParticleEffectAsset.-ctor.html

Use this constructor to create a new ParticleEffectAsset object. Provide the name of the asset file (without the extension) that contains the particle effects you want to use.

```csharp
public ParticleEffectAsset(string assetName)
```

--------------------------------

### CustomSprite Constructor (filename, size, position, color, rotation, centered)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.CustomSprite.-ctor.html

Initializes a new instance of the CustomSprite class with the specified filename, size, position, color, rotation, and centered flag.

```APIDOC
## CustomSprite(String, SizeF, PointF, Color, Single, Boolean)

### Description
Initializes a new instance of the CustomSprite class used for drawing external textures on the screen.

### Parameters
#### Path Parameters
- **filename** (System.String) - Required - Full path to location of the CustomSprite on the disc.
- **size** (System.Drawing.SizeF) - Required - Set the Size of the CustomSprite.
- **position** (System.Drawing.PointF) - Required - Set the Position on screen where to draw the CustomSprite.
- **color** (System.Drawing.Color) - Required - Set the Color used to draw the CustomSprite.
- **rotation** (System.Single) - Required - Set the rotation to draw the sprite, measured in degrees, see also Rotation.
- **centered** (System.Boolean) - Required - Position the CustomSprite based on its center instead of top left corner, see also Centered.

### Exceptions
- System.IO.FileNotFoundException: Thrown if the specified file doesn't exist
```

--------------------------------

### Get and Set TractionBiasFront

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.HandlingData.TractionBiasFront.html

This snippet shows how to get and set the TractionBiasFront property. This value determines how traction is distributed from front to rear.

```csharp
public float TractionBiasFront { get; set; }
```

--------------------------------

### ContainerElement(PointF, SizeF, Color)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.ContainerElement.-ctor.html

Initializes a new instance of the ContainerElement class with specified position, size, and color.

```APIDOC
## ContainerElement(PointF position, SizeF size, Color color)

### Description
Initializes a new instance of the ContainerElement class used for grouping items on screen.

### Method
```csharp
public ContainerElement(PointF position, SizeF size, Color color)
```

### Parameters
#### Path Parameters
- **position** (System.Drawing.PointF) - Required - Set the Position on screen where to draw the ContainerElement.
- **size** (System.Drawing.SizeF) - Required - Set the Size of the ContainerElement.
- **color** (System.Drawing.Color) - Required - Set the Color used to draw the ContainerElement.
```

--------------------------------

### CustomSprite Constructor (filename, size, position, color, rotation)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.CustomSprite.-ctor.html

Initializes a new instance of the CustomSprite class with the specified filename, size, position, color, and rotation.

```APIDOC
## CustomSprite(String, SizeF, PointF, Color, Single)

### Description
Initializes a new instance of the CustomSprite class used for drawing external textures on the screen.

### Parameters
#### Path Parameters
- **filename** (System.String) - Required - Full path to location of the CustomSprite on the disc.
- **size** (System.Drawing.SizeF) - Required - Set the Size of the CustomSprite.
- **position** (System.Drawing.PointF) - Required - Set the Position on screen where to draw the CustomSprite.
- **color** (System.Drawing.Color) - Required - Set the Color used to draw the CustomSprite.
- **rotation** (System.Single) - Required - Set the rotation to draw the sprite, measured in degrees, see also Rotation.

### Exceptions
- System.IO.FileNotFoundException: Thrown if the specified file doesn't exist
```

--------------------------------

### Get or Set ClutchChangeRateScaleDownShift

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.HandlingData.ClutchChangeRateScaleDownShift.html

Gets or sets the clutch speed multiplier on down shifts. This property controls how quickly the clutch engages during a downshift.

```csharp
public float ClutchChangeRateScaleDownShift { get; set; }
```

--------------------------------

### Sprite(String, String, SizeF, PointF, Color)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Sprite.-ctor.html

Initializes a new instance of the Sprite class with texture dictionary, texture name, size, position, and color.

```APIDOC
## Sprite(String, String, SizeF, PointF, Color)

### Description
Initializes a new instance of the Sprite class used for drawing in game textures on the screen.

### Parameters
#### Path Parameters
- **textureDict** (System.String) - Required - The Texture dictionary where the Sprite is stored (the *.ytd file).
- **textureName** (System.String) - Required - Name of the Sprite inside the Texture dictionary.
- **size** (System.Drawing.SizeF) - Required - Set the Size of the Sprite.
- **position** (System.Drawing.PointF) - Required - Set the Position on screen where to draw the Sprite.
- **color** (System.Drawing.Color) - Required - Set the Color used to draw the Sprite.
```

--------------------------------

### Get or Set ClutchChangeRateScaleUpShift

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.HandlingData.ClutchChangeRateScaleUpShift.html

Gets or sets the clutch speed multiplier on up shifts. This value affects how quickly the clutch engages during an upshift.

```csharp
public float ClutchChangeRateScaleUpShift { get; set; }
```

--------------------------------

### TextElement Constructor with Caption, Position, Scale, Color, Font, Alignment, Shadow, Outline, and Wrap Width

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.TextElement.-ctor.html

Initializes a new TextElement with the specified caption, position, scale, color, font, alignment, shadow, outline, and wrap width.

```APIDOC
## TextElement(String, PointF, Single, Color, Font, Alignment, Boolean, Boolean, Single)

### Description
Initializes a new instance of the TextElement class used for drawing text on the screen.

### Parameters
- **caption** (System.String) - The TextElement to draw.
- **position** (System.Drawing.PointF) - Set the Position on screen where to draw the TextElement.
- **scale** (System.Single) - Sets a Scale used to increase of decrease the size of the TextElement, for no scaling use 1.0f.
- **color** (System.Drawing.Color) - Set the Color used to draw the TextElement.
- **font** (Font) - Sets the Font used when drawing the text.
- **alignment** (Alignment) - Sets the Alignment used when drawing the text, Left,Center or Right.
- **shadow** (System.Boolean) - Sets whether or not to draw the TextElement with a Shadow effect.
- **outline** (System.Boolean) - Sets whether or not to draw the TextElement with an Outline around the letters.
- **wrapWidth** (System.Single) - The width at which to wrap the text.
```

--------------------------------

### Check if Vehicle Toggle Mod is Installed

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.VehicleToggleMod.IsInstalled.html

Use the IsInstalled property to determine if a vehicle toggle mod is currently installed. This is a read-only property.

```csharp
public bool IsInstalled { get; set; }
```

--------------------------------

### TextElement Constructor with Caption, Position, Scale, Color, Font, Alignment, Shadow, and Outline

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.TextElement.-ctor.html

Initializes a new TextElement with the specified caption, position, scale, color, font, alignment, shadow, and outline.

```APIDOC
## TextElement(String, PointF, Single, Color, Font, Alignment, Boolean, Boolean)

### Description
Initializes a new instance of the TextElement class used for drawing text on the screen.

### Parameters
- **caption** (System.String) - The TextElement to draw.
- **position** (System.Drawing.PointF) - Set the Position on screen where to draw the TextElement.
- **scale** (System.Single) - Sets a Scale used to increase of decrease the size of the TextElement, for no scaling use 1.0f.
- **color** (System.Drawing.Color) - Set the Color used to draw the TextElement.
- **font** (Font) - Sets the Font used when drawing the text.
- **alignment** (Alignment) - Sets the Alignment used when drawing the text, Left,Center or Right.
- **shadow** (System.Boolean) - Sets whether or not to draw the TextElement with a Shadow effect.
- **outline** (System.Boolean) - Sets whether or not to draw the TextElement with an Outline around the letters.
```

--------------------------------

### DropsEquippedWeaponOnDeath Property

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Ped.DropsEquippedWeaponOnDeath.html

Sets whether this Ped will drop the equipped weapon when they get killed. Peds will drop only their equipped weapon when they get killed.

```APIDOC
## Property DropsEquippedWeaponOnDeath

### Description
Sets whether this Ped will drop the equipped weapon when they get killed. Note that Peds will drop only their equipped weapon when they get killed.

### Declaration
```csharp
public bool DropsEquippedWeaponOnDeath { get; set; }
```

### Property Value
Type | Description
---|---
System.Boolean | `true` if Ped drops the equipped weapon when killed; otherwise, `false`.
```

--------------------------------

### Get and Set PercentSubmerged

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.HandlingData.PercentSubmerged.html

Accesses the PercentSubmerged property to get or set the percentage of the vehicle that remains above water before sinking. The value should be between 0 and 1.

```csharp
public float PercentSubmerged { get; set; }
```

--------------------------------

### ContainerElement(PointF, SizeF)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.ContainerElement.-ctor.html

Initializes a new instance of the ContainerElement class with specified position and size.

```APIDOC
## ContainerElement(PointF position, SizeF size)

### Description
Initializes a new instance of the ContainerElement class used for grouping items on screen.

### Method
```csharp
public ContainerElement(PointF position, SizeF size)
```

### Parameters
#### Path Parameters
- **position** (System.Drawing.PointF) - Required - Set the Position on screen where to draw the ContainerElement.
- **size** (System.Drawing.SizeF) - Required - Set the Size of the ContainerElement.
```

--------------------------------

### ContainerElement(PointF, SizeF, Color, Boolean)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.ContainerElement.-ctor.html

Initializes a new instance of the ContainerElement class with specified position, size, color, and centering option.

```APIDOC
## ContainerElement(PointF position, SizeF size, Color color, bool centered)

### Description
Initializes a new instance of the ContainerElement class used for grouping items on screen.

### Method
```csharp
public ContainerElement(PointF position, SizeF size, Color color, bool centered)
```

### Parameters
#### Path Parameters
- **position** (System.Drawing.PointF) - Required - Set the Position on screen where to draw the ContainerElement.
- **size** (System.Drawing.SizeF) - Required - Set the Size of the ContainerElement.
- **color** (System.Drawing.Color) - Required - Set the Color used to draw the ContainerElement.
- **centered** (System.Boolean) - Required - Position the ContainerElement based on its center instead of top left corner, see also Centered.
```

--------------------------------

### Get and Set Blip ScaleY

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Blip.ScaleY.html

Use the ScaleY property to get or set the y-axis scale of a Blip. This affects its vertical size on the map.

```csharp
public float ScaleY { get; set; }
```

--------------------------------

### CustomSprite Constructor (filename, size, position)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.CustomSprite.-ctor.html

Initializes a new instance of the CustomSprite class with the specified filename, size, and position.

```APIDOC
## CustomSprite(String, SizeF, PointF)

### Description
Initializes a new instance of the CustomSprite class used for drawing external textures on the screen.

### Parameters
#### Path Parameters
- **filename** (System.String) - Required - Full path to location of the CustomSprite on the disc.
- **size** (System.Drawing.SizeF) - Required - Set the Size of the CustomSprite.
- **position** (System.Drawing.PointF) - Required - Set the Position on screen where to draw the CustomSprite.

### Exceptions
- System.IO.FileNotFoundException: Thrown if the specified file doesn't exist
```

--------------------------------

### Get and Set Landing Gear State

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Vehicle.LandingGearState.html

Accesses the current landing gear state of a vehicle. This property can be used to get or set the landing gear state.

```csharp
public VehicleLandingGearState LandingGearState { get; set; }
```

--------------------------------

### Sprite(String, String, SizeF, PointF)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Sprite.-ctor.html

Initializes a new instance of the Sprite class with texture dictionary, texture name, size, and position.

```APIDOC
## Sprite(String, String, SizeF, PointF)

### Description
Initializes a new instance of the Sprite class used for drawing in game textures on the screen.

### Parameters
#### Path Parameters
- **textureDict** (System.String) - Required - The Texture dictionary where the Sprite is stored (the *.ytd file).
- **textureName** (System.String) - Required - Name of the Sprite inside the Texture dictionary.
- **size** (System.Drawing.SizeF) - Required - Set the Size of the Sprite.
- **position** (System.Drawing.PointF) - Required - Set the Position on screen where to draw the Sprite.
```

--------------------------------

### Get or Set Cursor Sprite

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Hud.CursorSprite.html

Use this property to retrieve the current cursor sprite or assign a new one. The CursorSprite type is used for both getting and setting the value.

```csharp
public static CursorSprite CursorSprite { get; set; }
```

--------------------------------

### Get and Set SuspensionForce

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.HandlingData.SuspensionForce.html

Gets or sets the suspension force. Lower limit for zero force at full extension is calculated using (1.0f / (force * number of wheels)).

```csharp
public float SuspensionForce { get; set; }
```

--------------------------------

### Checkpoint Class Overview

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Checkpoint.html

Provides an overview of the Checkpoint class, its inheritance, interfaces, and namespace.

```APIDOC
## Class Checkpoint
##### Inheritance
System.Object
PoolObject
Checkpoint
##### Implements
INativeValue
IDeletable
IExistable
##### Inherited Members
PoolObject.Handle
PoolObject.NativeValue
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
###### **Namespace** : GTA
###### **Assembly** : ScriptHookVDotNet3.dll
##### Syntax
```csharp
public sealed class Checkpoint : PoolObject, INativeValue, IDeletable, IExistable
```
```

--------------------------------

### PlayMusic Method

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Audio.PlayMusic.html

Plays music from the game's music files.

```APIDOC
## PlayMusic(String)

### Description
Plays music from the game's music files.

### Method Signature
`public static void PlayMusic(string musicFile)`

### Parameters
#### Path Parameters
- **musicFile** (System.String) - Required - The music file to play.
```

--------------------------------

### Get and Set SteeringLock

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.HandlingData.SteeringLock.html

Access the SteeringLock property to get or set the multiplier for the steer wheel's turning angle. Values should be between 0.01 and above. This property affects the vehicle's oversteer and understeer behavior.

```csharp
public float SteeringLock { get; set; }
```

--------------------------------

### Sprite(String, String, SizeF, PointF, Color, Single)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Sprite.-ctor.html

Initializes a new instance of the Sprite class with texture dictionary, texture name, size, position, color, and rotation.

```APIDOC
## Sprite(String, String, SizeF, PointF, Color, Single)

### Description
Initializes a new instance of the Sprite class used for drawing in game textures on the screen.

### Parameters
#### Path Parameters
- **textureDict** (System.String) - Required - The Texture dictionary where the Sprite is stored (the *.ytd file).
- **textureName** (System.String) - Required - Name of the Sprite inside the Texture dictionary.
- **size** (System.Drawing.SizeF) - Required - Set the Size of the Sprite.
- **position** (System.Drawing.PointF) - Required - Set the Position on screen where to draw the Sprite.
- **color** (System.Drawing.Color) - Required - Set the Color used to draw the Sprite.
- **rotation** (System.Single) - Required - Set the rotation to draw the sprite, measured in degrees, see also Rotation.
```

--------------------------------

### Get and Set Blip Priority

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Blip.Priority.html

Use this property to get or set the priority of a blip. Higher values mean higher priority, affecting how overlapping blips are displayed. The valid range is 0 to 255.

```csharp
public int Priority { get; set; }
```

--------------------------------

### GoStraightTo Method

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.TaskInvoker.GoStraightTo.html

This method makes a ped go straight to a specified position. It includes optional parameters for timeout, target heading, and distance to slide.

```APIDOC
## GoStraightTo

### Description
Makes a ped go straight to a specified position.

### Method Signature
`public void GoStraightTo(Vector3 position, int timeout = -1, float targetHeading = 0F, float distanceToSlide = 0F)`

### Parameters
#### position
- **Type**: `Vector3`
- **Description**: The target position to move towards.

#### timeout
- **Type**: `System.Int32`
- **Description**: The timeout in milliseconds. Defaults to -1 (no timeout).

#### targetHeading
- **Type**: `System.Single`
- **Description**: The desired heading in degrees. Defaults to 0F.

#### distanceToSlide
- **Type**: `System.Single`
- **Description**: The distance to slide when reaching the position. Defaults to 0F.
```

--------------------------------

### GoTo with Entity and Offset

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.TaskInvoker.GoTo.html

Navigates an entity to a target position with an optional offset and timeout.

```APIDOC
## GoTo(Entity, Vector3, Int32)

### Description
Navigates an entity to a target position with an optional offset and timeout.

### Method Signature
```csharp
public void GoTo(Entity target, Vector3 offset = default(Vector3), int timeout = -1)
```

### Parameters
- **target** (Entity) - The entity to navigate.
- **offset** (Vector3) - An optional offset from the target position. Defaults to Vector3.Zero.
- **timeout** (System.Int32) - The maximum time in milliseconds to complete the task. Defaults to -1 (no timeout).
```

--------------------------------

### VehicleWheel.Index

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.VehicleWheel.Index.html

Gets the index of the wheel.

```APIDOC
## VehicleWheel.Index

### Description
Gets the index of the wheel.

### Property Value
Type | Description
---|---
System.Int32 | The index of the wheel.
```

--------------------------------

### Sprite(String, String, SizeF, PointF, Color, Single, Boolean)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Sprite.-ctor.html

Initializes a new instance of the Sprite class with texture dictionary, texture name, size, position, color, rotation, and centered flag.

```APIDOC
## Sprite(String, String, SizeF, PointF, Color, Single, Boolean)

### Description
Initializes a new instance of the Sprite class used for drawing in game textures on the screen.

### Parameters
#### Path Parameters
- **textureDict** (System.String) - Required - The Texture dictionary where the Sprite is stored (the *.ytd file).
- **textureName** (System.String) - Required - Name of the Sprite inside the Texture dictionary.
- **size** (System.Drawing.SizeF) - Required - Set the Size of the Sprite.
- **position** (System.Drawing.PointF) - Required - Set the Position on screen where to draw the Sprite.
- **color** (System.Drawing.Color) - Required - Set the Color used to draw the Sprite.
- **rotation** (System.Single) - Required - Set the rotation to draw the sprite, measured in degrees, see also Rotation.
- **centered** (System.Boolean) - Required - Position the Sprite based on its center instead of top left corner, see also Centered.
```

--------------------------------

### RelationshipGroup.Hash

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.RelationshipGroup.Hash.html

Gets the hash for this RelationshipGroup.

```APIDOC
## Property Hash

### Description
Gets the hash for this RelationshipGroup.

### Declaration
```csharp
public int Hash { get; }

### Property Value
Type | Description
---|---
System.Int32 |

```

--------------------------------

### CreatePropNoOffset with Position and Rotation

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.World.CreatePropNoOffset.html

Spawns a prop at a specified position with a given rotation. Set dynamic to true for physics, false for static. Returns null if spawning fails.

```csharp
public static Prop CreatePropNoOffset(Model model, Vector3 position, Vector3 rotation, bool dynamic)
```

--------------------------------

### Camera.UpVector

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Camera.UpVector.html

Gets the up vector of this Camera.

```APIDOC
## Property UpVector

### Description
Gets the up vector of this Camera.

### Declaration
```csharp
public Vector3 UpVector { get; }
```

### Property Value
Type | Description
---|---
Vector3 | The up vector of the camera.
```

--------------------------------

### Get and Set Ped Injury Health Threshold

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Ped.InjuryHealthThreshold.html

Gets or sets the injury health threshold for a Ped. The pedestrian is considered injured when its health drops below this value. The pedestrian dies on attacks when its health is below this value. Should be below MaxHealth.

```csharp
public float InjuryHealthThreshold { get; set; }
```

--------------------------------

### Display Help Text with Beep

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Screen.ShowHelpTextThisFrame.html

Use this overload to display a help message that includes a beeping sound. The message will appear in the top corner of the screen for the current frame.

```csharp
public static void ShowHelpTextThisFrame(string helpText)
```

--------------------------------

### GTA Ped DropsEquippedWeaponOnDeath Property

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Ped.DropsEquippedWeaponOnDeath.html

Sets whether this Ped will drop the equipped weapon when they get killed. Peds will only drop their equipped weapon when they get killed. Set to true to enable dropping, false to disable.

```csharp
public bool DropsEquippedWeaponOnDeath { get; set; }
```

--------------------------------

### LoadingPrompt.IsActive

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.LoadingPrompt.html

Checks if the loading prompt is currently displayed.

```APIDOC
## IsActive

### Description
Gets a value indicating whether the Loading Prompt is currently being displayed.

### Property Type
`bool`

### Usage
`bool isActive = LoadingPrompt.IsActive;`
```

--------------------------------

### CustomSprite.Color

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.CustomSprite.Color.html

Gets or sets the color of this CustomSprite.

```APIDOC
## Property Color

### Description
Gets or sets the color of this CustomSprite.

### Declaration
```csharp
public Color Color { get; set; }
```

### Property Value
Type | Description
---|---
System.Drawing.Color | The color.

### Implements
IElement.Color
```

--------------------------------

### GTA.PedProp.Name

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.PedProp.Name.html

Gets the name of the ped prop.

```APIDOC
## Property Name

### Declaration
```csharp
public string Name { get; }
```

### Property Value
Type | Description
---|---
System.String | The name of the ped prop.

### Implements
IPedVariation.Name
```

--------------------------------

### Show(String, Boolean)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Notification.Show.html

Creates a simple notification above the minimap with the given message. Optionally, the notification can blink.

```APIDOC
## Show(String, Boolean)

### Description
Creates a Notification above the minimap with the given message. The notification can optionally blink.

### Method Signature
`public static int Show(string message, bool blinking = false)`

### Parameters
- **message** (System.String) - The message to display in the notification.
- **blinking** (System.Boolean) - Optional. If `true`, the notification will blink. Defaults to `false`.

### Returns
- **System.Int32** - The handle of the created notification, which can be used to hide it later using the `Hide(Int32)` method.
```

--------------------------------

### GTA.PedGroup.Enumerator.Current

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.PedGroup.Enumerator.Current.html

Gets the current Ped in the enumeration.

```APIDOC
## Property Current

### Declaration
```csharp
public Ped Current { get; }
```

### Property Value
Type | Description
---|---
Ped | The current Ped in the enumeration.

### Implements
System.Collections.Generic.IEnumerator<T>.Current
```

--------------------------------

### UseMobilePhone()

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.TaskInvoker.UseMobilePhone.html

Initiates the player's character using their mobile phone.

```APIDOC
## UseMobilePhone()

### Description
Initiates the player's character using their mobile phone.

### Method
public void UseMobilePhone()

### Parameters
None
```

--------------------------------

### TextElement Constructor with Caption, Position, Scale, and Color

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.TextElement.-ctor.html

Initializes a new TextElement with the specified caption, position, scale, and color.

```APIDOC
## TextElement(String, PointF, Single, Color)

### Description
Initializes a new instance of the TextElement class used for drawing text on the screen.

### Parameters
- **caption** (System.String) - The TextElement to draw.
- **position** (System.Drawing.PointF) - Set the Position on screen where to draw the TextElement.
- **scale** (System.Single) - Sets a Scale used to increase of decrease the size of the TextElement, for no scaling use 1.0f.
- **color** (System.Drawing.Color) - Set the Color used to draw the TextElement.
```

--------------------------------

### GTA.PedComponent.Name

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.PedComponent.Name.html

Gets the name of the ped component.

```APIDOC
## Property: Name

### Description
Gets the name of the ped component.

### Declaration
```csharp
public string Name { get; }
```

### Property Value
Type | Description
---|---
System.String | The name of the ped component.

### Implements
IPedVariation.Name
```

--------------------------------

### PedBoneCollection.Core

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.PedBoneCollection.Core.html

Gets the core bone of this Ped.

```APIDOC
## Property Core

### Description
Gets the core bone of this Ped.

### Declaration
```csharp
public PedBone Core { get; }
```

### Property Value
Type | Description
---|---
PedBone |
```

--------------------------------

### InitialDriveForce Property

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.HandlingData.InitialDriveForce.html

Gets or sets the power engine produces in top gear.

```APIDOC
## Property InitialDriveForce

### Description
Gets or sets the power engine produces in top gear.

### Declaration
```csharp
public float InitialDriveForce { get; set; }
```

### Property Value
Type | Description
---|---
System.Single | The power engine that produces in top gear.
```

--------------------------------

### Request ParticleEffectAsset

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.ParticleEffectAsset.Request.html

Attempts to load this ParticleEffectAsset into memory so it can be used for starting ParticleEffects. This is the basic version without a timeout.

```csharp
public void Request()
```

--------------------------------

### PedBoneCollection.Enumerator.Current

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.PedBoneCollection.Enumerator.Current.html

Gets the current PedBone in the collection.

```APIDOC
## Property Current

### Declaration
```csharp
public PedBone Current { get; }
```

### Property Value
Type | Description
---|---
PedBone | The current bone in the enumeration.

### Implements
System.Collections.Generic.IEnumerator<T>.Current
```

--------------------------------

### Checkpoint Methods

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Checkpoint.html

Lists the methods available for the Checkpoint class, along with their descriptions.

```APIDOC
### Methods
Name | Description
---|---
Delete() | Removes this Checkpoint.
Equals(Object) | Determines if an System.Object refers to the same checkpoint as this Checkpoint.
Exists() | Determines if this Checkpoint exists.
GetHashCode() |
```

--------------------------------

### GTA.Ped.Killer

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Ped.Killer.html

Gets the entity that killed this ped.

```APIDOC
## GTA.Ped.Killer

### Description
Gets the entity that killed this ped.

### Property Value
- **Type**: Entity
- **Description**: The entity that caused the ped's death. Returns null if the ped was not killed by an entity (e.g., suicide, environmental damage).
```

--------------------------------

### Set Radar Visibility

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Hud.IsRadarVisible.html

Use this to show or hide the radar. No setup is required.

```csharp
GTA.UI.Hud.IsRadarVisible = true; // Show radar
GTA.UI.Hud.IsRadarVisible = false; // Hide radar
```

--------------------------------

### PedGroup Property

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.Ped.PedGroup.html

Gets the PedGroup this Ped is in.

```APIDOC
## PedGroup Property

### Description
Gets the PedGroup this Ped is in.

### Declaration
```csharp
public PedGroup PedGroup { get; }
```

### Property Value
Type | Description
---|---
PedGroup |
```

--------------------------------

### Display Help Text with Optional Beep

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Screen.ShowHelpTextThisFrame.html

Use this overload to display a help message and control whether a beeping sound is played. The message will appear in the top corner of the screen for the current frame.

```csharp
public static void ShowHelpTextThisFrame(string helpText, bool beep)
```

--------------------------------

### ParticleEffectAsset.AssetName

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.ParticleEffectAsset.AssetName.html

Gets the name of the this ParticleEffectAsset file.

```APIDOC
## Property AssetName

### Description
Gets the name of the this ParticleEffectAsset file.

### Declaration
```csharp
public string AssetName { get; }
```

### Property Value
Type | Description
---|---
System.String | 
```

--------------------------------

### Show(NotificationIcon, String, String, String, Boolean, Boolean)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Notification.Show.html

Creates an advanced SMS-alike notification above the minimap. This includes an icon, sender, subject, and message, with options for fading in and blinking.

```APIDOC
## Show(NotificationIcon, String, String, String, Boolean, Boolean)

### Description
Creates a more advanced (SMS-alike) Notification above the minimap showing a sender icon, subject, and the message. Options for fade-in and blinking are available.

### Method Signature
`public static int Show(NotificationIcon icon, string sender, string subject, string message, bool fadeIn = false, bool blinking = false)`

### Parameters
- **icon** (NotificationIcon) - The icon to display for the notification.
- **sender** (System.String) - The name of the sender.
- **subject** (System.String) - The subject line of the message.
- **message** (System.String) - The main content of the message.
- **fadeIn** (System.Boolean) - Optional. If `true`, the message will fade in. Defaults to `false`.
- **blinking** (System.Boolean) - Optional. If `true`, the notification will blink. Defaults to `false`.

### Returns
- **System.Int32** - The handle of the created notification, which can be used to hide it later using the `Hide(Int32)` method.
```

--------------------------------

### IPedVariation.Name

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.IPedVariation.Name.html

Gets the name of the ped variation.

```APIDOC
## Name Property

### Description
Gets the name of the ped variation.

### Declaration
```csharp
string Name { get; }
```

### Property Value
Type | Description
---|---
System.String | The name of the ped variation.
```

--------------------------------

### TextElement Constructor with Caption, Position, Scale, Color, Font, and Alignment

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.TextElement.-ctor.html

Initializes a new TextElement with the specified caption, position, scale, color, font, and alignment.

```APIDOC
## TextElement(String, PointF, Single, Color, Font, Alignment)

### Description
Initializes a new instance of the TextElement class used for drawing text on the screen.

### Parameters
- **caption** (System.String) - The TextElement to draw.
- **position** (System.Drawing.PointF) - Set the Position on screen where to draw the TextElement.
- **scale** (System.Single) - Sets a Scale used to increase of decrease the size of the TextElement, for no scaling use 1.0f.
- **color** (System.Drawing.Color) - Set the Color used to draw the TextElement.
- **font** (Font) - Sets the Font used when drawing the text.
- **alignment** (Alignment) - Sets the Alignment used when drawing the text, Left,Center or Right.
```

--------------------------------

### Sprite Constructor with Color and Opacity

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Sprite.html

Initializes a new instance of the Sprite class with a specified color and opacity. The opacity can be used to control transparency.

```csharp
new Sprite("textureName", "textureName", new SizeF(100f, 100f), new PointF(100f, 100f), Color.Red, 0.5f)
```

--------------------------------

### SwapWeapon Method

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.TaskInvoker.SwapWeapon.html

The SwapWeapon method allows for swapping weapons within the game. It does not take any parameters and returns void.

```APIDOC
## Method SwapWeapon

### Description
Swaps the player's current weapon.

### Signature
```csharp
public void SwapWeapon()
```

### Parameters
This method does not accept any parameters.

### Returns
This method does not return any value.
```

--------------------------------

### EntityBoneCollection.Count

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.EntityBoneCollection.Count.html

Gets the number of bones that this Entity has.

```APIDOC
## Property Count

### Description
Gets the number of bones that this Entity has.

### Declaration
```csharp
public int Count { get; }
```

### Property Value
Type | Description
---|---
System.Int32 | 
```

--------------------------------

### Turn on Vehicle Neon Lights

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.VehicleModCollection.SetNeonLightsOn.html

Use this method to turn on specific neon lights on a vehicle. Ensure the vehicle and the desired neon light type are valid.

```csharp
public void SetNeonLightsOn(VehicleNeonLight light, bool on)
```

--------------------------------

### EntityBone.Index

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.EntityBone.Index.html

Gets the bone index of this EntityBone.

```APIDOC
## Index Property

### Description
Gets the bone index of this EntityBone.

### Declaration
```csharp
public int Index { get; }

```

### Property Value
Type | Description  
---|---
System.Int32 | 
```

--------------------------------

### Notification.Show (Simple)

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.Notification.html

Creates a simple Notification above the minimap with the given message.

```APIDOC
## Show(String, Boolean)

### Description
Creates a Notification above the minimap with the given message.

### Method
public static void Show(String message, Boolean p2)

### Parameters
#### Path Parameters
- **message** (String) - Required - The message to display.
- **p2** (Boolean) - Required - Unknown parameter.
```

--------------------------------

### GTA.WeaponComponent.DisplayName

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.WeaponComponent.DisplayName.html

Gets the display name of the weapon component.

```APIDOC
## Property DisplayName

### Description
Gets the display name of the weapon component.

### Declaration
```csharp
public string DisplayName { get; }
```

### Property Value
Type | Description
---|---
System.String | The display name of the weapon component.
```

--------------------------------

### GTA.WeaponComponent.LocalizedName

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.WeaponComponent.LocalizedName.html

Gets the localized name of the weapon component.

```APIDOC
## Property LocalizedName

### Declaration
```csharp
public string LocalizedName { get; }
```

### Description
Gets the localized name of the weapon component.

### Property Value
Type | Description
---|---
System.String | The localized name of the weapon component.
```

--------------------------------

### Show a Loading Prompt

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.LoadingPrompt.Show.html

Displays a loading prompt at the bottom right of the screen with custom text and a spinner. The spinner type can be specified, with RegularClockwise being the default and commonly used by Rockstar.

```csharp
GTA.UI.LoadingPrompt.Show("Loading data...");
```

```csharp
GTA.UI.LoadingPrompt.Show("Processing request", LoadingSpinnerType.BikeWheel);
```

--------------------------------

### VehicleWindowCollection.Item

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.VehicleWindowCollection.Item.html

Gets a VehicleWindow from the collection at the specified index.

```APIDOC
## VehicleWindowCollection.Item

### Description
Gets a specific `VehicleWindow` from the `VehicleWindowCollection` using its index.

### Method
get

### Endpoint
VehicleWindowCollection[VehicleWindowIndex index]

### Parameters
#### Path Parameters
- **index** (VehicleWindowIndex) - Required - The index of the `VehicleWindow` to retrieve.

### Property Value
- **VehicleWindow** - The `VehicleWindow` object at the specified index.
```

--------------------------------

### ContainerElement()

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.UI.ContainerElement.-ctor.html

Initializes a new instance of the ContainerElement class with default values.

```APIDOC
## ContainerElement()

### Description
Initializes a new instance of the ContainerElement class used for grouping items on screen.

### Method
```csharp
public ContainerElement()
```
```

--------------------------------

### Request()

Source: https://nitanmarcel.github.io/scripthookvdotnet/scripting_v3/GTA.ParticleEffectAsset.Request.html

Attempts to load this ParticleEffectAsset into memory so it can be used for starting ParticleEffects. This is a synchronous call that will block until the asset is loaded or an internal timeout occurs.

```APIDOC
## Request()

### Description
Attempts to load this ParticleEffectAsset into memory so it can be used for starting ParticleEffects.

### Method
```csharp
public void Request()
```
```
Tokens:
Raw