RageCoop

https://docs.ragecoop.com
Admin
RageCoop is a multiplayer mod for GTA V that brings a multiplayer experience to story mode, allowing...
Tokens:241,524
Snippets:3,151
Trust Score:4.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start()

Source: https://docs.ragecoop.com/API/RageCoop.Server.Server.html

Starts the server and spawns necessary threads.

```APIDOC
## Start()

### Description
Spawns threads and starts the server operations.
```

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

### Start()

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.CustomHelper.html

Starts the Natural Motion behavior on the Ped.

```APIDOC
### Methods
public void Start()
public void Start(int duration)

### Parameters
- **duration** (Int32) - How long to apply the behavior for (-1 for looped).
```

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

### Start Methods

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.CustomHelper.html

Starts the Natural Motion behavior on the Ped, optionally for a specified duration.

```csharp
public void Start()
```

```csharp
public void Start(int duration)
```

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

### IsInstalled Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleToggleMod.html

Gets or sets the installation status of the modification.

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

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

### Configure Time at Start Values

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.StaggerFallHelper.html

Sets the duration for maintaining start values for arms and spine stiffness/damping.

```csharp
public float TimeAtStartValues { set; }
```

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

### Configure Time to Start Ending

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.StaggerFallHelper.html

Sets the time from the start of the behavior before lower body stiffness begins ramping down.

```csharp
public float TimeStartEnd { set; }
```

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

### InstallModKit()

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Installs the modification kit on the vehicle.

```APIDOC
## void InstallModKit()

### Description
Installs the modification kit on the vehicle.
```

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

### StartAlarm()

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Starts the vehicle alarm.

```APIDOC
### Method
public void StartAlarm()
```

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

### InstallModKit Method

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Installs the mod kit on the vehicle.

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

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

### IsEngineStarting

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

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

```APIDOC
## Property: IsEngineStarting

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

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

### Return Value
- **Boolean** - true if this Vehicle's engine is starting; otherwise, false.
```

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

### VelMultiplierStart Property

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureShotInjuredArmHelper.html

Sets the start velocity for parameter scaling.

```csharp
public float VelMultiplierStart { set; }
```

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

### Configure ImpulseVelStart

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureBulletsHelper.html

Sets the start threshold for velocity-based impulse calculations.

```csharp
public float ImpulseVelStart { set; }
```

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

### Configure RdsStartingFrictionMin

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.SmartFallHelper.html

Sets the minimum starting friction for Catch Fall/RDS.

```csharp
public float RdsStartingFrictionMin { set; }
```

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

### Configure ImpulseBalStabStart

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureBulletsExtraHelper.html

Sets the starting threshold for impulse balance stabilization.

```csharp
public float ImpulseBalStabStart { set; }
```

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

### Build the project

Source: https://docs.ragecoop.com/README.html

Execute this command in the solution directory to compile the project and generate binaries in the bin folder.

```bash
dotnet build
```

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

### WheelType Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Gets or sets the type of wheels installed on the vehicle.

```csharp
public VehicleWheelType WheelType { get; set; }
```

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

### Server Constructor

Source: https://docs.ragecoop.com/API/RageCoop.Server.Server.html

Instantiates a new server instance with the provided settings and optional logger.

```csharp
public Server(Settings settings, Logger logger = null)
```

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

### Configure ImpulseSpineAngStart

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureBulletsExtraHelper.html

Sets the start threshold for spine angle-based impulse scaling.

```csharp
public float ImpulseSpineAngStart { set; }
```

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

### MainWindow()

Source: https://docs.ragecoop.com/API/RageCoop.Client.Installer.MainWindow.html

Initializes a new instance of the MainWindow class.

```APIDOC
## MainWindow()

### Description
Initializes a new instance of the MainWindow class.

### Syntax
```csharp
public MainWindow()
```
```

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

### DontStepTime

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureBalanceHelper.html

Sets the amount of time at the start of a balance before the character is allowed to start stepping.

```APIDOC
## public float DontStepTime { set; }

### Description
Amount of time at the start of a balance before the character is allowed to start stepping. Default value is 0.0f.
```

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

### Server(Settings, Logger)

Source: https://docs.ragecoop.com/API/RageCoop.Server.Server.html

Constructor to instantiate a new RageCoop server instance.

```APIDOC
## Server(Settings settings, Logger logger = null)

### Description
Instantiates a new server instance with the provided settings and optional logger.

### Parameters
- **settings** (Settings) - Required - The server configuration settings.
- **logger** (Logger) - Optional - The logger instance to use for server output.

### Exceptions
- **ArgumentNullException** - Thrown if required arguments are missing.
```

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

### Show Method

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.LoadingPrompt.html

Displays a loading prompt with optional text and spinner style.

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

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

### CreateCamera Method

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Initializes a new camera; use RenderingCamera to activate it.

```csharp
public static Camera CreateCamera(Vector3 position, Vector3 rotation, float fov)
```

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

### ShowHelpText Method

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.Screen.html

Displays a help message in the top corner of the screen.

```csharp
public static void ShowHelpText(string helpText, int duration = -1, bool beep = true, bool looped = false)
```

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

### GetSuppressorComponent()

Source: https://docs.ragecoop.com/SHVDN/GTA.WeaponComponentCollection.html

Gets the suppressor component.

```APIDOC
### Method
`public WeaponComponent GetSuppressorComponent()`

### Returns
- **WeaponComponent** - The WeaponComponent instance if found; otherwise, the instance representing the invalid component.
```

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

### ShowHelpText(String, Int32, Boolean, Boolean)

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.Screen.html

Displays a help message in the top corner of the screen. Supports duration, audio feedback, and looping.

```APIDOC
## public static void ShowHelpText(string helpText, int duration = -1, bool beep = true, bool looped = false)

### Description
Displays a help message in the top corner of the screen infinitely or for a specified duration.

### Parameters
- **helpText** (String) - The text to display.
- **duration** (Int32) - The duration in real time. If not positive, defaults to 7.5 seconds.
- **beep** (Boolean) - Whether to play a beeping sound.
- **looped** (Boolean) - Whether to show this help message forever.
```

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

### GetFlashLightComponent()

Source: https://docs.ragecoop.com/SHVDN/GTA.WeaponComponentCollection.html

Gets the flashlight component.

```APIDOC
### Method
`public WeaponComponent GetFlashLightComponent()`

### Returns
- **WeaponComponent** - The WeaponComponent instance if found; otherwise, the instance representing the invalid component.
```

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

### Driver Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets the driver of the vehicle.

```csharp
public Ped Driver { get; }
```

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

### InitializeComponent()

Source: https://docs.ragecoop.com/API/RageCoop.Client.Installer.MainWindow.html

Initializes the components of the MainWindow.

```APIDOC
## InitializeComponent()

### Description
Initializes the components of the MainWindow.

### Syntax
```csharp
public void InitializeComponent()
```
```

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

### ClassType Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets the VehicleClass of the vehicle.

```csharp
public VehicleClass ClassType { get; }
```

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

### StartEffect Method

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.Screen.html

Initiates a screen effect with optional duration and looping.

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

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

### Size

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.ISpriteElement.html

Gets or sets the size of the ISpriteElement.

```APIDOC
### Property: Size

**Declaration:** `SizeF Size { get; set; }`

**Description:** Gets or sets the size to draw the ISpriteElement on a 1280*720 pixel base. If ScaledDraw is called, the size will be scaled by the width returned in ScaledWidth.

**Type:** SizeF
```

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

### Projectile.WeaponHash

Source: https://docs.ragecoop.com/SHVDN/GTA.Projectile.html

Gets the WeaponHash associated with the projectile.

```APIDOC
## Property: WeaponHash

### Description
Gets the WeaponHash this Projectile was fired with.

### Type
WeaponHash
```

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

### Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ArmsWindmillAdaptiveHelper.html

Initializes a new instance of the helper for a specific ped.

```csharp
public ArmsWindmillAdaptiveHelper(Ped ped)
```

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

### Projectile.OwnerEntity

Source: https://docs.ragecoop.com/SHVDN/GTA.Projectile.html

Gets the Entity that owns the projectile.

```APIDOC
## Property: OwnerEntity

### Description
Gets the Entity this Projectile belongs to. Returns null if no owner is assigned.

### Type
Entity
```

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

### Load Method

Source: https://docs.ragecoop.com/SHVDN/GTA.ScriptSettings.html

Loads settings from a specified file path.

```csharp
public static ScriptSettings Load(string filename)
```

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

### PoolObject.Handle

Source: https://docs.ragecoop.com/SHVDN/GTA.PoolObject.html

Gets or sets the handle of the object.

```APIDOC
## Property Handle

### Description
The handle of the object.

### Type
Int32

### Access
Public getter, protected setter
```

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

### Main Method

Source: https://docs.ragecoop.com/API/RageCoop.Client.Installer.App.html

The application entry point marked with the STAThread attribute.

```csharp
[STAThread]
public static void Main()
```

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

### Current

Source: https://docs.ragecoop.com/SHVDN/GTA.PedGroup.Enumerator.html

Gets the current Ped in the iteration.

```APIDOC
### Property
`public Ped Current { get; }`

#### Returns
- **Ped** - The current Ped object.
```

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

### Rotation

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets or sets the rotation of this Entity.

```APIDOC
## Property: Rotation

### Description
Gets or sets the rotation of this Entity.

### Declaration
`public virtual Vector3 Rotation { get; set; }`

### Returns
- **Vector3** - The yaw, pitch, and roll rotation values.
```

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

### LoadingPrompt.Show(String, LoadingSpinnerType)

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.LoadingPrompt.html

Creates a loading prompt at the bottom right of the screen with the specified text and spinner style.

```APIDOC
## Method: Show(string loadingText, LoadingSpinnerType spinnerType)

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

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

### Parameters
- **loadingText** (String) - Optional - The text to display next to the spinner.
- **spinnerType** (LoadingSpinnerType) - Optional - The style of spinner to draw.

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

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

### MaterialCollidingWith

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets the material this Entity is pushing up against.

```APIDOC
## Property: MaterialCollidingWith

### Description
Gets the material this Entity is pushing up against. Returns None if the entity is not colliding with a material.

### Declaration
`public MaterialHash MaterialCollidingWith { get; }`

### Returns
- **MaterialHash** - A material hash if this Entity has collision; otherwise, None.
```

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

### HeightAboveGround

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets the height of the entity above the ground.

```APIDOC
## Property: HeightAboveGround

### Description
Gets how high above ground this Entity is.

### Declaration
`public float HeightAboveGround { get; }`

### Return Type
Single
```

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

### ImpulseBalStabStart

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureBulletsHelper.html

Sets the start value for impulse balance stabilization. Default is 3.0.

```APIDOC
### Property: ImpulseBalStabStart

- **Type**: float
- **Setter**: public
- **Default**: 3.0f
- **Range**: 0.0f - 100.0f
```

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

### Core

Source: https://docs.ragecoop.com/SHVDN/GTA.EntityBoneCollection.html

Gets the core bone of the entity.

```APIDOC
### Property: Core

**Description**: Gets the core bone of this Entity.

**Type**: EntityBone
```

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

### Current

Source: https://docs.ragecoop.com/SHVDN/GTA.EntityBoneCollection.Enumerator.html

Gets the current EntityBone in the collection.

```APIDOC
## Property: Current

### Description
Gets the current EntityBone in the collection.

### Returns
- **EntityBone** - The current bone.
```

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

### GetAll Methods

Source: https://docs.ragecoop.com/API/RageCoop.Server.Scripting.ServerEntities.html

Methods to retrieve collections of entities currently on the server.

```csharp
public ServerBlip[] GetAllBlips()
public ServerPed[] GetAllPeds()
public ServerProp[] GetAllProps()
public ServerVehicle[] GetAllVehicles()
```

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

### CreateAmbientPickup Method

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Spawns a pickup prop at a specific location.

```csharp
public static Prop CreateAmbientPickup(PickupType type, Vector3 position, Model model, int value)
```

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

### GetZoneLocalizedName

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Gets the localized name of a zone in the map.

```APIDOC
## public static string GetZoneLocalizedName(Vector2 position)
## public static string GetZoneLocalizedName(Vector3 position)

### Description
Gets the localized name of a zone in the map.

### Parameters
- **position** (Vector2/Vector3) - The position on the map.

### Returns
- **String** - The localized name of the zone.
```

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

### GetZoneDisplayName

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Gets the display name of a zone in the map.

```APIDOC
## public static string GetZoneDisplayName(Vector2 position)
## public static string GetZoneDisplayName(Vector3 position)

### Description
Gets the display name of a zone in the map. Use GetLocalizedString(String) to convert to the localized name.

### Parameters
- **position** (Vector2/Vector3) - The position on the map.

### Returns
- **String** - The display name of the zone.
```

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

### Weather

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Gets or sets the current weather state.

```APIDOC
## Property: Weather

### Description
Gets or sets the current weather.

### Declaration
`public static Weather Weather { get; set; }`

### Property Value
- **Type**: Weather
- **Description**: The weather.
```

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

### NextWeather

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Gets or sets the upcoming weather state.

```APIDOC
## Property: NextWeather

### Description
Gets or sets the next weather.

### Declaration
`public static Weather NextWeather { get; set; }`

### Property Value
- **Type**: Weather
- **Description**: The next weather.
```

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

### ShowHelpTextThisFrame Methods

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.Screen.html

Displays a help message in the top corner of the screen for the current frame.

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

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

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

### HandlingData Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets the handling data for the vehicle.

```csharp
public HandlingData HandlingData { get; }
```

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

### Load(String)

Source: https://docs.ragecoop.com/SHVDN/GTA.ScriptSettings.html

Loads a ScriptSettings instance from a specified file path.

```APIDOC
## Load(string filename)

### Description
Loads a ScriptSettings object from the specified file.

### Parameters
- **filename** (string) - Required - The filename to load the settings from.

### Returns
- **ScriptSettings** - The loaded settings instance.
```

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

### Create Client Resource Symlink

Source: https://docs.ragecoop.com/index.html

Command to link a development folder to the client resources directory.

```batch
mklink /d ServerRoot/Resources/Client/NiceGuy.MyFirstClientResource C:/MyRepos/NiceGuy.MyFirstClientResource/bin/Debug
```

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

### EngineTemperature Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets the engine temperature of the vehicle.

```csharp
public float EngineTemperature { get; }
```

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

### Doors Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets the collection of doors for the vehicle.

```csharp
public VehicleDoorCollection Doors { get; }
```

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

### Camera(int handle)

Source: https://docs.ragecoop.com/SHVDN/GTA.Camera.html

Initializes a new instance of the Camera class using a specific native handle.

```APIDOC
## Camera(int handle)

### Description
Creates a new Camera object instance associated with the provided native handle.

### Syntax
`public Camera(int handle)`

### Parameters
- **handle** (Int32) - The native handle of the camera entity.
```

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

### InitializeComponent Method

Source: https://docs.ragecoop.com/API/RageCoop.Client.Installer.App.html

Method used to initialize the application components.

```csharp
public void InitializeComponent()
```

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

### Vehicle

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleWheelCollection.html

Gets the Vehicle instance that this collection belongs to.

```APIDOC
## Property: Vehicle

### Description
Gets the Vehicle instance this VehicleWheelCollection belongs to.

### Declaration
`public Vehicle Vehicle { get; }`

### Returns
- **Vehicle** - The owner vehicle.
```

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

### ConfigureBalanceHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureBalanceHelper.html

Initializes a new instance of the helper for a specific Ped.

```csharp
public ConfigureBalanceHelper(Ped ped)
```

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

### Type Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleToggleMod.html

Gets the specific VehicleToggleModType of the modification.

```csharp
public VehicleToggleModType Type { get; }
```

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

### TargetedEntity

Source: https://docs.ragecoop.com/SHVDN/GTA.Player.html

Gets the entity currently being free-aimed by the player.

```APIDOC
## Property: TargetedEntity

### Description
Gets the Entity this Player is free aiming.

### Declaration
`public Entity TargetedEntity { get; }`

### Property Value
- **Type**: Entity
- **Description**: The Entity if this Player is free aiming any Entity; otherwise, null
```

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

### Color Property

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.CustomSprite.html

Gets or sets the color of the CustomSprite.

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

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

### ShotInGutsHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ShotInGutsHelper.html

Initializes a new instance of the ShotInGutsHelper for a specific Ped.

```csharp
public ShotInGutsHelper(Ped ped)
```

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

### Rotation

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.ISpriteElement.html

Gets or sets the rotation of the ISpriteElement in degrees.

```APIDOC
### Property: Rotation

**Declaration:** `float Rotation { get; set; }`

**Description:** Gets or sets the rotation to draw the ISpriteElement. The value is measured in degrees, clockwise increasing, with 0.0 at vertical.

**Type:** Single
```

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

### ConfigureSelfAvoidanceHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureSelfAvoidanceHelper.html

Initializes a new instance of the helper for a specific Ped.

```csharp
public ConfigureSelfAvoidanceHelper(Ped ped)
```

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

### Length

Source: https://docs.ragecoop.com/SHVDN/GTA.Rope.html

Property to get or set the length of the rope.

```APIDOC
## Property: Length

### Description
Gets or sets the length of this Rope.

### Type
Single (float)
```

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

### Building Method Declarations

Source: https://docs.ragecoop.com/SHVDN/GTA.Building.html

Declarations for methods used to interact with building instances.

```csharp
public override bool Equals(object obj)
```

```csharp
public bool Exists()
```

```csharp
public static Building FromHandle(int handle)
```

```csharp
public override int GetHashCode()
```

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

### IsRadarVisible Property

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.Hud.html

Gets or sets the visibility of the radar.

```csharp
public static bool IsRadarVisible { get; set; }
```

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

### Configure Steps Before Stiffness Reduction

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.StaggerFallHelper.html

Sets the number of steps taken before lower body stiffness begins to ramp down.

```csharp
public int StepsTillStartEnd { set; }
```

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

### ConfigureConstraintsHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureConstraintsHelper.html

Initializes a new instance of the helper for a specific Ped.

```csharp
public ConfigureConstraintsHelper(Ped ped)
```

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

### PedBone.Owner

Source: https://docs.ragecoop.com/SHVDN/GTA.PedBone.html

Gets the Ped entity that owns this bone.

```APIDOC
## Property: Owner

### Description
Gets the Ped entity that owns this bone.

### Declaration
`public Ped Owner { get; }`

### Property Value
- **Type**: Ped
- **Description**: The Ped entity associated with this bone.
```

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

### Current

Source: https://docs.ragecoop.com/SHVDN/GTA.PedBoneCollection.Enumerator.html

Gets the current PedBone element in the collection.

```APIDOC
### Property
`public PedBone Current { get; }`

#### Returns
- **PedBone** - The current element in the collection.
```

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

### Settings Class Syntax

Source: https://docs.ragecoop.com/API/RageCoop.Client.Settings.html

The base class definition for client settings.

```csharp
public class Settings
```

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

### ShowHelpTextThisFrame(String, Boolean)

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.Screen.html

Displays a help message in the top corner of the screen for the current frame only.

```APIDOC
## public static void ShowHelpTextThisFrame(string helpText, bool beep = true)

### Description
Displays a help message in the top corner of the screen for the current frame. Optionally plays a beeping sound.

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

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

### Speed

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets or sets this Entity's speed.

```APIDOC
## public float Speed { get; set; }

### Description
Gets or sets this Entity's speed.

### Property Value
- **Single** - The speed in m/s.
```

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

### LeftPosition

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets a position directly to the left of this Entity.

```APIDOC
## Property: LeftPosition

### Description
Gets a position directly to the left of this Entity.

### Declaration
`public Vector3 LeftPosition { get; }`
```

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

### Create Server Resource Symlink

Source: https://docs.ragecoop.com/index.html

Command to link a development folder to the server resources directory.

```batch
mklink /d ServerRoot/Resources/Server/NiceGuy.MyFirstResource C:/MyRepos/NiceGuy.MyFirstResource/bin/Debug
```

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

### LoadingPrompt.IsActive

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.LoadingPrompt.html

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

```APIDOC
## Property: IsActive

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

### Declaration
`public static bool IsActive { get; }`

### Returns
- **Boolean** - True if the loading prompt is active, otherwise false.
```

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

### ServerSettings Class Syntax

Source: https://docs.ragecoop.com/API/RageCoop.Server.ServerSettings.html

The base class definition for server configuration.

```csharp
public class ServerSettings
```

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

### IsInvincible

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets or sets whether the entity is invincible.

```APIDOC
## Property: IsInvincible

### Description
Gets or sets a value indicating whether this Entity is invincible. Setting this property to true does not prevent Peds from doing the reactions for getting hit with melee attacks.

### Declaration
`public bool IsInvincible { get; set; }`

### Return Type
Boolean
```

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

### LeanTowardsObjectHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.LeanTowardsObjectHelper.html

Initializes a new instance of the helper for a specific Ped.

```csharp
public LeanTowardsObjectHelper(Ped ped)
```

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

### GetResult<T>()

Source: https://docs.ragecoop.com/SHVDN/GTA.Native.OutputArgument.html

Gets the value of data stored in this OutputArgument.

```APIDOC
## GetResult<T>()

### Description
Gets the value of data stored in this OutputArgument.

### Returns
- **T** - The value stored in the argument.
```

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

### GetInteriorProxyFromGameplayCam()

Source: https://docs.ragecoop.com/SHVDN/GTA.InteriorProxy.html

Gets the InteriorProxy if the gameplay camera is in an interior.

```APIDOC
## public static InteriorProxy GetInteriorProxyFromGameplayCam()

### Description
Gets the InteriorProxy if the gameplay camera is in an interior. Returns null if the gameplay camera is not in any interior space.
```

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

### Host Property

Source: https://docs.ragecoop.com/API/RageCoop.Server.Scripting.API.html

Gets or sets the client responsible for synchronizing time and weather.

```csharp
public Client Host { get; set; }
```

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

### Access ConfigureBalance Helper

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.Euphoria.html

Retrieves the helper class for configuring dynamic balance parameters.

```csharp
public ConfigureBalanceHelper ConfigureBalance { get; }
```

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

### Matrix Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Camera.html

Gets the transformation matrix of the camera.

```csharp
public Matrix Matrix { get; }
```

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

### Count

Source: https://docs.ragecoop.com/SHVDN/GTA.EntityBoneCollection.html

Gets the total number of bones in the entity.

```APIDOC
### Property: Count

**Description**: Gets the number of bones that this Entity has.

**Type**: Int32
```

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

### ShotConfigureArmsHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ShotConfigureArmsHelper.html

Initializes a new instance of the helper for a specific Ped.

```csharp
public ShotConfigureArmsHelper(Ped ped)
```

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

### Building Class Syntax

Source: https://docs.ragecoop.com/SHVDN/GTA.Building.html

The class definition for Building, which implements IExistable.

```csharp
public class Building : IExistable
```

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

### Type Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Blip.html

Gets the type identifier of the blip.

```csharp
public int Type { get; }
```

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

### Current Property

Source: https://docs.ragecoop.com/SHVDN/GTA.EntityBoneCollection.Enumerator.html

Gets the current EntityBone in the iteration.

```csharp
public EntityBone Current { get; }
```

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

### Configure UsePistolIK property

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.PointGunHelper.html

Enables or disables new IK for pistol pointing. Defaults to true.

```csharp
public bool UsePistolIK { set; }
```

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

### Style

Source: https://docs.ragecoop.com/SHVDN/GTA.CheckpointCustomIcon.html

Gets or sets the icon style for the checkpoint.

```APIDOC
## Style

### Description
Gets or sets the icon style.
```

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

### CreateVehicle Method

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Spawns a vehicle at a specific position and heading. Returns null if the vehicle fails to spawn.

```csharp
public static Vehicle CreateVehicle(Model model, Vector3 position, float heading = 0F)
```

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

### ClientScript Lifecycle Methods

Source: https://docs.ragecoop.com/API/RageCoop.Client.Scripting.ClientScript.html

Methods for handling script startup and shutdown, executed on a background thread.

```csharp
public abstract void OnStart()
```

```csharp
public abstract void OnStop()
```

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

### ConfigureSoftLimitHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureSoftLimitHelper.html

Initializes a new instance of the helper for a specific ped.

```csharp
public ConfigureSoftLimitHelper(Ped ped)
```

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

### CreateAmbientPickup

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Spawns a pickup Prop at the specified position.

```APIDOC
## CreateAmbientPickup(PickupType, Vector3, Model, Int32)

### Description
Spawns a pickup Prop at the specified position.

### Signature
`public static Prop CreateAmbientPickup(PickupType type, Vector3 position, Model model, int value)`

### Parameters
- **type** (PickupType)
- **position** (Vector3)
- **model** (Model)
- **value** (Int32)

### Returns
- **Prop**
```

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

### Weather Property

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Gets or sets the current weather state.

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

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

### NextWeather Property

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Gets or sets the upcoming weather state.

```csharp
public static Weather NextWeather { get; set; }
```

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

### HipsLeanInDirectionHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.HipsLeanInDirectionHelper.html

Initializes a new instance of the helper for a specific ped.

```csharp
public HipsLeanInDirectionHelper(Ped ped)
```

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

### HighGear Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets or sets the high gear value.

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

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

### Command Constructor

Source: https://docs.ragecoop.com/API/RageCoop.Server.Scripting.Command.html

Initializes a new instance of the Command attribute with a specified name.

```csharp
public Command(string name)
```

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

### FuelLevel Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets or sets the vehicle fuel level.

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

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

### EnginePowerMultiplier Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets or sets the engine power multiplier.

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

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

### Script()

Source: https://docs.ragecoop.com/SHVDN/GTA.Script.html

Initializes a new instance of the Script class. Scripts must inherit from this class and have a default public constructor to be detected.

```APIDOC
## public Script()

### Description
Initializes a new instance of the Script class. Only scripts that inherit directly from this class and have a default (parameterless) public constructor will be detected and started.
```

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

### EngineHealth Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets or sets the vehicle engine health.

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

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

### CreatePickup

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Spawns a Pickup at the specified position.

```APIDOC
## CreatePickup(PickupType, Vector3, Vector3, Model, Int32)

### Description
Spawns a Pickup at the specified position with rotation.

### Signature
`public static Pickup CreatePickup(PickupType type, Vector3 position, Vector3 rotation, Model model, int value)`

### Parameters
- **type** (PickupType)
- **position** (Vector3)
- **rotation** (Vector3)
- **model** (Model)
- **value** (Int32)

### Returns
- **Pickup**
```

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

### Server Lifecycle Methods

Source: https://docs.ragecoop.com/API/RageCoop.Server.Server.html

Methods to control the execution state of the server.

```csharp
public void Start()
```

```csharp
public void Stop()
```

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

### CurrentGear Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets or sets the current gear of the vehicle.

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

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

### ShotInGutsHelper Properties

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ShotInGutsHelper.html

Properties to configure the specific parameters of the shot-in-guts reaction.

```csharp
public bool ShotInGuts { set; }
```

```csharp
public float SigForceBalancePeriod { set; }
```

```csharp
public float SigHipAmount { set; }
```

```csharp
public float SigKneeAmount { set; }
```

```csharp
public float SigKneesOnset { set; }
```

```csharp
public float SigNeckAmount { set; }
```

```csharp
public float SigPeriod { set; }
```

```csharp
public float SigSpineAmount { set; }
```

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

### ClassLocalizedName Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets the localized name of the vehicle class.

```csharp
public string ClassLocalizedName { get; }
```

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

### ClassDisplayName Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets the display name of the vehicle class.

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

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

### ReleaseSound(Int32)

Source: https://docs.ragecoop.com/SHVDN/GTA.Audio.html

Releases a sound instance to free resources.

```APIDOC
## ReleaseSound(Int32)

### Description
Releases the specified sound instance. Call this for every sound effect started.

### Parameters
- **id** (Int32) - Required - The identifier of the active sound effect instance.
```

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

### CanJump Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Vehicle.html

Gets whether the vehicle is capable of jumping.

```csharp
public bool CanJump { get; }
```

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

### ShotNewBulletHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ShotNewBulletHelper.html

Initializes a new instance of the helper for a specific Ped.

```csharp
public ShotNewBulletHelper(Ped ped)
```

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

### Screen Transition and Effect Methods

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.Screen.html

Methods for controlling screen transitions and querying active screen effects.

```csharp
public static void FadeIn(int time)
```

```csharp
public static void FadeOut(int time)
```

```csharp
public static bool IsEffectActive(ScreenEffect effectName)
```

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

### GetScopeComponent(Int32)

Source: https://docs.ragecoop.com/SHVDN/GTA.WeaponComponentCollection.html

Gets the scope component at the specified index.

```APIDOC
### Method
`public WeaponComponent GetScopeComponent(int index)`

### Parameters
- **index** (Int32) - The index of the scope component subset of all the weapon component array.

### Returns
- **WeaponComponent** - A WeaponComponent instance if found; otherwise, the instance representing the invalid component.
```

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

### App Class Syntax

Source: https://docs.ragecoop.com/API/RageCoop.Client.Installer.App.html

The class definition for the application entry point.

```csharp
public class App : Application, IQueryAmbient
```

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

### GetGunRootComponent(Int32)

Source: https://docs.ragecoop.com/SHVDN/GTA.WeaponComponentCollection.html

Gets the component for GunRoot at the specified index.

```APIDOC
### Method
`public WeaponComponent GetGunRootComponent(int index)`

### Parameters
- **index** (Int32) - The index of the components for GunRoot subset of all the weapon component array.

### Returns
- **WeaponComponent** - A WeaponComponent instance if found; otherwise, the instance representing the invalid component.
```

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

### GetClipComponent(Int32)

Source: https://docs.ragecoop.com/SHVDN/GTA.WeaponComponentCollection.html

Gets the clip component at the specified index.

```APIDOC
### Method
`public WeaponComponent GetClipComponent(int index)`

### Parameters
- **index** (Int32) - The index of the clip component subset of all the weapon component array.

### Returns
- **WeaponComponent** - A WeaponComponent instance if found; otherwise, the instance representing the invalid component.
```

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

### MainWindow Class Definition

Source: https://docs.ragecoop.com/API/RageCoop.Client.Installer.MainWindow.html

The class definition for the main installer window, inheriting from Window and implementing several WPF interfaces.

```csharp
public class MainWindow : Window, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IQueryAmbient, IAddChild, IComponentConnector
```

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

### GetBarrelComponent(Int32)

Source: https://docs.ragecoop.com/SHVDN/GTA.WeaponComponentCollection.html

Gets the barrel component at the specified index.

```APIDOC
### Method
`public WeaponComponent GetBarrelComponent(int index)`

### Parameters
- **index** (Int32) - The index of the barrel component subset of all the weapon component array.

### Returns
- **WeaponComponent** - A WeaponComponent instance if found; otherwise, the instance representing the invalid component.
```

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

### CreateVehicle

Source: https://docs.ragecoop.com/API/RageCoop.Server.Scripting.ServerEntities.html

Creates a vehicle on the server.

```APIDOC
## CreateVehicle(Client, Model, Vector3, Single)

### Description
Creates a vehicle on the server.

### Parameters
- **owner** (Client) - Owner of this vehicle.
- **model** (Model) - The model of the vehicle.
- **pos** (Vector3) - Position of the vehicle.
- **heading** (Single) - Heading of the vehicle.

### Returns
- **ServerVehicle** - The created vehicle instance.
```

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

### ArmStiffnessStart Property

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.StaggerFallHelper.html

Sets the arm stiffness during the initial yanked timescale.

```csharp
public float ArmStiffnessStart { set; }
```

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

### TrimColor Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Gets or sets the trim color of the vehicle.

```csharp
public VehicleColor TrimColor { get; set; }
```

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

### TireSmokeColor Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Gets or sets the color of the tire smoke.

```csharp
public Color TireSmokeColor { get; set; }
```

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

### SecondaryColor Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Gets or sets the secondary color of the vehicle.

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

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

### AnimatedBuilding Method Declarations

Source: https://docs.ragecoop.com/SHVDN/GTA.AnimatedBuilding.html

Methods for managing and comparing animated building instances.

```csharp
public override bool Equals(object obj)
```

```csharp
public bool Exists()
```

```csharp
public static AnimatedBuilding FromHandle(int handle)
```

```csharp
public override int GetHashCode()
```

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

### RimColor Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Gets or sets the rim color of the vehicle.

```csharp
public VehicleColor RimColor { get; set; }
```

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

### ConfigureBulletsHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureBulletsHelper.html

Initializes a new instance of the helper for a specific ped.

```csharp
public ConfigureBulletsHelper(Ped ped)
```

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

### Configure RdsStartingFriction

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.SmartFallHelper.html

Sets the starting friction for Catch Fall/RDS, which may be overwritten by the falling reaction.

```csharp
public float RdsStartingFriction { set; }
```

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

### PrimaryColor Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Gets or sets the primary color of the vehicle.

```csharp
public VehicleColor PrimaryColor { get; set; }
```

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

### ConfigureBalanceResetHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureBalanceResetHelper.html

Initializes a new instance of the ConfigureBalanceResetHelper for a specific Ped.

```csharp
public ConfigureBalanceResetHelper(Ped ped)
```

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

### PearlescentColor Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Gets or sets the pearlescent color of the vehicle.

```csharp
public VehicleColor PearlescentColor { get; set; }
```

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

### Building.FromHandle(int handle)

Source: https://docs.ragecoop.com/SHVDN/GTA.Building.html

Creates a new instance of a Building from the given handle.

```APIDOC
## static Building FromHandle(int handle)

### Description
Creates a new instance of a Building from the given handle. Returns null if no Building exists with the specified handle.

### Parameters
- **handle** (Int32) - Required - The building handle.

### Returns
- **Building** - The Building instance if found, otherwise null.
```

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

### NeonLightsColor Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Gets or sets the color of the neon lights.

```csharp
public Color NeonLightsColor { get; set; }
```

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

### Livery Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Gets or sets the current livery index.

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

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

### DataDirectory Property

Source: https://docs.ragecoop.com/API/RageCoop.Client.Settings.html

Configures the file system path for logs and downloaded server resources.

```csharp
public string DataDirectory { get; set; }
```

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

### LicensePlateStyle Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Gets or sets the style of the license plate.

```csharp
public LicensePlateStyle LicensePlateStyle { get; set; }
```

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

### HipsLeanTowardsObjectHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.HipsLeanTowardsObjectHelper.html

Initializes a new instance of the helper for a specific ped.

```csharp
public HipsLeanTowardsObjectHelper(Ped ped)
```

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

### DashboardColor Property

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleModCollection.html

Gets or sets the dashboard color of the vehicle.

```csharp
public VehicleColor DashboardColor { get; set; }
```

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

### ConfigureBalanceHelper(Ped)

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureBalanceHelper.html

Initializes a new instance of the ConfigureBalanceHelper for a specific Ped.

```APIDOC
## Constructor: ConfigureBalanceHelper(Ped ped)

### Description
Creates a new instance of the ConfigureBalanceHelper for sending a ConfigureBalance message to a given Ped.

### Parameters
- **ped** (Ped) - Required - The Ped to send the ConfigureBalance message to.
```

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

### IsDucking

Source: https://docs.ragecoop.com/SHVDN/GTA.Ped.html

Gets or sets whether the pedestrian is currently ducking.

```APIDOC
## Property: IsDucking

### Description
Gets or sets whether the pedestrian is currently ducking.

### Declaration
`public bool IsDucking { get; set; }`

### Type
Boolean
```

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

### ConfigureBulletsExtraHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureBulletsExtraHelper.html

Initializes a new instance of the helper for a specific ped.

```csharp
public ConfigureBulletsExtraHelper(Ped ped)
```

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

### Item[VehicleDoorIndex]

Source: https://docs.ragecoop.com/SHVDN/GTA.VehicleDoorCollection.html

Gets the VehicleDoor object at the specified index.

```APIDOC
## Property: Item[VehicleDoorIndex]

### Description
Accesses a specific vehicle door by its index.

### Syntax
`public VehicleDoor this[VehicleDoorIndex index] { get; }`

### Parameters
- **index** (VehicleDoorIndex) - The index of the door to retrieve.

### Returns
- **VehicleDoor** - The door object associated with the provided index.
```

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

### UsePistolIK

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.PointGunHelper.html

Enables or disables new IK for pistol pointing.

```APIDOC
## UsePistolIK

### Description
Enable new IK for pistol pointing. Default value is True.

### Declaration
`public bool UsePistolIK { set; }`
```

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

### Quaternion(Single, Single, Single, Single)

Source: https://docs.ragecoop.com/SHVDN/GTA.Math.Quaternion.html

Initializes a new instance of the Quaternion structure using X, Y, Z, and W components.

```APIDOC
## Constructor: Quaternion(float x, float y, float z, float w)

### Description
Initializes a new instance of the Quaternion structure.

### Parameters
- **x** (float) - The X component of the quaternion.
- **y** (float) - The Y component of the quaternion.
- **z** (float) - The Z component of the quaternion.
- **w** (float) - The W component of the quaternion.
```

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

### WantedLevel

Source: https://docs.ragecoop.com/SHVDN/GTA.Player.html

Gets or sets the current wanted level of the player.

```APIDOC
## Property: WantedLevel

### Description
Gets or sets the wanted level for this Player.

### Declaration
`public int WantedLevel { get; set; }`

### Property Value
- **Type**: Int32
```

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

### ReserveParachuteTint

Source: https://docs.ragecoop.com/SHVDN/GTA.Player.html

Gets or sets the reserve parachute tint for the player.

```APIDOC
## Property: ReserveParachuteTint

### Description
Gets or sets the reserve parachute tint for this Player.

### Declaration
`public ParachuteTint ReserveParachuteTint { get; set; }`

### Property Value
- **Type**: ParachuteTint
```

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

### WelcomeMessage Property

Source: https://docs.ragecoop.com/API/RageCoop.Server.ServerSettings.html

Sets the message sent to a client upon successful connection.

```csharp
public string WelcomeMessage { get; set; }
```

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

### Rotation Property

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.CustomSprite.html

Gets or sets the rotation of the CustomSprite in degrees.

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

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

### Pickup Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.Pickup.html

Initializes a new instance of the Pickup class using a native handle.

```csharp
public Pickup(int handle)
```

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

### Configure Initial Spine Stiffness

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.StaggerFallHelper.html

Sets the spine stiffness during the yanked timescale.

```csharp
public float SpineStiffnessStart { set; }
```

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

### Enabled Property

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.CustomSprite.html

Gets or sets whether the CustomSprite will be drawn.

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

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

### LeanInDirectionHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.LeanInDirectionHelper.html

Initializes a new instance of the helper for a specific ped.

```csharp
public LeanInDirectionHelper(Ped ped)
```

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

### Rope Length Property

Source: https://docs.ragecoop.com/SHVDN/GTA.Rope.html

Gets or sets the length of the rope.

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

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

### CursorSprite Property

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.Hud.html

Gets or sets the sprite used for the cursor.

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

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

### GrabHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.GrabHelper.html

Initializes a new instance of the GrabHelper for a specific ped.

```csharp
public GrabHelper(Ped ped)
```

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

### ConfigureConstraintsHelper(Ped)

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ConfigureConstraintsHelper.html

Constructor to initialize a new instance of the ConfigureConstraintsHelper for a specific Ped.

```APIDOC
## Constructor: ConfigureConstraintsHelper(Ped)

### Description
Creates a new instance of the ConfigureConstraintsHelper for sending a ConfigureConstraints message to a given Ped.

### Parameters
- **ped** (Ped) - The Ped to send the ConfigureConstraints message to.
```

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

### Get Enumerator

Source: https://docs.ragecoop.com/SHVDN/GTA.Style.html

Returns an enumerator for iterating over ped variations.

```csharp
public IEnumerator<IPedVariation> GetEnumerator()
```

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

### Create Pickup

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Spawns a pickup item at a specified position with optional rotation.

```csharp
public static Pickup CreatePickup(PickupType type, Vector3 position, Vector3 rotation, Model model, int value)
```

```csharp
public static Pickup CreatePickup(PickupType type, Vector3 position, Model model, int value)
```

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

### PedBoneCollection.Enumerator Current Property

Source: https://docs.ragecoop.com/SHVDN/GTA.PedBoneCollection.Enumerator.html

Gets the current PedBone in the iteration.

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

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

### Position

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets or sets the position of this Entity in world space.

```APIDOC
## Property: Position

### Description
Gets or sets the position of this Entity. If the Entity is a Ped inside a Vehicle, the Vehicle's position is returned or modified.

### Declaration
`public virtual Vector3 Position { get; set; }`

### Returns
- **Vector3** - The position in world space.
```

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

### ShotFromBehindHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ShotFromBehindHelper.html

Initializes a new instance of the helper for a specific Ped.

```csharp
public ShotFromBehindHelper(Ped ped)
```

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

### TransitionToWeather(Weather, Single)

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Transitions the game world weather to a new state over a specified duration.

```APIDOC
## TransitionToWeather(Weather, Single)

### Description
Transitions to weather.

### Declaration
`public static void TransitionToWeather(Weather weather, float duration)`

### Parameters
- **weather** (Weather) - The weather.
- **duration** (Single) - The duration.
```

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

### MaxHealth

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets or sets the maximum health of this Entity as an Int32.

```APIDOC
## Property: MaxHealth

### Description
Gets or sets the maximum health of this Entity as an Int32. Use MaxHealthFloat for precise values.

### Declaration
`public virtual int MaxHealth { get; set; }`

### Returns
- **Int32** - The maximum health as an Int32.
```

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

### ShotHeadLookHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ShotHeadLookHelper.html

Initializes a new instance of the helper for a specific Ped.

```csharp
public ShotHeadLookHelper(Ped ped)
```

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

### LodDistance

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets or sets the level of detail distance of this Entity.

```APIDOC
## Property: LodDistance

### Description
Gets or sets the level of detail distance of this Entity.

### Declaration
`public int LodDistance { get; set; }`
```

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

### MainWindow Constructor

Source: https://docs.ragecoop.com/API/RageCoop.Client.Installer.MainWindow.html

The default constructor for the MainWindow class.

```csharp
public MainWindow()
```

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

### IsUpsideDown

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets a value indicating whether this Entity is upside down.

```APIDOC
## Property: IsUpsideDown

### Description
Gets a value indicating whether this Entity is upside down.

### Declaration
`public bool IsUpsideDown { get; }`

### Returns
- **Boolean** - true if this Entity is upside down; otherwise, false.
```

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

### IsUpright

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets a value indicating whether this Entity is upright.

```APIDOC
## Property: IsUpright

### Description
Gets a value indicating whether this Entity is upright.

### Declaration
`public bool IsUpright { get; }`

### Returns
- **Boolean** - true if this Entity is upright; otherwise, false.
```

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

### Initialize CustomSprite constructors

Source: https://docs.ragecoop.com/SHVDN/GTA.UI.CustomSprite.html

Various constructors for initializing a CustomSprite with different parameters such as file path, size, position, color, rotation, and centering.

```csharp
public CustomSprite(string filename, SizeF size, PointF position)
```

```csharp
public CustomSprite(string filename, SizeF size, PointF position, Color color)
```

```csharp
public CustomSprite(string filename, SizeF size, PointF position, Color color, float rotation)
```

```csharp
public CustomSprite(string filename, SizeF size, PointF position, Color color, float rotation, bool centered)
```

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

### Initialize ForceLeanTowardsObjectHelper

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.ForceLeanTowardsObjectHelper.html

Constructor for creating a new instance of the helper for a specific Ped.

```csharp
public ForceLeanTowardsObjectHelper(Ped ped)
```

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

### IsRendered

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets a value indicating whether this Entity is rendered.

```APIDOC
## Property: IsRendered

### Description
Gets a value indicating whether this Entity is rendered.

### Declaration
`public bool IsRendered { get; }`

### Returns
- **Boolean** - true if this Entity is rendered; otherwise, false.
```

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

### CreateBlip

Source: https://docs.ragecoop.com/API/RageCoop.Server.Scripting.ServerEntities.html

Creates a static ServerBlip owned by the server.

```APIDOC
## CreateBlip(Vector3, Int32)

### Description
Creates a static ServerBlip owned by the server.

### Parameters
- **pos** (Vector3) - Position of the blip.
- **rotation** (Int32) - Rotation of the blip.

### Returns
- **ServerBlip** - The created blip instance.
```

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

### IsOnScreen

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets a value indicating whether this Entity is on screen.

```APIDOC
## Property: IsOnScreen

### Description
Gets a value indicating whether this Entity is on screen.

### Declaration
`public bool IsOnScreen { get; }`

### Returns
- **Boolean** - true if this Entity is on screen; otherwise, false.
```

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

### IsOnFire

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets a value indicating whether this Entity is on fire.

```APIDOC
## Property: IsOnFire

### Description
Gets a value indicating whether this Entity is on fire.

### Declaration
`public bool IsOnFire { get; }`

### Returns
- **Boolean** - true if this Entity is on fire; otherwise, false.
```

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

### IncomingTransformsHelper(Ped)

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.IncomingTransformsHelper.html

Constructor to initialize a new instance of the IncomingTransformsHelper for a specific Ped.

```APIDOC
## Constructor: IncomingTransformsHelper(Ped ped)

### Description
Creates a new instance of the IncomingTransformsHelper for sending an IncomingTransforms message to a given Ped.

### Parameters
- **ped** (Ped) - Required - The Ped to send the IncomingTransforms message to.
```

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

### IsMeleeProof

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets or sets whether the entity is melee proof.

```APIDOC
## Property: IsMeleeProof

### Description
Gets or sets a value indicating whether this Entity is melee proof. Peds are not susceptible to the reactions of melee attacks when this property is set to true.

### Declaration
`public bool IsMeleeProof { get; set; }`

### Return Type
Boolean
```

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

### DrawSpotLight Method

Source: https://docs.ragecoop.com/SHVDN/GTA.World.html

Renders a spotlight at a position pointing in a specific direction.

```csharp
public static void DrawSpotLight(Vector3 pos, Vector3 dir, Color color, float distance, float brightness, float roundness, float radius, float fadeout)
```

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

### Description Property

Source: https://docs.ragecoop.com/API/RageCoop.Server.ServerSettings.html

Sets the server description displayed on the master server.

```csharp
public string Description { get; set; }
```

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

### IsFireProof

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets or sets whether the entity is fire proof.

```APIDOC
## Property: IsFireProof

### Description
Gets or sets a value indicating whether this Entity is fire proof. This Entity does not catch fire naturally and Peds do not getting ragdolled for being burned when this property is set to true.

### Declaration
`public bool IsFireProof { get; set; }`

### Return Type
Boolean
```

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

### HipsLeanToPositionHelper Constructor

Source: https://docs.ragecoop.com/SHVDN/GTA.NaturalMotion.HipsLeanToPositionHelper.html

Initializes a new instance of the helper for a specific ped.

```csharp
public HipsLeanToPositionHelper(Ped ped)
```

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

### IsExplosionProof

Source: https://docs.ragecoop.com/SHVDN/GTA.Entity.html

Gets or sets whether the entity is explosion proof.

```APIDOC
## Property: IsExplosionProof

### Description
Gets or sets a value indicating whether this Entity is explosion proof. Explosions cannot add force to this Entity and Peds do not getting ragdolled with explosions when this property is set to true.

### Declaration
`public bool IsExplosionProof { get; set; }`

### Return Type
Boolean
```

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

### CreateVehicle Method

Source: https://docs.ragecoop.com/API/RageCoop.Server.Scripting.ServerEntities.html

Creates a vehicle assigned to a specific client owner.

```csharp
public ServerVehicle CreateVehicle(Client owner, Model model, Vector3 pos, float heading)
```
Tokens:
Raw