diff --git a/docs/ServerAPI/csharp/Player.md b/docs/ServerAPI/csharp/Player.md index b39378f..9de769b 100644 --- a/docs/ServerAPI/csharp/Player.md +++ b/docs/ServerAPI/csharp/Player.md @@ -2,33 +2,46 @@ ### Properties -| Property Name | Type | Description | -| ------------- | ------------ | ----------- | -| Vehicle | `IVehicle` | | -| AimPosition | `Position` | | -| Ammo | `ushort` | | -| Armor | `ushort` | | -| HeadRotation | `Rotation` | | -| Health | `ushort` | | -| IsAiming | `bool` | | -| IsConnected | `bool` | | -| IsDead | `bool` | | -| IsInRagdoll | `bool` | | -| IsInVehicle | `bool` | | -| IsJumping | `bool` | | -| IsReloading | `bool` | | -| IsShooting | `bool` | | -| MoveSpeed | `float` | | -| Name | `string` | | -| Seat | `byte` | | -| Weapon | `uint` | | -| Type | `EntityType` | | -| Dimension | `ushort` | | -| Exists | `bool` | | -| Id | `ushort` | | -| NativePointer | `IntPtr` | | -| Position | `Position` | | -| Rotation | `Rotation` | | +| Property Name | Type | Access | Description | +| ------------- | ------------ | ----------- | ----------- | +| Name | `string` | get | | +| Model | `uint` | get, set | | +| Health | `ushort` | get, set | | +| MaxHealth | `ushort` | get, set | | +| Armor | `ushort` | get, set | | +| MaxArmor | `ushort` | get, set | | +| IsDead | `bool` | get | | +| SocialClubId | `ulong` | get | | +| HardwareIdHash | `ulong` | get | | +| HardwareIdExHash | `ulong` | get | | +| AuthToken | `string` | get | | +| IsConnected | `bool` | get | | +| Ping | `uint` | get | | +| Ip | `string` | get | | +| IsInVehicle | `bool` | get | | +| Vehicle | `IVehicle` | get | | +| Seat | `byte` | get | | +| AimPosition | `Position` | get | | +| Weapon | `uint` | get | | +| CurrentWeapon | `uint` | get, set | | +| Ammo | `ushort` | get | | +| IsAiming | `bool` | get | | +| EntityAimingAt | `IEntity` | get | | +| EntityAimOffset | `Position` | get | | +| IsInRagdoll | `bool` | get | | +| IsReloading | `bool` | get | | +| IsShooting | `bool` | get | | +| MoveSpeed | `float` | get | | +| IsJumping | `bool` | get | | +| IsFlashlightActive | `bool` | get | | +| Type | `EntityType` | | | +| Dimension | `short` | | | +| Exists | `bool` | | | +| Id | `ushort` | | | +| NativePointer | `IntPtr` | | | +| Position | `Position` | | | +| Rotation | `Rotation` | | | +| HeadRotation | `Rotation` | get | | ## Methods @@ -162,6 +175,146 @@ None +### GiveWeapon + +```csharp +void GiveWeapon(uint weapon, int ammo, bool selectWeapon); +``` + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ---------- | ----------- | +| weapon | `uint` | | +| ammo | `int` | | +| selectWeapon | `bool` | | + +#### Return + +None + + +### RemoveWeapon + +```csharp +void RemoveWeapon(uint weapon); +``` + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ---------- | ----------- | +| weapon | `uint` | | + +#### Return + +None + + +### RemoveAllWeapons + +```csharp +void RemoveAllWeapons(); +``` + +#### Parameters + +None + +#### Return + +None + + +### AddWeaponComponent + +```csharp +void AddWeaponComponent(uint weapon, uint weaponComponent); +``` + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ---------- | ----------- | +| weapon | `uint` | | +| weaponComponent | `uint` | | + +#### Return + +None + + +### RemoveWeaponComponent + +```csharp +void RemoveWeaponComponent(uint weapon, uint weaponComponent); +``` + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ---------- | ----------- | +| weapon | `uint` | | +| weaponComponent | `uint` | | + +#### Return + +None + + +### GetCurrentWeaponComponents + +```csharp +void GetCurrentWeaponComponents(out uint[] weaponComponents); +``` + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ---------- | ----------- | +| weaponComponents | **out** `uint[]` | | + +#### Return + +None + + +### SetWeaponTintIndex + +```csharp +void SetWeaponTintIndex(uint weapon, byte tintIndex); +``` + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ---------- | ----------- | +| weapon | `uint` | | +| tintIndex | `byte` | | + +#### Return + +None + + +### GetCurrentWeaponTintIndex + +```csharp +byte GetCurrentWeaponTintIndex(); +``` + +#### Parameters + +None + +#### Return + +**Type**: `byte` + +**Description**: + + + ### GetData ```csharp diff --git a/docs/ServerAPI/csharp/Vehicle.md b/docs/ServerAPI/csharp/Vehicle.md index 8f2be57..100b283 100644 --- a/docs/ServerAPI/csharp/Vehicle.md +++ b/docs/ServerAPI/csharp/Vehicle.md @@ -386,3 +386,555 @@ void SetSyncedMetaData(string key, object value) #### Return None + + +### GetDoorState + +```csharp +byte GetDoorState(byte doorId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| doorId | `byte` | | + +#### Return + +**Type**: `byte` + +**Description**: + + +### SetDoorState + +```csharp +void SetDoorState(byte doorId, byte state) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| doorId | `byte` | | +| state | `byte` | | + +#### Return + +None + + +### IsWindowOpened + +```csharp +bool IsWindowOpened(byte windowId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| windowId | `byte` | | + +#### Return + +**Type**: `bool` + +**Description**: + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| doorId | `byte` | | +| state | `byte` | | + +#### Return + +None + + +### SetWindowOpened + +```csharp +void SetWindowOpened(byte windowId, bool state) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| windowId | `byte` | | +| state | `bool` | | + +#### Return + +None + + +### IsWheelBurst + +```csharp +bool IsWheelBurst(byte wheelId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| wheelId | `byte` | | + +#### Return + +**Type**: `bool` + +**Description**: + + +### SetWheelBurst + +```csharp +void SetWheelBurst(byte wheelId, bool state) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| wheelId | `byte` | | +| state | `bool` | | + +#### Return + +None + + +### DoesWheelHasTire + +```csharp +bool DoesWheelHasTire(byte wheelId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| wheelId | `byte` | | + +#### Return + +**Type**: `bool` + +**Description**: + + + +### SetWheelHasTire + +```csharp +void SetWheelHasTire(byte wheelId, bool state) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| wheelId | `byte` | | +| state | `bool` | | + +#### Return + +None + + +### GetWheelHealth + +```csharp +float GetWheelHealth(byte wheelId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| wheelId | `byte` | | + +#### Return + +**Type**: `float` + +**Description**: + + +### SetWheelHealth + +```csharp +void SetWheelHealth(byte wheelId, float health) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| wheelId | `byte` | | +| health | `float` | | + +#### Return + +None + + +### GetPartDamageLevel + +```csharp +byte GetPartDamageLevel(byte partId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| partId | `byte` | | + +#### Return + +**Type**: `byte` + +**Description**: + + +### SetPartDamageLevel + +```csharp +void SetPartDamageLevel(byte partId, byte damage) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| partId | `byte` | | +| damage | `byte` | | + +#### Return + +None + + +### GetPartBulletHoles + +```csharp +byte GetPartBulletHoles(byte partId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| partId | `byte` | | + +#### Return + +**Type**: `byte` + +**Description**: + + +### SetPartBulletHoles + +```csharp +void SetPartBulletHoles(byte partId, byte shootsCount) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| partId | `byte` | | +| shootsCount | `byte` | | + +#### Return + +None + + +### IsLightDamaged + +```csharp +bool IsLightDamaged(byte lightId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| lightId | `byte` | | + +#### Return + +**Type**: `bool` + +**Description**: + + + +### SetLightDamaged + +```csharp +void SetLightDamaged(byte lightId, bool isDamaged) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| lightId | `byte` | | +| isDamaged | `bool` | | + +#### Return + +None + + + +### IsWindowDamaged + +```csharp +bool IsWindowDamaged(byte windowId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| windowId | `byte` | | + +#### Return + +**Type**: `bool` + +**Description**: + + + +### SetWindowDamaged + +```csharp +void SetWindowDamaged(byte windowId, bool isDamaged) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| windowId | `byte` | | +| isDamaged | `bool` | | + +#### Return + +None + + +### IsSpecialLightDamaged + +```csharp +bool IsSpecialLightDamaged(byte specialLightId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| specialLightId | `byte` | | + +#### Return + +**Type**: `bool` + +**Description**: + + +### SetSpecialLightDamaged + +```csharp +void SetSpecialLightDamaged(byte specialLightId, bool isDamaged) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| specialLightId | `byte` | | +| isDamaged | `bool` | | + +#### Return + +None + + +### GetArmoredWindowHealth + +```csharp +float GetArmoredWindowHealth(byte windowId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| windowId | `byte` | | + +#### Return + +**Type**: `float` + +**Description**: + + +### SetArmoredWindowHealth + +```csharp +void SetArmoredWindowHealth(byte windowId, float health) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| windowId | `byte` | | +| health | `float` | | + +#### Return + +None + + +### GetArmoredWindowShootCount + +```csharp +byte GetArmoredWindowShootCount(byte windowId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| windowId | `byte` | | + +#### Return + +**Type**: `byte` + +**Description**: + + +### SetArmoredWindowShootCount + +```csharp +void SetArmoredWindowShootCount(byte windowId, byte count) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| windowId | `byte` | | +| count | `byte` | | + +#### Return + +None + + + + +### GetBumperDamageLevel + +```csharp +byte GetBumperDamageLevel(byte bumperId) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| bumperId | `byte` | | + +#### Return + +**Type**: `byte` + +**Description**: + + +### SetBumperDamageLevel + +```csharp +void SetBumperDamageLevel(byte bumperId, byte damageLevel) +``` + + + +#### Parameters + +| Parameter Name | Type | Description | +| -------------- | ----------- | ----------- | +| bumperId | `byte` | | +| damageLevel | `byte` | | + +#### Return + +None