From 1b162d3c67dcbefa50571f586a05e38ca5e71fcc Mon Sep 17 00:00:00 2001 From: Vince0789 Date: Thu, 28 Nov 2024 17:59:24 +0100 Subject: [PATCH] PutPlayerInVehicle, updated example and warnings --- .../scripting/functions/PutPlayerInVehicle.md | 42 +++++++++++++++++-- 1 file changed, 38 insertions(+), 4 deletions(-) diff --git a/docs/scripting/functions/PutPlayerInVehicle.md b/docs/scripting/functions/PutPlayerInVehicle.md index b9c686630..5f182c53a 100644 --- a/docs/scripting/functions/PutPlayerInVehicle.md +++ b/docs/scripting/functions/PutPlayerInVehicle.md @@ -18,16 +18,48 @@ Puts a player in a vehicle. **true** - The function was executed successfully. -**false** - The function failed to execute. The player or vehicle don't exist. +**false** - The function failed to execute. The player or vehicle doesn't exist. ## Examples ```c -public OnPlayerEnterVehicle(playerid, vehicleid, ispassanger) +// Global array to track which vehicle belongs to each player. +// INVALID_VEHICLE_ID is used as a placeholder for players without a vehicle. +static s_PlayerVehicle[MAX_PLAYERS] = { INVALID_VEHICLE_ID, ... }; + +public OnPlayerSpawn(playerid) { - PutPlayerInVehicle(playerid, vehicleid, 0); + // Check if the player already has a valid vehicle. + if (!IsValidVehicle(s_PlayerVehicle[playerid])) + { + // If not, create a new vehicle for the player and store its ID. + s_PlayerVehicle[playerid] = CreateVehicle(411, 0.0, 0.0, 3.5, 0.0, -1, -1, -1); + } + + // Mark that the player should be placed in their vehicle once it is fully loaded. + // This avoids issues where the vehicle might not yet be loaded on the client's side. + SetPVarInt(playerid, "PutPlayerInVehicle", 1); + return 1; } + +public OnVehicleStreamIn(vehicleid, forplayerid) +{ + // This callback is triggered when a vehicle streams in for the player (i.e. when it is loaded into memory). + // Check if the streamed-in vehicle is the player's and if they need to be placed in it. + if (vehicleid == s_PlayerVehicle[forplayerid] && GetPVarInt(forplayerid, "PutPlayerInVehicle")) + { + // Put the player into the vehicle. + PutPlayerInVehicle(forplayerid, vehicleid, 0); + + // Clear the marker to prevent repeatedly putting the player into the vehicle + // (e.g., if the player leaves the vehicle and it streams in again later). + DeletePVar(forplayerid, "PutPlayerInVehicle"); + } + + return 1; +} + ``` | ID | Seat | @@ -48,7 +80,9 @@ You can use [GetPlayerVehicleSeat](GetPlayerVehicleSeat) in a loop to check if a :::warning -If the seat is invalid or is taken, will cause a crash when they EXIT the vehicle. +* If the seat is invalid or already taken, the client will crash when they EXIT the vehicle. +* Putting a player into a vehicle that is not streamed in can be unreliable. This is due to a potential client-side issue where the vehicle may not have fully loaded into memory yet. +* This also applies when attempting to put a player into a vehicle that was just created. :::