tweak(natives): fix c# examples throughout the repo (#1180)

ENTITY/FreezeEntityPosition.md

@@ -41,11 +41,11 @@ using static CitizenFX.Core.Native.API;
 // Freeze the local player.
 
 // Retrieve the player ped
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Freeze the ped
 FreezeEntityPosition(playerPed, true);
 
 // or the preferred use of C# wrapper
 Game.PlayerPed.IsPositionFrozen = true;
-```
+```

ENTITY/SetPickUpByCargobobDisabled.md

@@ -63,10 +63,10 @@ SetPickUpByCargobobDisabled(vehicle, true);
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped.
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the player's vehicle.
-Vehicle vehicle = GetVehiclePedIsIn(playerPed, false);
+int vehicle = GetVehiclePedIsIn(playerPed, false);
 
 // Check if the vehicle exists in the game world.
 if (!DoesEntityExist(vehicle)) {
@@ -76,4 +76,4 @@ if (!DoesEntityExist(vehicle)) {
 
 // Prevent the vehicle from being picked up by Cargobobs.
 SetPickUpByCargobobDisabled(vehicle, true);
-```
+```

MISC/GetDistanceBetweenCoords.md

@@ -43,6 +43,6 @@ float dist = GetDistanceBetweenCoords(0f, 0f, 0f, 5f, 5f, 5f, true)
 Vector3 firstVec = new Vector3(0f, 0f, 0f);
 Vector3 secondVec = new Vector3(5f, 5f, 5f);
 
-float dist = firstVec.DistanceToSquared(secondVec); -- Use Z
-float dist = firstVec.DistanceToSquared2D(secondVec); -- Do not use Z
-```
+float dist = firstVec.DistanceToSquared(secondVec); // Use Z
+float dist = firstVec.DistanceToSquared2D(secondVec); // Do not use Z
+```

PED/GetVehiclePedIsIn.md

@@ -61,10 +61,10 @@ console.log(`Vehicle ID: ${vehicle}`);
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the vehicle the player is currently in.
-Vehicle vehicle = GetVehiclePedIsIn(playerPed, false);
+int vehicle = GetVehiclePedIsIn(playerPed, false);
 
 // Check if the vehicle exists in the game world.
 if (!DoesEntityExist(vehicle)) {

PED/SetPedPhonePaletteIdx.md

@@ -68,7 +68,7 @@ const playerPed = PlayerPedId();
 SetPedPhonePaletteIdx(playerPed, PhoneColors.Green);
 ```
 
-```csharp
+```cs
 using static CitizenFX.Core.Native.API;
 
 // Define an enum with color names and their corresponding indices
@@ -84,8 +84,8 @@ public enum PhoneColors
 }
 
 // Retrieve the current player ped
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Set the phone color of the player's ped to Green using the enum value
 SetPedPhonePaletteIdx(playerPed, (int)PhoneColors.Green);
-```
+```

VEHICLE/ArePlaneControlPanelsIntact.md

@@ -39,7 +39,7 @@ else
 end
 ```
 
-```javascript
+```js
 // Retrieve the player ped
 const playerPed = PlayerPedId();
 
@@ -59,14 +59,14 @@ if (controlPanelsIntact) {
 }
 ```
 
-```csharp
+```cs
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the plane the player is currently flying
-Vehicle plane = GetVehiclePedIsIn(playerPed, false);
+int plane = GetVehiclePedIsIn(playerPed, false);
 
 // If the player is not flying a plane, return
 if (plane == 0 || !IsThisModelAPlane(GetEntityModel(plane))) return;

VEHICLE/CanCargobobPickUpEntity.md

@@ -89,16 +89,16 @@ if (CanCargobobPickUpEntity(vehicle, entityID)) {
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped.
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the player's vehicle (cargobob).
-Vehicle cargobob = GetVehiclePedIsIn(playerPed, false);
+int cargobob = GetVehiclePedIsIn(playerPed, false);
 
 // Retrieve the model hash of the cargobob.
 uint model = GetEntityModel(cargobob);
 
 // Check if the vehicle exists and if it's a Cargobob. If not, terminate the script.
-if (!DoesEntityExist(cargobob) || (uint)GetHashKey("cargobob") != model) {
+if (!DoesEntityExist(cargobob) || model != (uint)GetHashKey("cargobob")) {
     return;
 }
 
@@ -115,4 +115,4 @@ if (CanCargobobPickUpEntity(vehicle, entityID)) {
 } else {
     Debug.WriteLine("Cargobob can't pick up the specified entity");
 }
-```
+```

VEHICLE/ClearNitrous.md

@@ -36,7 +36,7 @@ if IsNitrousActive(vehicle) then
 end
 ```
 
-```javascript
+```js
 // Retrieve the player ped.
 const playerPed = PlayerPedId();
 
@@ -53,7 +53,7 @@ if (IsNitrousActive(vehicle)) {
 }
 ```
 
-```csharp
+```cs
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped
@@ -70,4 +70,4 @@ if (IsNitrousActive(vehicle)) {
     // If nitrous is active, clear the nitrous boost from the vehicle.
     ClearNitrous(vehicle);
 }
-```
+```

VEHICLE/DetachEntityFromCargobob.md

@@ -77,10 +77,10 @@ using static CitizenFX.Core.Native.API;
 // This example detaches a specific entity from a Cargobob.
 
 // Retrieve the player ped.
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the player's vehicle.
-Vehicle cargobob = GetVehiclePedIsIn(playerPed, false);
+int cargobob = GetVehiclePedIsIn(playerPed, false);
 
 // Retrieve the model hash of the cargobob.
 uint cargobobModel = (uint)GetEntityModel(cargobob);

VEHICLE/GetBoatVehicleModelAgility.md

@@ -75,10 +75,10 @@ console.log(`Boat Agility: ${agility}`);
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped.
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the vehicle the player is currently in.
-Vehicle vehicle = GetVehiclePedIsIn(playerPed, false);
+int vehicle = GetVehiclePedIsIn(playerPed, false);
 
 // Retrieve the model hash of the boat.
 uint boatHash = GetEntityModel(vehicle);
@@ -89,8 +89,8 @@ if (!DoesEntityExist(vehicle) || !IsThisModelABoat(boatHash)) {
 }
 
 // Retrieve the agility of the boat.
-const float agility = GetBoatVehicleModelAgility(boatHash);
+float agility = GetBoatVehicleModelAgility(boatHash);
 
 // Print the agility of the boat.
 Debug.WriteLine($"Boat Agility: {agility}");
-```
+```

VEHICLE/GetIsBoatCapsized.md

@@ -87,10 +87,10 @@ if (GetIsBoatCapsized(vehicle)) {
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the LocalPlayer.
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the vehicle the player is in
-Vehicle vehicle = GetVehiclePedIsIn(playerPed, false);
+int vehicle = GetVehiclePedIsIn(playerPed, false);
 
 // Retrieve the model of the vehicle
 uint vehicleModel = (uint)GetEntityModel(vehicle);

VEHICLE/GetMakeNameFromVehicleModel.md

@@ -75,10 +75,10 @@ console.log(`Vehicle Manufacturer: ${manufacturer}`);
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped.
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the vehicle the player is currently in.
-Vehicle vehicle = GetVehiclePedIsIn(playerPed, false);
+int vehicle = GetVehiclePedIsIn(playerPed, false);
 
 // If the vehicle does not exist, end the execution of the code here.
 if (!DoesEntityExist(vehicle)) {
@@ -93,4 +93,4 @@ string manufacturer = GetMakeNameFromVehicleModel(vehicleHash);
 
 // Print the manufacturer of the vehicle.
 Debug.WriteLine($"Vehicle Manufacturer: {manufacturer}");
-```
+```

VEHICLE/GetVehicleAcceleration.md

@@ -67,19 +67,19 @@ console.log(`Vehicle Acceleration: ${acceleration}`);
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped.
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the vehicle the player is currently in.
-Vehicle vehicle = GetVehiclePedIsIn(playerPed, false);
+int vehicle = GetVehiclePedIsIn(playerPed, false);
 
 // If the vehicle does not exist, end the execution of the code here.
 if (!DoesEntityExist(vehicle)) {
   return;
 }
 
 // Retrieve the acceleration of the vehicle.
-const float acceleration = GetVehicleAcceleration(vehicle);
+float acceleration = GetVehicleAcceleration(vehicle);
 
 // Print the acceleration of the vehicle.
 Debug.WriteLine($"Vehicle Acceleration: {acceleration}");
-```
+```

VEHICLE/GetVehicleEstimatedMaxSpeed.md

@@ -68,19 +68,19 @@ console.log(`Estimated Max Speed: ${estimatedMaxSpeed}`);
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped.
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the vehicle the player is currently in.
-Vehicle vehicle = GetVehiclePedIsIn(playerPed, false);
+int vehicle = GetVehiclePedIsIn(playerPed, false);
 
 // If the vehicle does not exist, end the execution of the code here.
 if (!DoesEntityExist(vehicle)) {
   return;
 }
 
 // Retrieve the estimated max speed of the vehicle.
-const float estimatedMaxSpeed = GetVehicleEstimatedMaxSpeed(vehicle);
+float estimatedMaxSpeed = GetVehicleEstimatedMaxSpeed(vehicle);
 
 // Print the estimated max speed of the vehicle.
 Debug.WriteLine($"Estimated Max Speed: {estimatedMaxSpeed}");
-```
+```

VEHICLE/SetCargobobExcludeFromPickupEntity.md

@@ -80,10 +80,10 @@ SetCargobobExcludeFromPickupEntity(cargobob, entityID);
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the player's vehicle (cargobob)
-Vehicle cargobob = GetVehiclePedIsIn(playerPed, false);
+int cargobob = GetVehiclePedIsIn(playerPed, false);
 
 // Retrieve the model hash of the cargobob.
 uint cargobobModel = GetEntityModel(cargobob);
@@ -103,4 +103,4 @@ if (!DoesEntityExist(entityID)) {
 
 // Prevent the entity from being detached from the Cargobob.
 SetCargobobExcludeFromPickupEntity(cargobob, entityID);
-```
+```

VEHICLE/SetDisableBmxExtraTrickForces.md

@@ -33,7 +33,7 @@ if not IsThisModelABicycle(GetEntityModel(bmx)) then return end
 SetDisableBmxExtraTrickForces(bmx, true)
 ```
 
-```javascript
+```js
 // Retrieve the player ped
 const playerPed = PlayerPedId();
 
@@ -47,18 +47,18 @@ if (!IsThisModelABicycle(GetEntityModel(bmx))) return;
 SetDisableBmxExtraTrickForces(bmx, true);
 ```
 
-```csharp
+```cs
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the BMX bike the player is currently riding
-Vehicle bmx = GetVehiclePedIsIn(playerPed, false);
+int bmx = GetVehiclePedIsIn(playerPed, false);
 
 // If the player is not riding a BMX bike, return
 if (!IsThisModelABicycle(GetEntityModel(bmx))) return;
 
 // Disable the extra forces applied to BMX bikes for tricks
 SetDisableBmxExtraTrickForces(bmx, true);
-```
+```

VEHICLE/SetDisableExplodeFromBodyDamageOnCollision.md

@@ -33,7 +33,7 @@ local vehicle = GetVehiclePedIsIn(playerPed, false)
 SetDisableExplodeFromBodyDamageOnCollision(vehicle, true)
 ```
 
-```javascript
+```js
 // Retrieve the player ped
 const playerPed = PlayerPedId();
 
@@ -44,14 +44,14 @@ const vehicle = GetVehiclePedIsIn(playerPed, false);
 SetDisableExplodeFromBodyDamageOnCollision(vehicle, true);
 ```
 
-```csharp
+```cs
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the vehicle the player is currently in
-Vehicle vehicle = GetVehiclePedIsIn(playerPed, false);
+int vehicle = GetVehiclePedIsIn(playerPed, false);
 
 // Disable explosion from body damage on collision for the vehicle
 SetDisableExplodeFromBodyDamageOnCollision(vehicle, true);

VEHICLE/SetOpenRearDoorsOnExplosion.md

@@ -80,11 +80,11 @@ if (modelVehicle === hashStockade) {
 using static CitizenFX.Core.Native.API;
 // This example disables the rear doors of the vehicle from opening upon explosion.
 
-// Retrieve the LocalPlayer.
-Ped playerPed = PlayerPedId();
+// Retrieve the local ped.
+int playerPed = PlayerPedId();
 
 // Retrieve the vehicle the player is currently in.
-Vehicle vehicle = GetVehiclePedIsIn(playerPed, false);
+int vehicle = GetVehiclePedIsIn(playerPed, false);
 
 // Check if the vehicle exists in the game world.
 if (!DoesEntityExist(vehicle))

VEHICLE/SetTransformRateForAnimation.md

@@ -65,10 +65,10 @@ SetTransformRateForAnimation(vehicle, 2.5);
 using static CitizenFX.Core.Native.API;
 
 // Retrieve the player ped
-Ped playerPed = PlayerPedId();
+int playerPed = PlayerPedId();
 
 // Retrieve the vehicle in which the player is currently seated
-Vehicle vehicle = GetVehiclePedIsIn(playerPed, false); // Get the vehicle in which the player is currently seated
+int vehicle = GetVehiclePedIsIn(playerPed, false); // Get the vehicle in which the player is currently seated
 
 // Retrieve the vehicle model hash
 uint vehicleHash = (uint)GetEntityModel(vehicle);
@@ -82,4 +82,4 @@ if (!DoesEntityExist(vehicle) || vehicleHash != (uint)GetHashKey("stromberg"))
 
 // Set the transform rate for the submarine car conversion animations to 2.5
 SetTransformRateForAnimation(vehicle, 2.5f);
-```
+```